Skip to content

Commit

Permalink
Add more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TheIndra55 committed Feb 21, 2024
1 parent 5244a26 commit 9996189
Show file tree
Hide file tree
Showing 6 changed files with 184 additions and 715 deletions.
2 changes: 1 addition & 1 deletion docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,4 @@ void MyModule::OnInput(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam)
#### OnPostInitialize
Called on post initialization after the device has been obtained
Called on post initialization after the device has been obtained
162 changes: 162 additions & 0 deletions docs/features.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,164 @@
# Features

There is a wide range of features, this page explains all the features.

## Controls

The following keys can be used ingame.

| Key | Description |
|-----|-------------|
| <kbd>F8</kbd> | Shows the menu |
| <kbd>F2</kbd> | Toggles the skew/flight cheat |
| <kbd>F3</kbd> | Freezes the games |
| <kbd>F4</kbd> | Toggles the free camera mode |
| <kbd>F5</kbd> | Toggles player control |
| <kbd>F11</kbd> | Instant ragdoll death |

### Skew

The skew cheat can be used to fly the player freely through the world. To move the player up or down use the <kbd>Q</kbd> and <kbd>Z</kbd> keys (or <kbd>A</kbd> and <kbd>W</kbd> on AZERTY).

## Free camera

The free camera can be used to freely fly the camera.

### Modes

The free camera can be used in two modes. The first mode freezes player control and allows you to fly the camera, the second mode disables the camera control and allows you to control the player again. At any moment you can press <kbd>F5</kbd> to toggle the player control.

### Controls

The following controls are used by the free camera

| Key | Description |
|-----|-------------|
| WASD | Move the camera forward, backwards, left or right |
| <kbd>Shift</kbd> | Fast camera speed |
| <kbd>Ctrl</kbd> | Slow camera speed |
| <kbd>Q</kbd>/<kbd>E</kbd> | Move the camera up/down |
| <kbd>1</kbd>/<kbd>3</kbd> | Roll the camera |

## Options

The options menu under help provides some options for toggling features or changing defaults.

## Menu

This menu is always visible and contains some basic or quick options.

### Load unit

This allows you to switch to a different unit (level).

### Birth object

This allows you to spawn an instance with the object name.

### Player

This section contains some options related to the player.

#### Fill 'er up

This fills up your health to the max health, the name of this option is based on the real debug menu.

#### Outfit

This allows you to change the player outfit, press the next button to go through the outfits.

#### No interpolation

This disables animation interpolation.

#### No death fade

This disables the fade on death, meaning the player won't respawn after dying. Disable this option again to respawn.

### Time

This section allows you to change the time multiplier for example to slow down the game or speed it up.

### Save

This section allows you to change saved data, currently this only contains the ability to set event variables.

## Instances

The instance viewer (instances) shows all the current instances in the game.

### Transforms

This section can be used to change the position and rotation of an instance.

### Object

This section shows some basic info about the object of the instance.

### Draw groups

This section shows the current draw groups and allows you to toggle draw groups on the model.

### Animations

This sections shows the current playing animations on the instance and allows you to play animations.

### Messaging

This section is used for posting messages to the instance.

## Level

The level menu contains some options relating to levels.

### Disable script

Checking this option will disable the loading of the level script.

### Event debug

This window allows you to see the current event (script) variables for a level.

## Draw

The draw menu can be used to enable various of debug drawing such as drawing of the collision mesh or signals.

### Draw options

This window will be visible when drawing instances or the collision mesh and allows you to specify some filters.

### Draw instances

This will draw a text with the instance name on the world position of all instances.

### Draw markup

This will draw a visualization of all markup, such as ledges.

### Draw enemy route

This will visualize the pathfinding route of all enemies.

### Draw collision

This will visualize the collision mesh of the current level.

### Draw portals

This will visualize all portals which are between levels.

### Draw signals

This will draw all signals (triggers) in the current level.

## Debug

The debug menu has some restored event debug features.

### Draw debug

This will enable all of the debug drawing from the level.

### Debug keypad

This will enable the debug keypad, which allows you to use debug key combinations.
21 changes: 21 additions & 0 deletions docs/mods.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Mods

A mod loader is provided out of the box, this allows you to replace game files without modifying the game archives.

## Mods folder

The mods folder, located in the game folder contains all overridden files. Files which are normally in the PC-W folder such as lara.drm are located in the root of the mods folder, other locations such as `\trae\pc\objectlist.txt` have been relocated to the mods folder.

## Specialisation

For localized files such as locals.bin the language mask can be appended after the file name. For example for the French language mask (2) this will be `locals.bin_002`.

## Examples

Below are some example paths mapped to mods folder.

| Original path | Mods folder path |
|---------------|------------------|
| `pc-w\lara.drm` | `mods\lara.drm` |
| `pc-w\sndstrm\ui\trae_main_theme_2.mul` | `mods\sndstrm\ui\trae_main_theme_2.mul` |
| `\trae\pc-w\objectlist.txt` | `mods\trae\pc-w\objectlist.txt` |
86 changes: 0 additions & 86 deletions docs/tr7.txt

This file was deleted.

Loading

0 comments on commit 9996189

Please sign in to comment.