Archive/TRX
0
0
Fork 0
mirror of https://github.com/LostArtefacts/TRX.git synced 2025-04-28 12:47:58 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: update docs

Browse source
This commit is contained in:
lahm86 2025-03-25 21:57:11 +00:00
parent 0618baebc9
commit e2bcd1aeb7
3 changed files with 167 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

63
docs/tr1/README.md
View file

@ -35,7 +35,7 @@ We hope that eventually these alerts will go away as the popularity of the proje
- Or the more manual link: https://archive.org/details/tomb-raider-i-unfinished-business-pc-eng-full-version_20201225
2. For TombATI users this means copying the `data`, `fmv` and `music` directories.
5. To play the game, run `TR1X.exe`.
6. To play the Unfinished Expansion pack, run `TR1X.exe -gold`.
6. To play the Unfinished Business expansion pack, run `TR1X.exe -gold`.
If you install everything correctly, your game directory should look more or
less like this (click to expand):
@ -48,24 +48,22 @@ less like this (click to expand):
│   ├── TR1X.json5 *
│   ├── TR1X_gameflow.json5
│   ├── TR1X_gameflow_demo_pc.json5
│   └── TR1X_gameflow_ub.json5
│   ├── TR1X_gameflow_level.json5
│   ├── TR1X_gameflow_ub.json5
│   ├── TR1X_strings.json5
│   ├── TR1X_strings_demo_pc.json5
│   ├── TR1X_strings_level.json5
│   └── TR1X_strings_ub.json5
├── data
│   ├── cat.phd
│   ├── cred0.pcx
│   ├── cred1.pcx
│   ├── cred2.pcx
│   ├── cred3.pcx
│   ├── cut1.phd
│   ├── cut2.phd
│   ├── cut3.phd
│   ├── cut4.phd
│   ├── egypt.phd
│   ├── eidospc.pcx
│   ├── end2.phd
│   ├── end.pcx
│   ├── end.phd
│   ├── gym.phd
│   ├── install.pcx
│   ├── level10a.phd
│   ├── level10b.phd
│   ├── level10c.phd
@ -81,10 +79,8 @@ less like this (click to expand):
│   ├── level8a.phd
│   ├── level8b.phd
│   ├── level8c.phd
│   ├── titleh.pcx
│   ├── titleh_ub.pcx
│   │── title.phd
│   │── images
│   ├── title.phd
│   ├── images
│   │ ├── atlantis.webp
│   │ ├── credits_1.webp
│   │ ├── credits_2.webp
@ -101,7 +97,17 @@ less like this (click to expand):
│   │ ├── peru.webp
│   │ ├── title.webp
│   │ ├── title_og_alt.webp
│   │ └── title_ub.webp
│   │ ├── title_ub.webp
│ │ └── og
│ │ ├── cred0.pcx
│ │ ├── cred1.pcx
│ │ ├── cred2.pcx
│ │ ├── cred3.pcx
│   │ ├── eidospc.pcx
│   │ ├── end.pcx
│   │ ├── install.pcx
│   │ ├── titleh.pcx
│   │ └── titleh_ub.pcx
│   └── injections
│   ├── atlantis_fd.bin
│   ├── atlantis_textures.bin
@ -182,7 +188,9 @@ less like this (click to expand):
├── shaders
│   ├── 2d.glsl
│   ├── 3d.glsl
│   └── fbo.glsl
│   ├── common.glsl
│   ├── fbo.glsl
│   └── sprites.glsl
├── TR1X.exe
└── TR1X_ConfigTool.exe
</pre>
@ -225,21 +233,14 @@ less like this (click to expand):
│   └── TR1X_gameflow_ub.json5
├── data
│   ├── cat.phd
│   ├── cred0.pcx
│   ├── cred1.pcx
│   ├── cred2.pcx
│   ├── cred3.pcx
│   ├── cut1.phd
│   ├── cut2.phd
│   ├── cut3.phd
│   ├── cut4.phd
│   ├── egypt.phd
│   ├── eidospc.pcx
│   ├── end2.phd
│   ├── end.pcx
│   ├── end.phd
│   ├── gym.phd
│   ├── install.pcx
│   ├── level10a.phd
│   ├── level10b.phd
│   ├── level10c.phd
@ -255,8 +256,6 @@ less like this (click to expand):
│   ├── level8a.phd
│   ├── level8b.phd
│   ├── level8c.phd
│   ├── titleh.pcx
│   ├── titleh_ub.pcx
│   │── title.phd
│   │── images
│   │ ├── atlantis.webp
@ -275,7 +274,17 @@ less like this (click to expand):
│   │ ├── peru.webp
│   │ ├── title.webp
│   │ ├── title_og_alt.webp
│   │ └── title_ub.webp
│   │ ├── title_ub.webp
│ │ └── og
│ │ ├── cred0.pcx
│ │ ├── cred1.pcx
│ │ ├── cred2.pcx
│ │ ├── cred3.pcx
│   │ ├── eidospc.pcx
│   │ ├── end.pcx
│   │ ├── install.pcx
│   │ ├── titleh.pcx
│   │ └── titleh_ub.pcx
│   └── injections
│   ├── atlantis_fd.bin
│   ├── atlantis_textures.bin
@ -357,7 +366,9 @@ less like this (click to expand):
└── shaders
   ├── 2d.glsl
   ├── 3d.glsl
   └── fbo.glsl
   ├── common.glsl
   ├── fbo.glsl
   └── sprites.glsl
</pre>
</details>

1
docs/tr2/CHANGELOG.md
View file

@ -1,5 +1,6 @@
## [Unreleased](https://github.com/LostArtefacts/TRX/compare/tr2-0.10...develop) - ××××-××-××
- added support for The Golden Mask (#1621)
- added an installer for Windows (#2681)
- added the bonus level game flow type, which allows for levels to be unlocked if all main game secrets are found (#2668)
- added the ability for custom levels to have up to two of each secret type per level (#2674)
- fixed the final two levels not allowing for secrets to be counted in the statistics (#1582)

129
docs/tr2/README.md
View file

@ -9,6 +9,13 @@ game with new enhancements and features.
## Windows / Linux
### Installing (simplified)
1. Head over to GitHub releases: https://github.com/LostArtefacts/TRX/releases
2. Download the TR2X installer. Your browser may complain that the .exe is unsafe, but it's OK to ignore this alert.
3. Mark the installer EXE as safe to run by right-clicking on the .exe, going to properties and clicking "Unblock".
4. Run the installer and proceed with the steps.
### Installing (manual)
1. Head over to GitHub releases: https://github.com/LostArtefacts/TRX/releases
@ -16,7 +23,129 @@ game with new enhancements and features.
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. Optionally you can also install the Golden Mask expansion pack files. Extract the contents of the following zip
into the target directory.
https://lostartefacts.dev/aux/tr2x/trgm.zip
5. To play the game, run `TR2X.exe`.
6. To play the Golden Mask expansion pack, run `TR2X.exe -gold`.
If you install everything correctly, your game directory should look more or
less like this (click to expand):
<details>
<p><em>* Will not be present until the game has been launched.</em></p>
<pre>
.
├── cfg
│   ├── TR2X.json5 *
│   ├── TR2X_gameflow.json5
│   ├── TR2X_gameflow_gm.json5
│   ├── TR2X_gameflow_level.json5
│   ├── TR2X_strings.json5
│   ├── TR2X_strings_gm.json5
│   └── TR2X_strings_level.json5
├── data
│   ├── assault.tr2
│   ├── boat.tr2
│   ├── catacomb.tr2
│   ├── cut1.tr2
│   ├── cut2.tr2
│   ├── cut3.tr2
│   ├── cut4.tr2
│   ├── deck.tr2
│   ├── emprtomb.tr2
│   ├── floating.tr2
│   ├── house.tr2
│   ├── icecave.tr2
│   ├── keel.tr2
│   ├── level1.tr2
│   ├── level2.tr2
│   ├── level3.tr2
│   ├── level4.tr2
│   ├── level5.tr2
│   ├── living.tr2
│   ├── main.sfx
│   ├── main_gm.sfx
│   ├── monastry.tr2
│   ├── opera.tr2
│   ├── platform.tr2
│   ├── rig.tr2
│   ├── skidoo.tr2
│   ├── title.tr2
│   ├── title_gm.tr2
│   ├── unwater.tr2
│   ├── venice.tr2
│   ├── wall.tr2
│   ├── xian.tr2
│   ├── images
│   │ ├── credit00_gm.png
│   │ ├── credit01.png
│   │ ├── credit02.png
│   │ ├── credit03.png
│   │ ├── credit04.png
│   │ ├── credit05.png
│   │ ├── credit06.png
│   │ ├── credit07.png
│   │ ├── credit07_gm.png
│   │ ├── credit08.png
│   │ ├── end.png
│   │ ├── legal.png
│   │ ├── title_eu.png
│   │ ├── title_eu_gm.png
│   │ ├── title_us.png
│   │ ├── title_us_gm.png
│ │ └── og
│ │ ├── credit00_gm.pcx
│ │ ├── credit01.pcx
│ │ ├── credit02.pcx
│ │ ├── credit03.pcx
│ │ ├── credit04.pcx
│   │ ├── credit05.pcx
│   │ ├── credit06.pcx
│   │ ├── credit07.pcx
│   │ ├── credit07_gm.pcx
│   │ ├── credit08.pcx
│   │ ├── credit09.pcx
│   │ ├── end.pcx
│   │ ├── legal.pcx
│   │ ├── title.pcx
│   │ ├── title_eu_gm.pcx
│   │ └── title_us_gm.pcx
│   └── injections
│   ├── barkhang_itemrots.bin
│   ├── barkhang_pickup_meshes.bin
│   ├── catacombs_fd.bin
│   └── etc...
├── fmv
│   ├── ancient.rpl
│   ├── crash.rpl
│   ├── end.rpl
│   ├── jeep.rpl
│   ├── landing.rpl
│   ├── logo.rpl
│   ├── modern.rpl
│   └── ms.rpl
├── music
│   ├── 2.mp3
│   ├── 3.mp3
│   └── etc...
├── shaders
│   ├── 2d.glsl
│   ├── 3d.glsl
│   ├── common.glsl
│   ├── fade.glsl
│   └── fbo.glsl
├── TR2X.exe
└── TR2X_ConfigTool.exe
</pre>
</details>
### Configuring
To configure TR2X, run the `TR2X_ConfigTool.exe` application. All the
configuration is explained in this tool. Alternatively, after running the game
at least once, you can edit `TR2X.json5` manually in a text editor such
as Notepad.
## macOS