Skip to content

Commit c13eb4d

Browse files
versableversable
committed
docs: document -benchmark option
1 parent c579e8d commit c13eb4d

2 files changed

Lines changed: 32 additions & 19 deletions

File tree

‎README.md‎

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -158,22 +158,23 @@ The game menu in Gothic 2 is done by scripting. While the original graphics sett
158158
Rendering distance is not customizable.
159159

160160
## Command line arguments
161-
| Argument(s) | Description |
162-
| ---------------------- | ------- |
163-
| `-g` | specify path containing Gothic game data |
164-
| `-game:<modfile.ini>` | specify game modification manifest (GothicStarter compatibility) |
165-
| `-nomenu` | skip main menu |
166-
| `-devmode` | enable marvin-mode at start of the game |
167-
| `-w <worldname.zen>` | startup world; newworld.zen is default |
168-
| `-save q` | load the quick save on start |
169-
| `-save <number>` | load a specified save-game slot on start |
170-
| `-v -validation` | enable validation layers for graphics api |
171-
| `-dx12` | force DirectX 12 renderer instead of Vulkan (Windows only) |
172-
| `-g1` | assume a Gothic 1 installation |
173-
| `-g2c` | assume a Gothic 2 classic installation |
174-
| `-g2` | assume a Gothic 2 night of the raven installation |
175-
| `-rt <boolean>` | explicitly enable or disable ray-query |
176-
| `-gi <boolean>` | explicitly enable or disable ray-traced global illumination |
177-
| `-ms <boolean>` | explicitly enable or disable meshlets |
178-
| `-aa <number>` | enable anti-aliasing (number = 1-2, 2 = most expensive AA) |
179-
| `-window` | windowed debugging mode (not to be used for playing) |
161+
| Argument(s) | Description |
162+
| ---------------------- | ------- |
163+
| `-g` | specify path containing Gothic game data |
164+
| `-game:<modfile.ini>` | specify game modification manifest (GothicStarter compatibility) |
165+
| `-nomenu` | skip main menu |
166+
| `-devmode` | enable marvin-mode at start of the game |
167+
| `-w <worldname.zen>` | startup world; newworld.zen is default |
168+
| `-save q` | load the quick save on start |
169+
| `-save <number>` | load a specified save-game slot on start |
170+
| `-v -validation` | enable validation layers for graphics api |
171+
| `-dx12` | force DirectX 12 renderer instead of Vulkan (Windows only) |
172+
| `-g1` | assume a Gothic 1 installation |
173+
| `-g2c` | assume a Gothic 2 classic installation |
174+
| `-g2` | assume a Gothic 2 night of the raven installation |
175+
| `-rt <boolean>` | explicitly enable or disable ray-query |
176+
| `-gi <boolean>` | explicitly enable or disable ray-traced global illumination |
177+
| `-ms <boolean>` | explicitly enable or disable meshlets |
178+
| `-aa <number>` | enable anti-aliasing (number = 1-2, 2 = most expensive AA) |
179+
| `-window` | windowed debugging mode (not to be used for playing) |
180+
| `-benchmark [ci]` | run automated benchmark, reports avg/1% low FPS to stdout and log.txt; `ci` exits after completion |

‎doc/Gothic2Notr.6‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,18 @@ Enable anti-aliasing. Number can be 0-2, where 2 is the most expensive AA.
7070
.TP
7171
.B \-window
7272
Windowed debugging mode (not recommended for normal play).
73+
.TP
74+
.BI \-benchmark " [ci]"
75+
Run an automated benchmark without user input. Reports average FPS and
76+
1% low FPS to the console, log.txt, and standard output. Typically used
77+
with
78+
.B \-devmode \-nomenu
79+
for automated testing. If
80+
.B ci
81+
is specified, the program exits automatically after completion (useful
82+
for regression testing). The benchmark can be restarted in-game with
83+
.B ztoggle timedemo
84+
or cancelled by loading a save game.
7385
.SH GRAPHICS OPTIONS
7486
The in-game menu provides additional graphics settings:
7587
.TP

0 commit comments

Comments
 (0)