TRX/docs/tr2/README.md

<p align="center">
<img alt="TR2X logo" src="/data/tr2/logo-light-theme.png#gh-light-mode-only" width="400"/>
<img alt="TR2X logo" src="/data/tr2/logo-dark-theme.png#gh-dark-mode-only" width="400"/>
</p>

TR2X is currently in the early stages of development, focusing on the
decompilation process. We recognize that there is much work to be done.

## Windows

### Installing (manual)

1. Head over to GitHub releases: https://github.com/LostArtefacts/TRX/releases
2. Download the TR2X zip file.
3. Extract the TR2X zip file into a directory of your choice.  
   Make sure you choose to overwrite existing directories and files.
4. (First time installation) Put your original game files into the target directory.
5. To play the game, run `TR2X.exe`.

## Improvements over original game

#### Gameplay

- added an option to fix M16 accuracy while running
- fixed killing the T-Rex with a grenade launcher crashing the game
- fixed secret rewards not displaying shotgun ammo
- fixed numeric keys interfering with the demos
- fixed explosions sometimes being drawn too dark
- fixed controls dialog remapping being too sensitive
- fixed the distorted skybox in room 5 of Barkhang Monastery
- fixed Lara reloading the harpoon gun after every shot in NG+

#### Visuals

- fixed TGA screenshots crashing the game
- fixed the camera being cut off after using the gong hammer in Ice Palace
- fixed Lara's underwater hue being retained when re-entering a boat

#### Audio

- fixed music not playing with certain game versions
- fixed the audio not being in sync when Lara strikes the gong in Ice Palace

#### Mods
- added developer console (accessible with `/`, see [COMMANDS.md](COMMANDS.md) for details)
misc: import tr2 codebase 2024-10-02 09:33:35 +02:00			`<p align="center">`
misc: merge tr2 and libtrx codebases 2024-10-02 10:23:23 +02:00			`<img alt="TR2X logo" src="/data/tr2/logo-light-theme.png#gh-light-mode-only" width="400"/>`
			`<img alt="TR2X logo" src="/data/tr2/logo-dark-theme.png#gh-dark-mode-only" width="400"/>`
misc: import tr2 codebase 2024-10-02 09:33:35 +02:00			`</p>`

			`TR2X is currently in the early stages of development, focusing on the`
			`decompilation process. We recognize that there is much work to be done.`

misc: merge tr2 and libtrx codebases 2024-10-02 10:23:23 +02:00			`## Windows`

			`### Installing (manual)`
misc: import tr2 codebase 2024-10-02 09:33:35 +02:00
misc: merge tr2 and libtrx codebases 2024-10-02 10:23:23 +02:00			`1. Head over to GitHub releases: https://github.com/LostArtefacts/TRX/releases`
			`2. Download the TR2X zip file.`
			`3. Extract the TR2X zip file into a directory of your choice.`
			`Make sure you choose to overwrite existing directories and files.`
			`4. (First time installation) Put your original game files into the target directory.`
			5. To play the game, run `TR2X.exe`.
misc: import tr2 codebase 2024-10-02 09:33:35 +02:00
			`## Improvements over original game`

			`#### Gameplay`

			`- added an option to fix M16 accuracy while running`
			`- fixed killing the T-Rex with a grenade launcher crashing the game`
			`- fixed secret rewards not displaying shotgun ammo`
misc: merge tr2 and libtrx codebases 2024-10-02 10:23:23 +02:00			`- fixed numeric keys interfering with the demos`
			`- fixed explosions sometimes being drawn too dark`
			`- fixed controls dialog remapping being too sensitive`
			`- fixed the distorted skybox in room 5 of Barkhang Monastery`
tr2/gun_rifle: fix harpoon recoil in NG+ This ensures that harpoon ammo is decremented in NG+ so that the recoil check continues as normal after 4 rounds. The ammo is always incremented by 4 so that infinite ammo remains. Resolves #1575. 2024-10-26 15:02:49 +01:00			`- fixed Lara reloading the harpoon gun after every shot in NG+`
misc: import tr2 codebase 2024-10-02 09:33:35 +02:00
			`#### Visuals`

			`- fixed TGA screenshots crashing the game`
tr2/lara: revert camera after extra anim unless heavy The Lara_State_Extra_Breath function serves as a bridging animation between an extra animation and Lara returning to normal. This change will respect any heavy camera triggers set during the extra animation rather than blindly resetting to chase type. Resolves #1580. 2024-10-16 13:46:18 +01:00			`- fixed the camera being cut off after using the gong hammer in Ice Palace`
tr2/boat: fix Lara's room number when on boat This tests Lara's position more accurately for cases when the boat's room number is the water room below, but we want Lara to be defined in the dry room above to remove her underwater hue. Resolves #1596. 2024-10-26 14:01:04 +01:00			`- fixed Lara's underwater hue being retained when re-entering a boat`
misc: import tr2 codebase 2024-10-02 09:33:35 +02:00
			`#### Audio`

			`- fixed music not playing with certain game versions`
tr2/data: remove silence from gong track (#1726) This strips the ~1.5 seconds of silence out of the gong audio track so that it's in sync with Lara striking the gong itself. Resolves #1725. 2024-10-18 11:44:57 +01:00			`- fixed the audio not being in sync when Lara strikes the gong in Ice Palace`
misc: import tr2 codebase 2024-10-02 09:33:35 +02:00
			`#### Mods`
misc: merge tr2 and libtrx codebases 2024-10-02 10:23:23 +02:00			- added developer console (accessible with `/`, see [COMMANDS.md](COMMANDS.md) for details)