# RSOD

The RSOD engine is a free software FPS engine. To run the game, you will need the `game` folder from an official release on [Steam](https://store.steampowered.com/app/1827200/RSOD/) or [Itch](https://motorstripentertainment.itch.io/rsod). (Demo releases work fine.)

## Compiling

The engine has the following build-time dependencies.

* GNU/Linux
* GCC or Clang
* Make
* CMake
* Wget
* An Internet connection to automatically download additional dependencies
* MinGW-w64 (Windows builds only)
* GTK 3 development libraries (Linux builds only)
* SDL2's low-level dependencies (Linux builds only; see below)

If you have a system with `apt`, you can satisfy most of the requirements by running this:

`sudo apt install build-essential cmake wget libgtk-3-dev libsdl2-dev`

To build for GNU/Linux with dynamic SDL, run this:

`make`

To build for Windows, first install MinGW-w64 by running this:

`sudo apt install mingw-w64-i686-dev`

Then build for Windows by running this:

`make rsod-engine.exe`

If either of the above builds fail, try running `make bullet`, then attempt the build again.

## Building SDL2 (optional)

If you build `rsod-static` (only recommended when targeting Linux systems that lack SDL) the makefile builds a subset of SDL2 automatically. SDL2's build system checks for the presence of certain development libraries to determine which components to build. To install the necessary SDL2 dependencies on Ubuntu and Debian:

```
# Graphics
sudo apt install libegl1-mesa-dev libgl1-mesa-dev libgles2-mesa-dev libxrandr-dev libgtk-3-dev
# Sound and peripherals
sudo apt install libjack-dev libasound2-dev libpulse-dev libxi-dev libudev-dev
```

## Licensing

Except where otherwise stated, the RSOD engine is licensed under [CC0](https://creativecommons.org/publicdomain/zero/1.0/). This license does not cover game assets that are found outside of this codebase, such as 3D maps.

Some permissively-licensed code is included in the repository. The btrap* headers inherit the zlib license from Bullet. `wfcgen` includes code licensed under Apache 2.0, but it is not built into the engine distributed to end users. The OpenGL headers include code licensed under Apache 2.0, but it is well known that Khronos does not care about attribution of that code in particular. `SDL2.dll` is shipped to users, though it probably does not invoke additional licensing requirements.