Man pages #880
Man pages #880
Conversation
|
Hi, and thanks for PR! I'm not sure, if it's really a good idea to have a man like this. Problem with documentation - it has to be maintained, and in our case it will become out-of-sync very fast. Also need to mention, that eventually options such as |
|
Hey @Try, I'd be willing to keep the documentation in sync, and having a man page for a CLI tool is a must, if not a rite of passage. Traditionally config files are also documented. In this case, I'd opt to document Another practice is, that CLI ARGS/FLAGS overwrite the config setting. See the
I understand the hesitation of inclusion in such a moving target, and will keep this PR in sync with the current development and add another man page for |
- Create doc/Gothic2Notr.6 - Integrate into CMake using GNUInstallDirs - Update debian/rules to use cmake install
2 participants
Hey @Try,
This PR adds a man page, displays a short cmd arg overview on
-hand updates the README.md to include the benchmark option. The man page is automatically added to the DEB file.Here the
-houtput:Here the man page:
GOTHIC2NOTR(6) Games GOTHIC2NOTR(6) NAME Gothic2Notr - open source re-implementation of Gothic 2: Night of the Raven SYNOPSIS Gothic2Notr [-g path] [-game:modfile.ini] [options] DESCRIPTION OpenGothic is a feature-complete Gothic game client, compatible with the original game data and mods. It makes the original Gothic 1 and Gothic 2 work on modern systems using Vulkan graphics (or Metal on macOS, DirectX 12 on Windows). Gothic 2: Night of the Raven is required as OpenGothic does not provide any built-in game assets or scripts. OPTIONS -g path Specify the path containing Gothic game data. If not provided, OpenGothic attempts to auto-detect common installation paths. -game:modfile.ini Specify a game modification manifest file (GothicStarter compati‐ bility). -nomenu Skip the main menu and start the game directly. -devmode Enable marvin-mode (developer/debug mode) at the start of the game. -w worldname.zen Specify the startup world. Default is newworld.zen. -save q Load the quick save on start. -save number Load a specified save-game slot on start. -v, -validation Enable validation layers for the graphics API (useful for debug‐ ging). -dx12 Force DirectX 12 renderer instead of Vulkan (Windows only). -g1 Assume a Gothic 1 installation. -g2c Assume a Gothic 2 classic installation (without Night of the Raven). -g2 Assume a Gothic 2: Night of the Raven installation. -rt boolean Explicitly enable or disable ray-query. Affects only capable hardware. Off by default for integrated GPUs. -gi boolean Explicitly enable or disable ray-traced global illumination. -ms boolean Explicitly enable or disable meshlets (mesh shaders). -aa number Enable anti-aliasing. Number can be 0-2, where 2 is the most ex‐ pensive AA. -window Windowed debugging mode (not recommended for normal play). -benchmark [ci] Run an automated benchmark without user input. Reports average FPS and 1% low FPS to the console, log.txt, and standard output. Typically used with -devmode -nomenu for automated testing. If ci is specified, the program exits automatically after completion (useful for regression testing). The benchmark can be restarted in-game with ztoggle timedemo or cancelled by loading a save game. -h, --help Print a brief help message and exit. GRAPHICS OPTIONS The in-game menu provides additional graphics settings: Cloud Shadows Mapped to SSAO (Screen Space Ambient Occlusion). Radial Fog Mapped to volumetric fog. Reflections Screen space reflections. Video settings Internal 3D rendering resolution can be altered here. UI and text are always rendered at full resolution. MODIFICATIONS Mods can be installed as usual. Provide the modfile.ini to OpenGothic via the -game: parameter to play. Supported: Content mods (retexture/reworld/animations) that only rely on regular scripting and do not use memory hacking. Not supported: Ikarus/LeGo (partial support in progress), Union, DX11 Renderer, AST SDK, Ninja. FILES save_slot_0.sav Quick save file, stored in the current working directory. save_slot_1.sav ... save_slot_15.sav Regular save files, stored in the current working directory. log.txt Log file created in the current working directory. On macOS, if Gothic data is located in ~/Library/Application Sup‐ port/OpenGothic/, the working directory is changed there automatically, so saves and logs are stored alongside the game data. EXIT STATUS 0 Successful program execution. non-zero An error occurred, check log.txt for details. BUGS Report bugs at https://github.com/Try/OpenGothic/issues SEE ALSO Project homepage: https://github.com/Try/OpenGothic Discord community: https://discord.gg/G9XvcFQnn6 AUTHORS OpenGothic is developed by Try and contributors. OpenGothic January 2026 GOTHIC2NOTR(6)