Use at least GCC 9 or Clang 10. MSVC is not supported.
Required:
- SDL2 (>=2.0.16): http://www.libsdl.org/download-2.0.php
- confuse: http://www.nongnu.org/confuse/
- Enet: http://enet.bespin.org/
- libargtable2 or libargtable3: http://argtable.sourceforge.net/ or http://www.argtable.org/
- libpng: http://www.libpng.org/pub/png/libpng.html
- zlib: http://www.zlib.net/ (for libpng)
- SDL2_Mixer (>=2.0.4): https://github.com/libsdl-org/SDL_mixer
- libxmp: https://github.com/cmatsuoka/libxmp
On Ubuntu, it is possible to pull the libraries using apt-get.
apt-get install cmake libargtable2-dev libcunit1-dev libsdl2-mixer-dev libconfuse-dev libenet-dev libsdl2-dev libxmp-dev libpng-dev libepoxy-dev
On Mac, you can use brew:
brew install cmake argtable cunit sdl2_mixer confuse enet sdl2 libxmp libpng libepoxy
Latest OpenOMF source can be acquired with the "git clone" command below.
git clone https://github.com/omf2097/openomf.git
To retrieve the latest source that compiles but will be out of date, see the releases section of OpenOMF project in GitHub.
To compile (change install prefix if necessary):
$ mkdir -p build
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local ..
$ make
$ make install
Some useful CMake flags:
| Flag | Description | Choices | Default |
|---|---|---|---|
| CMAKE_BUILD_TYPE | Chooses between build types | -/Debug/Release | - |
| CMAKE_INSTALL_PREFIX | Installation path | - | - |
| USE_TESTS | Enables unittests (dev only!) | On/Off | Off |
| USE_TOOLS | Enables format editor tools (dev only!) | On/Off | Off |
| USE_SANITIZERS | Enables asan and ubsan (dev only!) | On/Off | Off |
| USE_FORMAT | Enables clang-format (dev only!) | On/Off | Off |
| USE_TIDY | Enables clang-tidy (dev only!) | On/Off | Off |
Note that when USE_FORMAT is selected, you can run command "make clangformat" to run code formatter to the entire codebase.
OpenOMF loads the original data files from the original OMF:2097 game. Since One Must Fall 2079 is freeware, the files are obtainable for free from www.omf2097.com.
On Linux in debug mode, the OMF resource files should be put in resources/ subdirectory.
On Linux in release mode, the resources should be located in ../share/games/openomf/, relative to the openomf binary. So if your binary is in /usr/local/bin, the resources should be put in /usr/local/share/games/openomf/. With release or testing packages, the resources should be extracted to /usr/share/games/openomf/.
On MacOS and Windows, the resources should be put into the resources/ subdirectory.
You can override these default paths by setting the OPENOMF_RESOURCE_DIR environment variable to an absolute directory.