-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Split the readme up a little to make it easier to follow. Closes #1087
- Loading branch information
Showing
41 changed files
with
989 additions
and
770 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Camera/Sink Window | ||
_Shortcut: Ctrl + K_ | ||
|
||
![Camera/Sink Window](camera-sink.png) | ||
|
||
## Options | ||
|
||
Input|Action | ||
---|------ | ||
Filters | Open the [filters](filters.md) editor. The checkbox toggles whether configured filters are applied. | ||
Track Room | Whether to show the camera/sinks that are in the currently selected room | ||
Sync | Whether the camera/sink selected in the window will be synced with the camera/sink selected in the view (bidirectional) | ||
|
||
## Camera/Sink List | ||
|
||
Column | Meaning | ||
---|--- | ||
\# | The camera/sink number | ||
Room | The number of the room that the camera/sink is in | ||
Type | The type name of the camera/sink | ||
Hide | Whether to hide this camera/sink in the viewer | ||
|
||
## Camera/Sink Details | ||
|
||
The type of the camera/sink can be swapped between camera and sink to see the different interpretation of the values. | ||
|
||
Stat | Camera/Sink Type | ||
--- | --- | ||
Type | Both | ||
\# | Both | ||
Position | Both | ||
Room | Camera | ||
Persistent | Camera | ||
Strength | Sink | ||
Box Index | Sink | ||
Inferred Room | Sink | ||
|
||
## Triggered By | ||
The `Triggered By` list shows the triggers that can trigger the camera/sink. Clicking a trigger in the list will select that trigger. | ||
|
||
Column | Meaning | ||
---|--- | ||
\# | The trigger number | ||
Room | The number of the room that the trigger is in | ||
Type | The type name of the trigger |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Console | ||
|
||
The console window will log diagnostic messages in the future and can be used to run Lua. | ||
|
||
![Console](console.png) | ||
|
||
The input box allows you to enter Lua scripts. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# Controls | ||
|
||
## General | ||
|
||
Key|Action | ||
---|------ | ||
CTRL + O | Open file | ||
CTRL + F | Show find window | ||
CTRL + R | Open Route window | ||
CTRL + T | New Triggers window | ||
CTRL + I | New Items window | ||
CTRL + M | New Rooms window | ||
CTRL + L | New Lights window | ||
CTRL + K | New Camera/Sink window | ||
CTRL + P | New Plugins window | ||
CTRL + S | New Statics Window | ||
CTRL + H | Toggle room lighting | ||
F1 | Toggle settings window | ||
F5 | Reload current level | ||
F6 | Load previous level in directory | ||
F7 | Load next level in directory | ||
F | Free camera | ||
G | Toggle geometry mode | ||
H | Toggle room highlighting | ||
L | Toggle lights visibility | ||
K | Toggle camera/sink visibility | ||
O | Orbit camera | ||
P | Toggle flipmap | ||
T | Toggle trigger visibility | ||
X | Axis camera | ||
INSERT | Reset camera | ||
Left mouse | Click on a room to go to that room | ||
:arrow_left: | Go to previous waypoint in route | ||
:arrow_right: | Go to next waypoint in route | ||
Delete | Delete the currently selected waypoint | ||
Right mouse | Show the context menu | ||
|
||
## Free View | ||
|
||
Key|Action | ||
---|------ | ||
W | Move forward | ||
A | Move left | ||
S | Move backwards | ||
D | Move right | ||
E | Move up | ||
Q | Move down | ||
Right mouse + move | Change look direction | ||
Mouse wheel | Zoom in/out | ||
|
||
## Axis View | ||
|
||
Key|Action | ||
---|------ | ||
W | Move forward along Z axis | ||
S | Move backwards along Z axis | ||
A | Move backwards along X axis | ||
D | Move forward along X axis | ||
E | Move up | ||
Q | Move down | ||
Right mouse + move | Change look direction | ||
|
||
## Orbit View | ||
|
||
Key|Action | ||
---|------ | ||
Left mouse + move | Pan camera | ||
Right mouse + move | Rotate around target | ||
Left + Right mouse + move | Vertical panning | ||
Mouse wheel | Zoom in/out |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Filters | ||
|
||
Filters can be used and combined to build a query to find items based on their properties. The following windows currently support filters: | ||
- `Items` | ||
- `Triggers` | ||
- `Lights` | ||
- `Rooms` | ||
- `Camera/Sink` | ||
|
||
## Using Filters | ||
|
||
![Screenshot](filters_1.png) | ||
|
||
![Screenshot](filters_2.png) | ||
|
||
Filters are enabled by default in each window. The usage of the current filter can be toggled with the checkbox next to the `Filters` button on each window. The filters editor can be opened by clicking the `Filters` button. New filters can be added with the `+` button and deleted with the `X` button. | ||
|
||
When multiple filters are defined they can be combined with different operators. | ||
|
||
The contents of the list will be filtered and show the items that satisfy all of the conditions. | ||
|
||
## Compare Operations | ||
|
||
Different comparison operators are available depending on the data type of the selected property and whether it is a single or multi-value property. | ||
|
||
| Name | String | Number | Boolean | Number of Values | | ||
| ---- | ------ | ------ | ------- | ---- | | ||
| Is | ✓ | ✓ | ✓ | 1 | | ||
| Is not | ✓ | ✓ | ✓ | 1 | | ||
| Greater than | ✗ | ✓ | ✗ | 1 | | ||
| Greater than or equal | ✗ | ✓ | ✗ | 1 | | ||
| Less than | ✗ | ✓ | ✗ | 1 | | ||
| Less than or equal | ✗ | ✓ | ✗ | 1 | | ||
| Between | ✗ | ✓ | ✗ | 2 | | ||
| Between inclusive | ✗ | ✓ | ✗ | 2 | | ||
| Is Present* | ✓ | ✓ | ✓ | 0 | | ||
| Is not Present | ✓ | ✓ | ✓ | 0 | | ||
|
||
If the value is a multi value property such as `Triggered By` on an `Item` then two additional operations: `is present` and `is not present` are available. This will return whether there are any values for that property on the item being tested. | ||
|
||
## Combining Filters | ||
|
||
Filters can be combined with either `And` or `Or`. Filters are combined in the order they are defined. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Items Window | ||
_Shortcut: Ctrl+I_ | ||
|
||
Shows the list of items that exist in the current level and allows you to filter, sort, inspect and add items to a route. | ||
|
||
![Items Window](items.png) | ||
|
||
## Options | ||
|
||
Input|Action | ||
---|------ | ||
Filters | Open the [filters](filters.md) editor. The checkbox toggles whether configured filters are applied. | ||
Track | Whether to show the items that are in the currently selected room. Clicking the button will show the expanded track menu where you can choose whether rooms are tracked. | ||
Sync | Whether the item selected in the window will be synced with the item selected in the view (bidirectional) | ||
|
||
## Items List | ||
|
||
Column | Meaning | ||
---|--- | ||
\# | The item number | ||
Room | The number of the room that the item is in | ||
ID | The type ID of the item | ||
Type | The type name of the item | ||
Hide | Whether to hide this item in the viewer | ||
|
||
## Item Details | ||
|
||
Stat | Meaning | ||
--- | --- | ||
Type | The type name of the item | ||
\# | The item number | ||
Position | The position of the item in world space | ||
Angle | The raw rotation value | ||
Angle Degrees | The rotation value converted to degrees | ||
Type ID | The type ID of the item | ||
Room | The number of the room that the item is in | ||
Clear Body | Whether to remove a dead body when a bodybag trigger is triggered | ||
Invisible | Whether this item is invisible | ||
Flags | Entity activation flags | ||
OCB | Used to change entity behaviour | ||
Category | Categories to which the item is assigned | ||
|
||
## Add To Route | ||
Clicking the `Add to Route` button will insert this item at the current position in the route. | ||
|
||
## Triggered By | ||
The `Triggered By` list shows the triggers that can trigger the item. Clicking a trigger in the list will select that trigger. | ||
|
||
Column | Meaning | ||
---|--- | ||
\# | The trigger number | ||
Room | The number of the room that the trigger is in | ||
Type | The type name of the trigger |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# Lights Window | ||
_Shortcut: Ctrl + L_ | ||
|
||
![Lights Window](lights.png) | ||
|
||
## Options | ||
|
||
Input|Action | ||
---|------ | ||
Filters | Open the [filters](filters.md) editor. The checkbox toggles whether configured filters are applied. | ||
Track Room | Whether to show the lights that are in the currently selected room. Clicking the button will show the expanded track menu where you can choose whether rooms are tracked. | ||
Sync | Whether the light selected in the window will be synced with the light selected in the view (bidirectional) | ||
|
||
## Lights List | ||
|
||
Column | Meaning | ||
---|--- | ||
\# | The light number | ||
Room | The number of the room that the light is in | ||
Type | The type name of the light | ||
Hide | Whether to hide this light in the viewer | ||
|
||
## Light Details | ||
|
||
Stat | Light Type | Game Version | ||
--- | --- | --- | ||
Type | All | All | ||
\# | All | All | ||
Room | All | All | ||
Position | Point, Spot, Shadow, Fog Bulb | All | ||
Intensity |Point, Spot| TR1-3 | ||
Fade |Point, Spot|TR1-3 | ||
Colour | Point, Spot, Sun, Shadow | TR3+ | ||
Direction |Sun, Spot|TR3+ | ||
Intensity |Point, Spot, Shadow, Fog Bulb|TR1-4 | ||
Hotspot|Point, Spot, Shadow|TR4+ | ||
Falloff|Point, Shadow|TR4+ | ||
Falloff Angle|Spot|TR4+ | ||
Length|Spot|TR4 | ||
Cutoff|Spot|TR4 | ||
Rad In|Spot|TR5 | ||
Rad Out|Spot|TR5 | ||
Range|Spot|TR5 | ||
Density|Fog Bulb|TR4+ | ||
Radius|Fog Bulb|TR4+ | ||
|
||
### Light Types | ||
|
||
Not all light types are in all games. The table below shows when the different types are introduced. | ||
|
||
Type | Games | ||
---|--- | ||
Point|All | ||
Spot|TR3+ | ||
Sun|TR3+ | ||
Shadow|TR4+ | ||
Fog Bulb|TR4+ |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# Menus | ||
|
||
## File | ||
|
||
![File Menu](menu_file.png) | ||
|
||
Action|Meaning | ||
---|--- | ||
Open|Open a level file | ||
Open Recent|Open a recently opened file. The number of recent files can be changed in the [settings] window. | ||
Switch Level|Open another level in the same folder as the currently opened level file. | ||
Reload|Reload the current level from file | ||
Exit|Close trview | ||
|
||
## View | ||
|
||
![View Menu](menu_view.png) | ||
|
||
Action|Meaning | ||
---|--- | ||
UI|Toggle on or off visibility of all UI elements. This will override the other visibility options below if set to off. | ||
Minimap|Toggle visibility of the minimap. | ||
Tooltip|Toggle visibility of the tooltip when hovering over elements in the viewer. | ||
Compass|Toggle visibility of the compass. | ||
Selection|Toggle visibility of the selection highlights. | ||
Route|Toggle visibility of the route waypoints and paths. | ||
Tools|Toggle visibility of the tools, such as the measure tool. | ||
Unhide All|Unhides anything that has been hidden via the context menu or their windows. | ||
|
||
## Windows | ||
|
||
![Windows Menu](menu_windows.png) | ||
|
||
Action|Meaning | ||
---|--- | ||
Items|Create a new [items window](itemswindow.md) | ||
Triggers|Create a new [triggers window](triggerswindow.md) | ||
Rooms|Create a new [rooms window](roomswindow.md) | ||
Route|Create or open the [route window](routewindow.md) | ||
Lights|Create a new [lights window](lightswindow.md) | ||
Camera/Sink|Create a new [camera/sink window](camerasinkwindow.md) | ||
Log|Create a new [log window](logwindow.md) | ||
Textures|Create a new [textures window](textureswindow.md) | ||
Console|Create a new [console window](consolewindow.md) | ||
Plugins|Create a new [plugins window](pluginswindow.md) | ||
Statics|Create a new [statics window](staticswindow.md) | ||
Reset Layout|Clear any UI customisations that have been applied | ||
Reset Fonts|Reset the font face and size to default | ||
|
||
## Help | ||
|
||
![Help Menu](menu_help.png) | ||
|
||
Action|Meaning | ||
---|--- | ||
Github|Go to the trview GitHub page | ||
Discord|Permanent invite to the trview Discord | ||
About|Show the about box |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Plugins | ||
|
||
The plugins window shows the plugins that have been loaded from the configured plugins directories. The plugins directories can be managed from the [settings window](settings.md). | ||
|
||
![Plugins](plugins.png) | ||
|
||
Action|Usage | ||
---|--- | ||
Open|Opens the directory for the plugin in explorer. | ||
Reload|Attempts to reload the plugin from file. | ||
|
||
|
Oops, something went wrong.