⚠️ This repository has moved to: https://gitlab.com/mbitsnbites/resseract

Resseract is a first-person shooter game focused on instagib deathmatch and capture-the-flag gameplay as well as cooperative in-game map editing.

It is a fork of Tesseract, which in turn is a fork of Cube 2: Sauerbraten.

About

Documentation

In anticipation of proper Resseract documentation, please refer to the following relevant (but possibly dated) information:

• Game manual (from Cube 2: Sauerbraten)
• Tesseract introduction
• Tesseract rendering engine

Motivation

This fork aims to be more user friendly and game-like than its predecessor (Tesseract), which is quite technically oriented.

Furthermore, the code base is being cleaned up. For example:

• Use CMake instead of Make/VS/XCode.
• Use a more consistent and readable coding style (with the help of clang-format).
• Only the source code is included in the repo (no binaries).
• Data files are kept in a separate repository.
• The main documentation has been converted to Markdown.

Build instructions

1. Clone this repository:

git clone https://github.com/mbitsnbites/resseract.git
cd resseract
git submodule update --init --recursive

2. Build the game and tools according to the instructions below.

3. Run the game from the build folder:

./runclient.sh

Linux

Prerequisites

• A C++ compiler (typically GCC or clang)
• CMake
• ninja
• SDL2 developer files
• OpenGL developer files

Ubuntu users can install:

sudo apt install build-essential cmake ninja-build xorg-dev libgl1-mesa-dev libsdl2-mixer-dev libsdl2-image-dev

Build

Create a build-directory, preferrably in a different directory than the Resseract source (out-of-tree), and run CMake and ninja:

mkdir resseract-build
cd resseract-build
cmake -G Ninja -DCMAKE_BUILD_TYPE=Release path/to/resseract/src
ninja

macOS (experimental)

Prerequisites

• Xcode Command Line Tools (or Xcode).
• Using Homebrew, install CMake and ninja:

brew install cmake ninja

• Install SDL2 frameworks from:
  • SDL2-2.x.y.dmg
  • SDL2_mixer-2.x.y.dmg
  • SDL2_image-2.x.y.dmg

Build

Use CMake in the same way as for Linux.

Windows

Not tested.

License

From a licensing perspective, Resseract is divided into several different parts that use different licenses.

The game source code, found in the src/ folder, is released under the zlib/libpng license (as reproduced in LICENSE).

The game data, found in the data/ folder, is released under many different licenses, since it is a combination of many different works by different authors. For more information, see the data README.

Resseract also makes use of third party libraries (including ENet - see the ENet license), which may be released under different licenses.