BUILD.md

How to build Otto Matic

How to build the game on Windows

1. Install the prerequisites:
   • Visual Studio 2019 with the C++ toolchain
   • CMake 3.20+
2. Clone the repo recursively:

   git clone --recurse-submodules https://github.com/fordcars/OttoMatic-VR
   

3. Download SDL2-devel-2.0.16-VC.zip and extract the contents into the extern folder
4. Download OpenVR SDK 1.16.8 and extract the contents into the extern folder.
5. Prep the Visual Studio solution:

   cmake -G "Visual Studio 16 2019" -A x64 -S . -B build
   

6. Now you can open build/OttoMatic.sln in Visual Studio, or you can just go ahead and build the game:

   cmake --build build --config Release
   

7. The game gets built in build/Release/OttoMatic.exe. Enjoy!

How to build the game on Linux et al.

1. Install the prerequisites from your package manager:
   • Any C++20 compiler
   • CMake 3.13+
   • SDL2 development library (e.g. "libsdl2-dev" on Ubuntu, "sdl2" on Arch, "SDL-devel" on Fedora)
   • OpenGL development libraries (e.g. "libgl1-mesa-dev" on Ubuntu)
2. Clone the repo recursively:

   git clone --recurse-submodules https://github.com/fordcars/OttoMatic-VR
   

3. Build the game:

   cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
   cmake --build build
   

4. The game gets built in build/Release/OttoMatic. Enjoy!

TL;DR: Automated build script (not tested for VR for now)

Clone the repo recursively, then run python3 build.py to execute the build steps described in this document and package up the game.

build.py is the script that is used by the CI setup to produce builds. If you want to build the game manually instead, read on.