restyle documentation

This commit is contained in:
rr- 2021-02-08 14:24:50 +01:00
parent 20cd49968c
commit e6960067cb
No known key found for this signature in database
GPG key ID: CC65E6FD28CAE42A

View file

@ -1,24 +1,31 @@
# TR1Main
This is a dynamic library for the classic Tomb Raider I game (TombATI version). The purpose of the library is to reimplement all the routines performed by the game and enhance the gameplay with new options.
This is a dynamic library for the classic Tomb Raider I game (TombATI version).
The purpose of the library is to reimplement all the routines performed by the
game and enhance the gameplay with new options.
This project is inspired by Arsunt's [TR2Main](https://github.com/Arsunt/TR2Main/) project.
## Getting Started
For TR1Main to work, you will need a patched `tombati.exe` from [here](https://github.com/rr-/TR1Main/tree/master/bin).
Then you should download TR1Main.dll from [releases](https://github.com/rr-/TR1Main/releases).
Both files should be put in your game folder. Then you can launch the game by running the patched `tombati.exe`.
For TR1Main to work, you will need a patched `tombati.exe` from
[here](https://github.com/rr-/TR1Main/tree/master/bin). Then you should
download TR1Main.dll from [releases](https://github.com/rr-/TR1Main/releases).
Both files should be put in your game folder. Then you can launch the game by
running the patched `tombati.exe`.
## Configuring
TR1Main supports configuration. To configure TR1Main, copy TR1Main.json from this repository to your game folder, then edit the settings.
To configure TR1Main, copy
[TR1Main.json](https://raw.githubusercontent.com/rr-/TR1Main/master/TR1Main.json)
from this repository to your game folder, then edit it in your text editor such
as Notepad.
Currently the following configuration options are supported:
- `disable_medpacks`: hides all the medpacks (for No Meds challenge runs).
- `keep_health_between_levels": disables healing Lara between level reloads (for No Heal challenge runs).
- `keep_health_between_levels`: disables healing Lara between level reloads
(for No Heal challenge runs).
## Building
@ -29,8 +36,11 @@ To compile the project with Docker, just run `./compile`.
## License
This project is licensed under the GNU General Public License - see the COPYING.md file for details
This project is licensed under the GNU General Public License - see the
[COPYING.md](COPYING.md) file for details.
## Copyright
(c) 2020 Marcin Kurczewski. All rights reserved. Original game is created by Core Design Ltd. in 1997. Lara Croft and Tomb Raider are trademarks of Square Enix Ltd.
(c) 2020 Marcin Kurczewski. All rights reserved. Original game is created by
Core Design Ltd. in 1996. Lara Croft and Tomb Raider are trademarks of Square
Enix Ltd.