rs4

How to build and run

1. Clone git repository and update submodules

   • all operating systems:

     git clone https://github.com/dp304/rs4.git
     cd rs4
     git submodule update --init --recursive

2. Install C++17 compatible compiler and CMake >=3.10.2 (and libtool)

   • Debian/Ubuntu:

     sudo apt-get update
     # g++ >=7 should work
     # libtool is possibly needed for building dependencies
     sudo apt-get install g++ cmake libtool

   • Windows:

     • Install Visual Studio 2019 Community

       • MinGW g++ (>=7) might also work instead of VS

     • Install the latest stable CMake

       • Select "Add CMake to the system PATH" (for current user or all users) at installation

3. Install Conan

   • Installing with pip is recommended

     • Debian/Ubuntu: get Python 3 and pip

       sudo apt-get install python3-pip

     • Windows: install the latest Python, which comes with pip

       • Select "Add Python 3.x to PATH" at installation

   • all operating systems: install Conan with pip

     # optionally create and activate a venv:
     # python3 -m venv ./venv
     # . ./venv/bin/activate
     pip3 install conan

4. Set up Conan

   • all operating systems:

     # generate default profile:
     conan profile new default --detect
     # only if using gcc: set libcxx to C++11 ABI:
     conan profile update settings.compiler.libcxx=libstdc++11 default
     # add bincrafters repository:
     conan remote add bincrafters https://api.bintray.com/conan/bincrafters/public-conan

5. Install dependencies

   • all operating systems:

     mkdir build
     cd build
     conan install .. --build=missing

6. Build

   • all operating systems:

     cmake ..
     cmake --build .

7. Copy data directory (not included) to directory of binary

   • Linux:

     cd src/bin
     cp -rp <path_to_data_dir>/data .

   • Windows:

     cd src\bin
     xcopy <path_to_data_dir>\data .\data /I /E /K /H

8. Run

   • Linux:

     ./rs4game

   • Windows:

     rs4game.exe

9. Have fun!

Dependencies

• SDL2
• OpenAL Soft
• GLEW
• GLM
• Vorbis
• Nuklear (no Conan package)
• stb
• EnTT