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

docs: add migration guide for builders

Browse source
This commit is contained in:
Marcin Kurczewski 2025-02-04 20:14:09 +01:00
parent c76d8d4394
commit 850c08113a
2 changed files with 40 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

34
docs/MIGRATING.md Normal file
View file

@ -0,0 +1,34 @@
## Migration guide for level builders
## TR1X
### Version 4.7 to TR1X 4.8
1. **Rename basic keys**
- Replace `file` key with `path` for every level.
- Replace `music` key with `music_track` for every level.
2. **Update level enumeration structure**:
- The `"type": "title"` property is no longer supported. Instead, the title
level needs to be placed in the top-level `"title"` key.
- The `"type": "cutscene"` property is no longer supported. Instead, the
cutscenes need to be placed in the top-level `"cutscenes"` array.
- All FMVs need to be placed in its own top-level `"fmvs"` array.
3. **Update individual level sequences**
- `start_game` should be removed.
- `loop_game` should be replaced with `play_level`.
- `exit_to_cine` should be removed.
- `exit_to_level` should be replaced with `level_complete`. No parameter needed.
- `display_picture` no longer takes a `picture_path` argument and instead just takes a `path`.
- `loading_screen` no longer takes a `picture_path` argument and instead just takes a `path`.
- `level_stats` no longer takes a `level_id` argument.
- `total_stats` no longer takes a `picture_path` argument and instead takes a `background_path`.
- `play_fmv` no longer takes a `fmv_path` argument and instead takes a `fmv_id`.
4. **Update strings**
The game strings are now placed in a separate file, `TR1X_strings.json5` in
preparation to eventually support internationalization. Elements such as
item titles or item names need to be configured entirely in the new file, so
all `"strings"` keys can be safely removed from the game flow. Refer to
[GAME_STRINGS.md](GAME_STRINGS.md) for more details.

8
docs/tr1/CHANGELOG.md
View file

@ -1,7 +1,10 @@
## [Unreleased](https://github.com/LostArtefacts/TRX/compare/tr1-4.7.1...develop) - ××××-××-××
>[!WARNING]
>There is a backwards incompatible change important for level builders, that changes where to place key item names and level titles.
>Please refer to the [documentation](../GAME_STRINGS.md) to see how to upgrade your level files.
>Attention level builders: this version introduces backwards incompatible changes to the game flow file.
>Please refer to the following documents to see how to update your levels:
>- [Migration guide](../MIGRATING.md)
>- [Game flow documentation](../GAME_FLOW.md)
>- [Game strings documentation](../GAME_STRINGS.md)
- added the ability to hold left/right to move through menus more quickly (#2298)
- added an option for pickup aids, which will show an intermittent twinkle when Lara is nearby pickup items (#2076)
@ -15,6 +18,7 @@
- added a `/music` console command that plays a specific music track
- added a console log when using the `/demo` command
- ⚠️ changed the game data to use a separate strings file for text information, removing it from the game flow file
- ⚠️ changed the game flow file internal structure
- changed the object texture limit from 2048 to unlimited (within game's overall memory cap)
- changed the sprite texture limit from 512 to unlimited (within game's overall memory cap)
- changed demo to be interrupted only by esc or action keys