Jazz² Resurrection
This is an API documentation for Jazz² Resurrection. For user documentation, please visit project homepage. Additionaly, the project is hosted on https:/
Jazz² Resurrection is reimplementation of the game Jazz Jackrabbit 2 released in 1998. Supports various versions of the game (Shareware Demo, Holiday Hare '98, The Secret Files and Christmas Chronicles). Also, it partially supports some features of JJ2+ extension and MLLE. Online multiplayer and scripting support (AngelScript) is currently in development, everything else is already fully implemented.
To get in touch with the developers and the community, you can use the official Discord server.
For getting started guide, see Building the project. For game-specific API documentation, see Jazz2 namespace. For common utility functions and generic containers, see the shared root namespace. In addition, CommonBase.h contains common configuration-specific and platform-specific definitions. For nCine game engine documentation, see nCine namespace. The nCine game engine used in this game has been extensively modified, so the original documentation no longer matches the current implementation.
Supported platforms
- Android
- FreeBSD
- Linux and other Unix-like systems
- macOS
- Windows
- Nintendo Switch using devkitPro toolchain
- Xbox (Universal Windows Platform) using ANGLE/Mesa
- Web (WebAssembly) using Emscripten
The code is mainly optimized to run on 64-bit x86 and ARM processors including advanced instruction sets. Additionally, OpenGL 3.0, OpenGL|ES 3.0 or WebGL 2.0 is required to run the application. However, Google ANGLE or Mesa can be used to translate OpenGL calls to the native graphics API. See also the list of partially supported features that depend on specific platforms.
License
This project is licensed under the terms of the GNU General Public License v3.0. See also Third-party components for the licenses of the libraries used.