Skip to content

Commit

Permalink
Create version 1.5.0 (#757)
Browse files Browse the repository at this point in the history 
Update to version 1.5.0
Update documentation.
Closes #746
  • Loading branch information
@chreden
chreden authored Apr 18, 2021
1 parent 1f90aa2 commit a6ff02c
Show file tree
Hide file tree
Showing 2 changed files with 188 additions and 18 deletions.
176 changes: 172 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,9 @@ Triggers | Toggle trigger visibility
Geometry | Toggle hidden geometry visibility
Water | Toggle water in water rooms
Depth | Toggle depth mode. This will show the currently selected depth of neighbours of the current room.
Depth Selector | Choose the depth of neighbours to show.
Flip | Toggle the level flipmap (if present in the level)
Depth Selector | Choose the depth of neighbours to show
Wireframe | Enable wireframe rendering mode
Flip | Toggle the level flipmap (if present in the level). In TR4+ this will be a flipmap group selector.

### Room

Expand Down Expand Up @@ -141,7 +142,7 @@ The 'Triggered By' list shows the triggers that can trigger the item. Clicking a

<</>> This button collapses or expands the side panel.


Each Item can be hidden or made visible by clicking the checkbox in the 'Hide' column.

### Triggers Window

Expand All @@ -157,6 +158,8 @@ The 'Commands' list shows the commands carried out when the trigger executes. Cl

Multiple Trigger windows can be active at once.

Each Trigger can be hidden or made visible by clicking the checkbox in the 'Hide' column.

### Rooms Window

Input|Action
Expand Down Expand Up @@ -201,6 +204,58 @@ At the bottom right of the screen is the 3D compass. This shows the current dire

At the bottom left of the screen are the current camera coordinates. You can click on X, Y, or Z and enter camera coordinates to go that location. Tab will cycle from X to Y to Z and enter will confirm the change.


## Menus

### File

#### Open
Open a level file.
#### Open Recent
Open a recently opened file. Up to 10 successfully opened files will appear here.
#### Switch Level
Open another level in the same folder as the currently opened level file.
#### Exit
Close trview.

### View
#### 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.
#### Background Colour
Change the background colour for the 3D view.
#### Unhide All
Unhides all entities and triggers that have been hidden via the context menu or their windows.

### Windows
#### Items
Create a new items window.
#### Triggers
Create a new triggers window.
#### Rooms
Create a new rooms window.
#### Route
Create or ppen the route window.

### Help
#### Github
Go to the trview GitHub page.
#### Discord
Permanent invite to the trview Discord.
#### About
Show the about box.

## Licenses

### Lua
Expand All @@ -210,4 +265,117 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

### boost-ext/di

https://github.com/boost-ext/di/

Boost Software License - Version 1.0 - August 17th, 2003

Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:

The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

### nlohmann/json

```
__ _____ _____ _____
__| | __| | | | JSON for Modern C++
| | |__ | | | | | | version 3.1.2
|_____|_____|_____|_|___| https://github.com/nlohmann/json
```
Licensed under the MIT License <http://opensource.org/licenses/MIT>.
SPDX-License-Identifier: MIT
Copyright (c) 2013-2018 Niels Lohmann <http://nlohmann.me>.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

### zlib

zlib.h -- interface of the 'zlib' general purpose compression library
version 1.2.11, January 15th, 2017

Copyright (C) 1995-2017 Jean-loup Gailly and Mark Adler

This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.

Jean-loup Gailly Mark Adler
[email protected] [email protected]


The data format used by the zlib library is described by RFCs (Request for
Comments) 1950 to 1952 in the files http://tools.ietf.org/html/rfc1950
(zlib format), rfc1951 (deflate format) and rfc1952 (gzip format).

### DirectXTK

The MIT License (MIT)

Copyright (c) 2018 Microsoft Corp

Permission is hereby granted, free of charge, to any person obtaining a copy of this
software and associated documentation files (the "Software"), to deal in the Software
without restriction, including without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be included in all copies
or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
30 changes: 16 additions & 14 deletions trview.app/Resources/trview.app.rc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,20 +99,22 @@ END
// Dialog
//

IDD_ABOUTBOX DIALOGEX 0, 0, 243, 145
IDD_ABOUTBOX DIALOGEX 0, 0, 220, 130
STYLE DS_SETFONT | DS_MODALFRAME | DS_FIXEDSYS | WS_POPUP | WS_CAPTION | WS_SYSMENU
CAPTION "About trview"
FONT 8, "MS Shell Dlg", 0, 0, 0x1
BEGIN
ICON IDI_TRVIEW,IDC_STATIC,14,14,21,20
LTEXT "trview, Version 1.4.1",IDC_STATIC,42,14,114,8,SS_NOPREFIX
LTEXT "Copyright (C) 2020 trview team",IDC_STATIC,42,26,127,17
DEFPUSHBUTTON "OK",IDOK,186,124,50,14,WS_GROUP
LTEXT "Licensed under the MIT license",IDC_STATIC,42,38,127,17
LTEXT "Uses DirectXTK (MIT license)",IDC_STATIC,42,49,136,13
LTEXT "Based on the information in TRosettaStone3 - https://trwiki.earvillage.net. TRosettaStone3 uses the CC BY-SA 4.0 license. https://creativecommons.org/licenses/by-sa/4.0/#",IDC_STATIC,41,84,174,39
LTEXT "Uses zlib (zlib license)",IDC_STATIC,42,60,136,13
LTEXT "Uses nlohmann/json (MIT)",IDC_STATIC,42,72,180,13
LTEXT "trview, Version 1.5.0",IDC_STATIC,42,14,114,8,SS_NOPREFIX
LTEXT "Copyright (C) 2021 trview team",IDC_STATIC,42,26,127,17
LTEXT "Licensed under the MIT license\r\n\
Uses DirectXTK (MIT)\r\n\
Uses zlib (zlib)\r\n\
Uses nlohmann/json (MIT)\r\n\
Uses boost-ext/di (boost)\r\n\
Based on the information in TRosettaStone3 - https://github.com/opentomb/TRosettaStone3\
\r\n\r\n",IDC_STATIC,42,38,200,70
DEFPUSHBUTTON "OK", IDOK, 134, 108, 50, 14, WS_GROUP
END


Expand Down Expand Up @@ -194,8 +196,8 @@ LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_UK
//

VS_VERSION_INFO VERSIONINFO
FILEVERSION 1,4,1,0
PRODUCTVERSION 1,4,1,0
FILEVERSION 1,5,0,0
PRODUCTVERSION 1,5,0,0
FILEFLAGSMASK 0x3fL
#ifdef _DEBUG
FILEFLAGS 0x1L
Expand All @@ -211,12 +213,12 @@ BEGIN
BLOCK "080904b0"
BEGIN
VALUE "FileDescription", "TRView"
VALUE "FileVersion", "1.4.1.0"
VALUE "FileVersion", "1.5.0.0"
VALUE "InternalName", "trview.exe"
VALUE "LegalCopyright", "Copyright (C) chreden 2020"
VALUE "LegalCopyright", "Copyright (C) chreden 2021"
VALUE "OriginalFilename", "trview.exe"
VALUE "ProductName", "TRView"
VALUE "ProductVersion", "1.4.1.0"
VALUE "ProductVersion", "1.5.0.0"
END
END
BLOCK "VarFileInfo"
Expand Down

0 comments on commit a6ff02c

Please sign in to comment.