TaystJK

TaystJK

TaystJK is a Jedi Academy multiplayer client and dedicated server built on EternalJK, which is built on OpenJK and jaPRO. It focuses on compatibility across Base JKA, JA+, jaPRO, and Lugormod servers, engine stability and performance, and improvements to everyday play.

Download the latest build · Documentation and wiki

When you join a server, its game module determines the gameplay and which mod-specific features are available.

Getting started

You need a copy of Jedi Academy and its retail base/assets0.pk3 through base/assets3.pk3 files.

1. Download the latest build for your operating system and architecture, and extract the whole archive into a writable directory.
2. Copy the game's base directory beside the TaystJK executable or macOS app bundle, or point TaystJK at an existing installation with fs_cdPath as described in the installation guide.
3. Launch the TaystJK executable or app included in the archive.

Follow the installation guide for platform prerequisites, launch commands, and layouts for sharing game files between clients.

Documentation

The documentation site contains the setup guides, feature explanations, and a searchable console reference generated from the source code.

Guide	What it covers
Installation	Platform setup, build choices, game files, and mod compatibility.
Server hosting	Dedicated servers, Docker Compose, bundled game modes, and PK3 downloads.
Features	HUD and movement tools, renderers, cosmetics, scripting, and what's new.
Console reference	Cvars and commands, defaults, options, module and renderer scope, and source links.
Development	Compilation, debugging, libraries, and contributing.
Help	Troubleshooting, the glossary, and where to report problems.

Development and contributions

TaystJK uses CMake. Start with the compilation guide and debugging guide for this project's build options and platform instructions.

Fork the repository, make your changes on a branch, and open a pull request against master unless asked otherwise. The contributing guide covers review, CI builds, and documenting changes.

The documentation site lives on the gh-pages branch. See how the site is built before editing guides or regenerating the reference.

Maintainer and upstream projects

Maintained by tayst.

TaystJK incorporates work from OpenJK, jaPRO, EternalJK, SomaZ's rend2, and JKSunny's Vulkan renderer, among other community projects.

License

TaystJK is free software licensed under GPLv2. You may use, modify, and redistribute it under the terms in LICENSE.txt.