Developer documentation
Work on TaystJK
TaystJK uses CMake to produce the multiplayer client, dedicated server, game modules, UI, and three renderer backends.
Build and debug
Get a working build and step through it.
Compiling
Install prerequisites, choose targets and diagnostics, then build and install on Windows, Linux, or macOS.
Compilation guide →Debugging
Launch with the right working directory, debug engine and module code, capture logs, and use sanitizers.
Debugging guide →Libraries and versions
The versions of bundled dependencies, and when CMake selects system libraries instead.
Library inventory →Extend and contribute
Add features that other mods and players can rely on.
Feature flags
Advertise the optional client-side features your game module supports, without being detected as JA+ or jaPRO.
taystJKinfo spec →Contributing
Which branch to target, what CI builds, and how to test a fix from a PR artifact without compiling it yourself.
Contributing guide →In-game documentation
How a cvar documents itself inside the client, and how that relates to its registration description.
xdocs guide →Background
Where the code came from, and how this site is produced.
Code lineage
How TaystJK relates to OpenJK, EternalJK, jaPRO, JK2MV, NewJK, rend2, and the Vulkan work. Part of the console reference.
Source methodology →How this site is built
The pipeline that generates the console reference, what is generated versus hand-written, and how to add a page.
Documentation system →Last changed History Edit this page on GitHub