Skip to content

1. Installation

Dr Power edited this page May 29, 2024 · 6 revisions

Download

Download the latest copy of the game from Releases.

Build from Source

CMake

Download and install CMake.

For Raspberry Pi OS, a Snapcraft installation is probably the easiest approach; Or, you could try from source.

GCC & G++

For Linux platforms, these should come pre-installed. If not, run:

sudo apt install build-essential

For Windows, consider using Cygwin or WinLibs.

Ninja

Download from here.

On Linux, it should be as easy as:

sudo apt install ninja-build

Build

Download the source code of the latest release and unzip.

Then, go into the directory.

cd Path\To\caravan\
  1. Use CMake to create build directory.
cmake -S . -B build -G Ninja -D CMAKE_C_COMPILER=gcc -D CMAKE_CXX_COMPILER=g++ -DCMAKE_BUILD_TYPE=Release

Finally, create the executable caravan (or caravan.exe) for Windows.

cmake --build build --config Release --target caravan

The executable can be found at: build/caravan or build/caravan.exe.

Note

In my experience, the Windows caravan.exe executable sometimes gets labelled as a "virus" by Windows Defender. You may need to add it to your anti-virus' exclusions list if this is the case.

Run the command with:

./caravan

Or, for Windows:

.\caravan.exe

Tests

To run unit tests locally, build tests executable.

cmake --build build --config Release --target tests

Then run tests.

cd build
ctest --output-on-failure
Clone this wiki locally