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, including story episodes fully playable in cooperation, is already 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 — and Building for consoles for the console targets. 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
- Xbox (Universal Windows Platform) using ANGLE/Mesa
- Web (WebAssembly) using Emscripten
- Nintendo Switch using devkitPro toolchain, see Nintendo Switch
- Nintendo Wii and Nintendo GameCube using devkitPro toolchain and a fixed-function GX rendering backend, see Nintendo Wii and Nintendo GameCube
- Sega Dreamcast using KallistiOS and a fixed-function PowerVR rendering backend, see Sega Dreamcast
- PlayStation Portable using pspdev and a fixed-function GU rendering backend, see PlayStation Portable
- PlayStation Vita using VitaSDK and vitaGL, see PS Vita
- libretro core for RetroArch, see Libretro core
The code is mainly optimized to run on 64-bit x86 and ARM processors including advanced instruction sets. Additionally, OpenGL 3.3, OpenGL|ES 3.0 or WebGL 2.0 is usually required to run the application — Google ANGLE or Mesa can be used to translate OpenGL calls to the native graphics API, and Direct3D 11, Vulkan and a CPU software rasterizer are available as alternative rendering backends. The consoles above are the exception: four of them have no programmable shaders at all and are driven by a rendering backend written for their fixed-function graphics hardware. See also the list of features each consolesupports, which is where the platform differences are the largest.
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.