TRX/README.md

# 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 project is inspired by Arsunt's
[TR2Main](https://github.com/Arsunt/TR2Main/) project.

## Installing

Get a copy of the latest release from
[here](https://github.com/rr-/TR1Main/releases) and unpack the contents to your
game directory. Make sure you overwrite existing files.

## Configuring

To configure TR1Main, edit the `TR1Main.json` file 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).
- `disable_healing_between_levels`: disables healing Lara between level reloads
  (for No Heal challenge runs).
- `enable_red_healthbar`: replaces the default golden healthbar with a red one.
- `enable_enemy_healthbar`: enables showing healthbar for the active enemy.
- `fix_end_of_level_freeze`: fix game freeze when ending the level with the
  Action key held.

## Building

- i686-w64-mingw32-gcc - C/C++ compiler
- Vim @ WSL - IDE

To compile the project, run `make build`.  
To compile the project with Docker, run `make docker_build`.

## Decompilation progress

![](docs/progress.svg)

Green squares represent TombATI functions that are fully decompiled and
reimplemented by TR1Main. Light red squares represent functions that still need
to be ported.

## License

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 1996. Lara Croft and Tomb Raider are trademarks of Square
Enix Ltd.