Skip to content

Usage Instructions

Jump to bottom
Mikko Kortelainen edited this page Jul 14, 2015 · 9 revisions

#Source code

##Git repository Git is recommended tool to be used, the zip files are hard to work with as we use submodules

git clone https://github.com/OpenTechEngine/OpenTechBFG.git

##Branch Our current work-in-progress branch is cegui_layout, switching to that

git checkout cegui_layout

##Submodules We use git submodules to git-link other git repositories in to our master. This allows us to have clean cut between our own work and the library providers, still we are able to package the whole engine and it's dependencies as a one.

git submodule init

git submodule update

#Compiling

##Windows

###WIN32 VISUAL C++ 2013 EXPRESS EDITION

  1. Download and install the Visual C++ 2013 Express Edition.

  2. Download the DirectX SDK (June 2010)

  3. Download and install the latest CMake

  4. Generate the VC13 projects using CMake by double-clicking a matching .bat file in the scripts/ directory.

  5. Use the VC13 solution to compile what you need: OpenTechEngine/build/OpenTechEngine.sln

Videos 6. Download ffmpeg-20140405-git-ec8789a-win32-shared.7z from ffmpeg.zeranoe.com/builds/win32/shared

  1. Extract the FFmpeg DLLs to your current build directory under OpenTechEngine/build/

##GNU/Linux

###Dependencies Fedora

yum install cmake SDL-devel openal-devel gcc-c++ freetype-devel

TODO add ffmpeg libs for bink videos

###Dependencies Debian/Ubuntu

apt-get install cmake libsdl1.2-dev libopenal-dev libavcodec-dev libavformat-dev libavutil-dev libswscale-dev freetype-dev

TODO SDL2, g++

###Dependencies OpenSUSE (tested in 13.1)

zypper in openal-soft-devel cmake libSDL-devel libffmpeg1-devel freetype-devel

For SDL 2 replace "libSDL-devel" with "libSDL2-devel". "libffmpeg1-devel" requires the PackMan repository. If you don't have that repo, and don't want to add it, remove the "libffmpeg1-devel" option and compile without ffmpeg support.

If you have the repo and compiles with ffmpeg support, make sure you download "libffmpeg1-devel", and not "libffmpeg-devel".

###Compiling

About SDL Instead of SDL1.2 development files you can also use SDL2. Install SDL 2.0 and add to the cmake parameters -DSDL2=ON

SDL2 has better input support (especially in the console) and better support for multiple displays (especially in fullscreen mode).

  1. Generate the Makefiles using CMake:

    cd scripts/

    ./cmake-eclipse-linux-profile.sh

  2. Compile OpenTechEngine targets with

    cd ../build

    make

###Cross-compiling Mingw is used on our build automation system to deliver windows binaries on Ubuntu Trusty. It's also tested to work on Fedora 20.

apt-get install g++-mingw-w64-x86-64

mkdir -p build

cd build

cmake -G "Eclipse CDT4 - Unix Makefiles" -DCMAKE_TOOLCHAIN_FILE=../scripts/mingw32.toolchain.cmake -DCMAKE_BUILD_TYPE=Debug -DSDL2=OFF -DBUNDLED_FREETYPE=ON -DBUNDLED_OPENAL=ON ../

make

###Automated Builds We use travis-ci for continuous integration, all our branch should build and there is a sticker on the front page indicating the status.

See more at [Workflow Automation](Workflow Automation)

Clone this wiki locally