Skip to content

Latest commit

 

History

History
125 lines (91 loc) · 3.63 KB

COMPILE.md

File metadata and controls

125 lines (91 loc) · 3.63 KB
Raw

Compile Guide for GlPortal

Build with Visual Studio (optional)

If you want to compile with Visual Studio please have a look at compile instructions for VS. Building is only possible in Visual Studio 2017, as earlier versions do not support the requied C++14 language features.

Dependencies

NOTE: Dependencies will change all the time so watch the cmake output for missing libraries. Make sure to check CMakeLists.txt if something is missing.

Satisfy the Radix dependencies from the RadixEngine compile instructions first. The instructions cover how to upgrade your system and how to install most of the dependencies.

Follow these instructions until Installing dependencies.

Downloading source code

In your favorite console, run these commands:

git clone https://github.com/GlPortal/glPortal.git
cd glPortal
git submodule update --init --recursive

Building the binary

Make sure to check the README.md and COMPILE.md from the release you downloaded in case there are differences in the compile workflow for it.

Setting up the build directory

In the root directory of the downloaded source type:

Linux

cmake ./;

Windows

mkdir build && cd build
cmake .. -G "MSYS Makefiles" -DCMAKE_MAKE_PROGRAM="mingw32-make"

Mac OS X

brew install Assimp SDL2 SDL2_mixer TinyXML2 Bullet freeimage
cmake ./;

If you want to profile the source code pass -DCMAKE_CXX_FLAGS=-pg to cmake.

If you encounter an error during this step use the bugtracker https://github.com/GlPortal/glPortal/issues to report an issue.

If the command did not produce an error, you can build the binary by typing in:

Building

Linux

make

Windows

mingw32-make

Mac OS X

make

Running

If this produces no error you have built the binary and should be able to start GlPortal by typing in:

Linux

make run

Windows

Before we can start the game it is necessary to copy some dlls into our executable directory.

on 32-bit
cp /mingw32/bin/{libLinearMath,SDL2{,_mixer},libtinyxml2,libgcc_s_dw2-1,libstdc++-6,libmodplug-1,libvorbisfile-3,libvorbis-0,libogg-0,libassimp,libBulletCollision,libBulletDynamics,libepoxy-0,libwinpthread-1,libfluidsynth-1,libminizip-1,zlib1,libFLAC-8,libmad-0,libbz2-1,libglib-2.0-0,libportaudio-2,libsndfile-1,libintl-8,libspeex-1,libvorbisenc-2,libiconv-2}.dll source
on 64-bit
cp /mingw64/bin/{libLinearMath,SDL2{,_mixer},libtinyxml2,libgcc_s_seh-1,libstdc++-6,libmodplug-1,libvorbisfile-3,libvorbis-0,libogg-0,libassimp,libBulletCollision,libBulletDynamics,libepoxy-0,libwinpthread-1,libfluidsynth-1,libminizip-1,zlib1,libFLAC-8,libmad-0,libbz2-1,libglib-2.0-0,libportaudio-2,libsndfile-1,libintl-8,libspeex-1,libvorbisenc-2,libiconv-2,libpcre-1}.dll source
Run
mingw32-make run

Mac OS X

make run

If you get errors, try to build GlPortal again. If you don't manage to fix the error, use the bugtracker https://github.com/GlPortal/glPortal/issues or http://bugs.glportal.de to report what you did, and what error you got.

Build with docker

Building with docker is still in early testing and not feature complete. It will make compiling easier in the future.

docker run -it --rm -w /data -v $(pwd):/data glportal/gcc bash -c "cmake ./; make"

To run the game type:

source/glportal --datadir ./data

Keep us posted

Not working? No worries! Help us help you figure out what we missed to make this work on your system by opening an issue.