TRX/README.md

121 lines
4 KiB
Markdown
Raw Normal View History

2021-02-18 16:40:32 +01:00
# Tomb1Main
2021-02-07 23:29:49 +01:00
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-03-17 10:29:29 +01:00
See the [Tomb Raider Forums
topic](https://www.tombraiderforums.com/showthread.php?p=8286101).
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-03-21 18:38:45 +01:00
1. Install the [TombATI v1.7 patch](http://www.glidos.net/tombati.html).
2. Get a copy of the latest Tomb1Main release from
[here](https://github.com/rr-/Tomb1Main/releases).
3. Unpack the contents to your game directory. Make sure you overwrite existing
files (Tomb1Main_config.json5 can be left alone).
2021-02-07 23:29:49 +01:00
2021-02-08 14:22:36 +01:00
## Configuring
To configure Tomb1Main, edit the `Tomb1Main.json5` file in your text editor
such as Notepad. All the configuration is explained in that file.
2021-02-08 14:22:36 +01:00
2021-03-14 15:52:54 +01:00
## Improvements over original game
Not all options are turned on by default. Refer to `Tomb1Main.json5` for details.
- added proper UI scaling
- added enemy health bar
- added more control over when to show health bar and air bar
- added ability to customize of health bar and air bar
- added ability to set user-defined FOV
- added selecting weapons / using items with numeric keys
- added ability to look around while running
- added TR3-like sidesteps
- added shotgun flash sprites
- added a fly cheat
- added a level skip cheat
- added a door open cheat (while in fly mode)
- added ability to disable all medpacks
- added ability to disable Magnums
- added ability to disable UZIs
- added ability to disable shotgun
- added ability to disable main menu demos
- added ability to disable FMVs
- added ability to disable cutscenes
- added ability to disable healing between levels
- added braid (currently only works in Lost Valley)
- added support for more than 3 pickup sprites
- added a choice whether to play NG or NG+
2021-03-17 02:12:10 +01:00
- added Japanese mode (guns deal twice the damage); available for both NG and NG+
2021-03-14 15:52:54 +01:00
- added external game flow (no longer 2 different .exes for TR1 and TR1IB)
For TRLE builders:
- the levels can be reordered
- the levels can be renamed
- all the strings can be translated, including keys and items
- you no longer are constrained to 4 or 21 levels only
- you can offer a custom Gym level
- added automatic calculation of secret numbers
2021-03-17 13:56:05 +01:00
- added compass level stats
- added ability to keep timer on in inventory
2021-03-20 00:10:46 +01:00
- added UI and bar scaling
- added save game crystals game mode (enabled via gameflow)
2021-03-21 18:38:45 +01:00
- added pause screen
2021-03-20 00:10:46 +01:00
- changed internal game memory limit from 3.5 MB to 16 MB
- changed moveable limit from 256 to 10240
2021-03-14 15:52:54 +01:00
- fixed skipping FMVs triggering inventory
- fixed skipping credits working too fast
- fixed setting user keys being very difficult
- fixed keys and items not working when drawing guns immediately after using them
- fixed not being able to close level stats with Escape
2021-03-14 15:52:54 +01:00
- fixed freeze when holding action key during end of level
- fixed reading user settings not restoring the volume
- fixed Tomb of Tihocan playing secret sound
- fixed The Great Pyramid secret
- fixed running out of ammo forcing Lara to equip pistols even if she doesn't carry them
- fixed a crash when Lara is on fire and goes too far away from where she caught fire
- fixed settings not being saved when exiting the game with Alt+F4
- fixed settings not persisting chosen layout (default vs. user keys)
- fixed the sound of collecting a secret killing music
- fixed infamous Tihocan crocodile bug
2021-03-14 15:52:54 +01:00
2021-03-17 02:28:40 +01:00
## Showcase
#### Mode selection
![](docs/showcase1.jpg)
#### Braid
![](docs/showcase2.jpg)
#### Fly cheat
![](docs/showcase3.jpg)
#### Door open cheat
![](docs/showcase4.jpg)
#### Enemy health bars
![](docs/showcase5.jpg)
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.