TRX/README.md

67 lines
2.6 KiB
Markdown
Raw Normal View History

2021-02-07 23:29:49 +01:00
# TR1Main
2021-02-08 14:24:50 +01:00
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.
2021-02-07 23:29:49 +01:00
2021-02-11 16:47:07 +01:00
This project is inspired by Arsunt's
[TR2Main](https://github.com/Arsunt/TR2Main/) project.
2021-02-07 23:29:49 +01:00
2021-02-11 16:47:07 +01:00
## Installing
2021-02-07 23:29:49 +01:00
2021-02-11 16:47:07 +01:00
Get a copy of the latest release from
[here](https://github.com/rr-/TR1Main/releases) and unpack the contents to your
2021-02-18 16:19:46 +01:00
game directory. Make sure you overwrite existing files. Currently TR1Main
requires you to have the TombATI patch installed to work.
2021-02-07 23:29:49 +01:00
2021-02-08 14:22:36 +01:00
## Configuring
2021-02-11 17:13:40 +01:00
To configure TR1Main, edit the `TR1Main.json` file in your text editor such as
Notepad.
2021-02-08 14:22:36 +01:00
Currently the following configuration options are supported:
2021-02-13 19:00:58 +01:00
- `disable_medpacks`: removes all medpacks (for No Meds challenge runs).
- `disable_magnums`: removes all magnum guns and ammo pickups.
- `disable_uzis`: removes all UZI guns and ammo pickups.
- `disable_shotgun`: removes all shotgun and shotgun shells pickups.
2021-02-09 22:20:22 +01:00
- `disable_healing_between_levels`: disables healing Lara between level reloads
2021-02-08 14:24:50 +01:00
(for No Heal challenge runs).
2021-02-10 23:59:11 +01:00
- `enable_red_healthbar`: replaces the default golden healthbar with a red one.
2021-02-11 00:26:17 +01:00
- `enable_enemy_healthbar`: enables showing healthbar for the active enemy.
- `enable_enhanced_look`: allows the player to look while running, jumping
2021-02-13 16:47:38 +01:00
etc. (similar to TR2 style).
2021-02-14 20:20:53 +01:00
- `enable_enhanced_ui`: enables UI scaling of in-game inventory text and ammo
text (useful for 4k screens).
2021-02-13 21:32:42 +01:00
- `enable_numeric_keys`: enables quick weapon draws and medpack usage.
- <kbd>1</kbd>: draw pistols
- <kbd>2</kbd>: draw shotgun
- <kbd>3</kbd>: draw magnums
- <kbd>4</kbd>: draw UZI
- <kbd>8</kbd>: use small medpack
- <kbd>9</kbd>: use large medpack
- `healthbar_showing_mode`: change when the healthbar is displayed. Possible values:
- `always`: always show the healthbar
- `flashing`: show the healthbar only when Lara's health is 20% or below
- `default`: show the healthbar at the beginning of a level, after
getting hit or while having weapons equipped (as in OG)
2021-02-09 22:23:33 +01:00
- `fix_end_of_level_freeze`: fix game freeze when ending the level with the
2021-02-11 00:26:17 +01:00
Action key held.
- `fix_tihocan_secret_sound`: disable the secret sound incorrectly playing
during using the golden key in Tomb of Tihocan.
2021-02-08 14:22:36 +01:00
2021-02-11 00:26:17 +01:00
## Decompilation progress
![](docs/progress.svg)
2021-02-07 23:29:49 +01:00
## License
2021-02-08 14:24:50 +01:00
This project is licensed under the GNU General Public License - see the
[COPYING.md](COPYING.md) file for details.
2021-02-07 23:29:49 +01:00
## Copyright
2021-02-11 18:22:17 +01:00
(c) 2021 Marcin Kurczewski. All rights reserved. Original game is created by
2021-02-08 14:24:50 +01:00
Core Design Ltd. in 1996. Lara Croft and Tomb Raider are trademarks of Square
Enix Ltd.