# OpenOMF Installation

### Dependencies

Use at least GCC 9 or Clang 10. MSVC is also supported, namely the version that ships with VS2022's (or higher) Build Tools.

Required:
* SDL2 (>=2.0.16): http://www.libsdl.org/download-2.0.php
* confuse: http://www.nongnu.org/confuse/
* Enet: http://enet.bespin.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
* opusfile: https://github.com/xiph/opusfile


On Windows, a `vcpkg` installation is required. In turn, `vcpkg` can be used in Manifest mode to pull the required dependencies.
Replace `C:\vcpkg` with a directory of your choice, if needed.

```
git clone https://github.com/microsoft/vcpkg.git C:\vcpkg
C:\vcpkg\bootstrap-vcpkg.bat
```

On Ubuntu, it is possible to pull the libraries using apt-get.
```
apt-get install cmake libcunit1-dev libsdl2-mixer-dev libconfuse-dev libenet-dev libsdl2-dev libxmp-dev libpng-dev libopusfile-dev libepoxy-dev libminiupnpc-dev libnatpmp-dev
```

On Mac, you can use brew:
```
brew install cmake cunit sdl2_mixer confuse enet sdl2 libxmp libpng opusfile libepoxy
```

### Acquiring the sources

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](https://github.com/omf2097/openomf/releases) section of OpenOMF
project in GitHub.

### Compiling

To compile on Windows, use the "x64 Native Tools Command Prompt for VS":

```
cd C:\path\to\openomf
cmake -B build -S . --toolchain C:\vcpkg\scripts\buildsystems\vcpkg.cmake
cmake --build build
```

To compile on other operating systems (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.

## Data Files

OpenOMF loads the original data files from the original OMF:2097 game.
Since One Must Fall 2097 is freeware, the files are obtainable for free from
[www.omf2097.com](https://www.omf2097.com/pub/files/omf/openomf-assets.zip).

For resource directory structure, see [PATHS.md](PATHS.md).