Skip to content

Commit c579e8d

Browse files
versableversable
committed
docs: add man page for opengothic
- Create doc/Gothic2Notr.6 - Integrate into CMake using GNUInstallDirs - Update debian/rules to use cmake install
1 parent f149b2e commit c579e8d

3 files changed

Lines changed: 134 additions & 5 deletions

File tree

‎CMakeLists.txt‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
cmake_minimum_required(VERSION 3.16)
22

33
project(Gothic2Notr LANGUAGES C CXX)
4+
include(GNUInstallDirs)
45
set(CMAKE_CXX_STANDARD 20)
56
set(BUILD_SHARED_LIBS OFF)
67

@@ -186,4 +187,5 @@ if(${CMAKE_BUILD_TYPE} MATCHES "Debug")
186187
endif()
187188

188189
# installation
189-
install(TARGETS ${PROJECT_NAME} DESTINATION bin)
190+
install(TARGETS ${PROJECT_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR})
191+
install(FILES doc/Gothic2Notr.6 DESTINATION ${CMAKE_INSTALL_MANDIR}/man6)

‎debian/rules‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,7 @@ override_dh_update_autotools_config:
1111
override_dh_auto_configure:
1212
dh_auto_configure -- \
1313
-DCMAKE_BUILD_TYPE=RelWithDebInfo \
14+
-DCMAKE_INSTALL_BINDIR=games \
1415
-DZK_ENABLE_INSTALL=OFF \
1516
-DINSTALL_LIBS=OFF \
1617
-DINSTALL_CMAKE_FILES=OFF
17-
18-
# Custom install: only install the binary
19-
override_dh_auto_install:
20-
install -D -m 755 obj-*/opengothic/Gothic2Notr debian/opengothic/usr/games/Gothic2Notr

‎doc/Gothic2Notr.6‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
.\" Man page for Gothic2Notr (OpenGothic)
2+
.TH GOTHIC2NOTR 6 "January 2026" "OpenGothic" "Games"
3+
.SH NAME
4+
Gothic2Notr \- open source re-implementation of Gothic 2: Night of the Raven
5+
.SH SYNOPSIS
6+
.B Gothic2Notr
7+
.RB [ \-g
8+
.IR path ]
9+
.RB [ \-game:\fImodfile.ini\fR ]
10+
.RB [ options ]
11+
.SH DESCRIPTION
12+
.B OpenGothic
13+
is a feature-complete Gothic game client, compatible with the original
14+
game data and mods. It makes the original Gothic 1 and Gothic 2 work on
15+
modern systems using Vulkan graphics (or Metal on macOS, DirectX 12 on Windows).
16+
.PP
17+
Gothic 2: Night of the Raven is required as OpenGothic does not provide
18+
any built-in game assets or scripts.
19+
.SH OPTIONS
20+
.TP
21+
.BI \-g " path"
22+
Specify the path containing Gothic game data. If not provided, OpenGothic
23+
attempts to auto-detect common installation paths.
24+
.TP
25+
.BI \-game: modfile.ini
26+
Specify a game modification manifest file (GothicStarter compatibility).
27+
.TP
28+
.B \-nomenu
29+
Skip the main menu and start the game directly.
30+
.TP
31+
.B \-devmode
32+
Enable marvin-mode (developer/debug mode) at the start of the game.
33+
.TP
34+
.BI \-w " worldname.zen"
35+
Specify the startup world. Default is newworld.zen.
36+
.TP
37+
.B \-save q
38+
Load the quick save on start.
39+
.TP
40+
.BI \-save " number"
41+
Load a specified save-game slot on start.
42+
.TP
43+
.BR \-v ", " \-validation
44+
Enable validation layers for the graphics API (useful for debugging).
45+
.TP
46+
.B \-dx12
47+
Force DirectX 12 renderer instead of Vulkan (Windows only).
48+
.TP
49+
.B \-g1
50+
Assume a Gothic 1 installation.
51+
.TP
52+
.B \-g2c
53+
Assume a Gothic 2 classic installation (without Night of the Raven).
54+
.TP
55+
.B \-g2
56+
Assume a Gothic 2: Night of the Raven installation.
57+
.TP
58+
.BI \-rt " boolean"
59+
Explicitly enable or disable ray-query. Affects only capable hardware.
60+
Off by default for integrated GPUs.
61+
.TP
62+
.BI \-gi " boolean"
63+
Explicitly enable or disable ray-traced global illumination.
64+
.TP
65+
.BI \-ms " boolean"
66+
Explicitly enable or disable meshlets (mesh shaders).
67+
.TP
68+
.BI \-aa " number"
69+
Enable anti-aliasing. Number can be 0-2, where 2 is the most expensive AA.
70+
.TP
71+
.B \-window
72+
Windowed debugging mode (not recommended for normal play).
73+
.SH GRAPHICS OPTIONS
74+
The in-game menu provides additional graphics settings:
75+
.TP
76+
.B Cloud Shadows
77+
Mapped to SSAO (Screen Space Ambient Occlusion).
78+
.TP
79+
.B Radial Fog
80+
Mapped to volumetric fog.
81+
.TP
82+
.B Reflections
83+
Screen space reflections.
84+
.TP
85+
.B Video settings
86+
Internal 3D rendering resolution can be altered here. UI and text
87+
are always rendered at full resolution.
88+
.SH MODIFICATIONS
89+
Mods can be installed as usual. Provide the modfile.ini to OpenGothic via
90+
the
91+
.B \-game:
92+
parameter to play.
93+
.PP
94+
.B Supported:
95+
Content mods (retexture/reworld/animations) that only rely on regular
96+
scripting and do not use memory hacking.
97+
.PP
98+
.B Not supported:
99+
Ikarus/LeGo (partial support in progress), Union, DX11 Renderer,
100+
AST SDK, Ninja.
101+
.SH FILES
102+
.TP
103+
.I save_slot_0.sav
104+
Quick save file, stored in the current working directory.
105+
.TP
106+
.I save_slot_1.sav " ... " save_slot_15.sav
107+
Regular save files, stored in the current working directory.
108+
.TP
109+
.I log.txt
110+
Log file created in the current working directory.
111+
.PP
112+
On macOS, if Gothic data is located in
113+
.IR ~/Library/Application\ Support/OpenGothic/ ,
114+
the working directory is changed there automatically, so saves and logs
115+
are stored alongside the game data.
116+
.SH EXIT STATUS
117+
.TP
118+
.B 0
119+
Successful program execution.
120+
.TP
121+
.B non-zero
122+
An error occurred, check log.txt for details.
123+
.SH BUGS
124+
Report bugs at https://github.com/Try/OpenGothic/issues
125+
.SH SEE ALSO
126+
Project homepage: https://github.com/Try/OpenGothic
127+
.PP
128+
Discord community: https://discord.gg/G9XvcFQnn6
129+
.SH AUTHORS
130+
OpenGothic is developed by Try and contributors.

0 commit comments

Comments
 (0)