Skip to content
davido262 edited this page Dec 11, 2012 · 30 revisions

The project should compile under Linux, Windows and Mac without problems. The following Operating Systems are the ones which have been tested, but installation instructions should not differ too much. If you are testing in another one, please feel free to document the steps required in the same format and send them (credit will be given).

Arch Linux

1. Make sure development software is installed

# pacman -S gcc make cmake git

2. Install dependencies

# pacman -S boost sdl sdl_image glew bullet assimp

3. Download from GitHub repository

Navigate to the folder the source code will be downloaded

$ git clone https://github.com/davido262/shoggoth-engine.git

4. Compile and install project

Navigate to the folder where the build will be compiled (preferably outside the source). A typical installation might be like this:

$ cd ..
$ mkdir shoggoth-engine-build
$ cd shoggoth-engine-build
$ cmake ../shoggoth-engine -G "Unix Makefiles"
# make install

Fedora

Note: for some reason it does not detect ASSIMP in Fedora, so compilation will not work for the moment

1. Make sure development software is installed

# yum install make cmake git

2. Install dependencies

# yum install boost-devel SDL-devel SDL_image-devel glew-devel bullet-devel assimp-devel

3. Download from GitHub repository

Navigate to the folder the source code will be downloaded

$ git clone https://github.com/davido262/shoggoth-engine.git

4. Compile and install project

Navigate to the folder where the build will be compiled (preferably outside the source). A typical installation might be like this:

$ cd ..
$ mkdir shoggoth-engine-build
$ cd shoggoth-engine-build
$ cmake ../shoggoth-engine -G "Unix Makefiles"
# make install

OpenSUSE

1. Make sure development software is installed

# zypper install gcc-g++ make cmake git

2. Install dependencies

# zypper install boost-devel libSDL-devel libSDL_image-devel glew-devel

2.1 Install Bullet Physics

Navigate to the folder where the build will be compiled (preferably outside the source)

$ cmake ../bullet-trunk-rev2600 -G "Unix Makefiles" -DBUILD_EXTRAS=off -DBUILD_DEMOS=off -DINSTALL_LIBS=on
# make install

2.2 Install Open Asset Import Library

Navigate to the folder where the build will be compiled (preferably outside the source)

$ cmake ../assimp--3.0.1270-source-only -G "Unix Makefiles" -DBUILD_ASSIMP_SAMPLES=off
# make install

3. Download from GitHub repository

Navigate to the folder the source code will be downloaded

$ git clone https://github.com/davido262/shoggoth-engine.git

4. Compile and install project

Navigate to the folder where the build will be compiled (preferably outside the source). A typical installation might be like this:

$ cd ..
$ mkdir shoggoth-engine-build
$ cd shoggoth-engine-build
$ cmake ../shoggoth-engine -G "Unix Makefiles"
# make install

Windows

NOTE: not officially supported yet, but should work

1. Make sure development software is installed

2. Install dependencies

You will have to download and copy the include header files and libraries to your Visual C++ directory.

2.1 First download and extract/install precompiled libraries

  • Boost: get the newest and install
  • SDL: get the Development Libraries for windows VC++ and extract
  • SDL_image: get the Binaries development for windows and extract
  • GLEW: get the Binaries for windows and extract
  • ASSIMP: get the newest, you can choose to download the "source" and compile it with CMake or download the "full" which already comes with the binaries

2.2 Install Bullet Physics

Navigate to the folder where the build will be compiled (preferably outside the source), or optionally use Cmake-GUI. For the rev2600 a command to create the Visual Studio 2010 project might look like this:

"C:\Program Files\CMake 2.8\bin\cmake.exe" ..\bullet-trunk-rev2600 -G "Visual Studio 10" -DBUILD_EXTRAS=off -DBUILD_DEMOS=off -DINSTALL_LIBS=on

Once created the project, open it wit Visual C++ and compile it.

2.3 Copy include files and libraries to VC++ directory

Inside every library downloaded or compiled, there is one or more of the following folders: bin, include and lib. Copy the contents of the folders from each library and paste them into the VC++ directory (in some libraries you might need to navigate more folders to select the version that fits your OS and compiler). In a default installation it will be: C:\Program Files\Microsoft Visual Studio 10.0\VC. Note that if you do not see a bin, include and lib folder it might be a wrong path. Once the folders are merged, the hard part should be done.

2.4 Configure the CMAKE_PREFIX_PATH environment variable

In Windows 7 go to Control Panel -> System and Security -> System -> Advanced system settings -> Advanced -> Environment Variables. Add a new variable with variable name CMAKE_PREFIX_PATH and in the value copy the path to the Visual C++ library path, by default C:\Program Files\Microsoft Visual Studio 10.0\VC for Visual C++ 2010.

3. Download from GitHub repository

At the main page of the project you should see a button to download it as a Zip file. Once downloaded you should extract it.

4. Compile and install project

Navigate to the folder where the build will be compiled (preferably outside the source), or optionally use Cmake-GUI. A command to create the Visual Studio 2010 project might look like this:

"C:\Program Files\CMake 2.8\bin\cmake.exe" ..\shoggoth-engine -G "Visual Studio 10"

Once created the project, open it wit Visual C++ and compile it.