Development Environment Setup

From OpenMW Wiki
Jump to: navigation, search

This page will describe how to set a dev env for several OSes.

You might also want to read the GitHub FAQ first.

Third-Party Libraries and Tools

  • OpenMW additionally uses the following tools:
    • CMake - used to manage the build process
    • Git - used as the source control management system

For those unfamiliar with Git, the Sphere RPG Engine group has a fairly useful short wiki page entitled "Git for the lazy". Make sure to also check out the GitHub FAQ.

General notes on dependencies

MyGUI

By default, MyGUI will build with the Ogre3D platform enabled, but this is not a hard dependency. If you do not want to have Ogre installed, then configure MyGUI with the dummy platform, and disable tools & demos:

cmake .. -DMYGUI_RENDERSYSTEM=1 -DMYGUI_BUILD_DEMOS=OFF -DMYGUI_BUILD_TOOLS=OFF -DMYGUI_BUILD_PLUGINS=OFF

OpenSceneGraph

For best OpenMW performance, we should configure OpenSceneGraph without double precision. Do not use a prebuilt OSG from a repository as these are generally built with double precision enabled.

cmake .. -DOSG_USE_FLOAT_MATRIX=ON -DOSG_USE_FLOAT_PLANE=ON

For a faster build, consider disabling the OSG examples and tools.

cmake .. -DOSG_USE_FLOAT_MATRIX=ON -DOSG_USE_FLOAT_PLANE=ON -DBUILD_OSG_APPLICATIONS=OFF -DBUILD_OSG_EXAMPLES=OFF

S3TC texture compression support

OpenMW requires S3TC texture compression support. If you are using a proprietary video driver, you will usually have S3TC support out of the box. With open-source drivers on Linux, you may need to install S3TC support separately. An indicator for missing S3TC support are white textures.

On Ubuntu:

sudo apt-get install libtxc-dxtn-s2tc0

Windows

Visual Studio 2008/2010/2012/2013

Tools

  • Visual Studio 2008/2010/2012/2013 - normal or free (C++) express versions. Note that if you use Visual Studio 2012 or newer you will have to build Qt yourself.
  • CMake: CMake at least v2.8, but grab the latest stable release.
  • Git - Our version control software: Git at least v1.8.x, but grab the latest stable release.

Libraries

(Needs updating, +osg)

  • Boost: Use the installer for your Visual Studio version and set the environment variable BOOST_ROOT to the <install_path>.
  • Bullet Download bullet and build the BulletCollision, BulletDynamics and LinearMath projects. Make sure the Runtime library is set to "Multi-threaded Debug DLL (/MDd)" or "Multi-threaded DLL (/MD)" for the debug and the release configuration, respectively. Also "Enable Run-Time Type Information" has to be set to "Yes (/GR)". Afterwards put the libraries into the <install_path\lib\Release> folder, strip the ending off (like _vs2010) and set the environment variables BULLET_ROOT to the <install_path>, and BULLET_INCLUDE_DIR to the <install_path\src> folder.
  • Freetype: Freetype2, and set the environment variables FREETYPE_DIR and MYGUI_DEPENDENCIES_DIR to the <install_path>.
  • MyGUI: Download and build following compilation instructions and set the MYGUI_HOME environment variable.
  • OpenAL: Download OpenAL11CoreSDK and set the environment variable OPENALDIR.
  • Qt. Download the latest Qt4 version for your Visual Studio version and install the environment variable QTDIR. Example: qt-win-opensource-4.8.4-vs2010.exe
  • msinttypes Download and extract to your visual studio 'install_root\VC\include' directory and overwrite the files there. This will give you C99 compliant inttypes. This is only required for building FFmpeg and not required for Visual Studio 2012 or later.
  • FFmpeg Download and extract the dev and shared of ffmpeg. The latest builds don't work. A known working version is commit 1eabd71, available in the "previous versions" links on that page. The environment variable is FFMPEG_HOME. (Note: A later build ffmpeg-20120914-git-8bdba0b-win64 appears to work ok with openmw-0.30 without crashing)
  • SDL2 Download and extract the SDL2 VS "Development Libraries". SDL2-devel-2.0.1-VC.zip Then set the SDL2_LIBRARY variable to the location of the SDL2.dll file.


Once this is done, you're ready to get the source code.

Download and install all of these and make sure the environment (the system and Cmake) knows where they are. If you develop under a non-admin account, use System variables rather than User variables (in Control Panel->System and Security->System->System Properties->Advanced (tab)->Environment Variables). Add the following, adjusted to the paths in your system:

BOOST_ROOT  D:\sdk\boost-1.55
BULLET_ROOT D:\sdk\bullet
FFMPEG_HOME D:\sdk\ffmpeg
MYGUI_HOME  D:\sdk\MyGUI_3.2.0
OPENALDIR   D:\sdk\OpenAL
QTDIR       D:\build\qt-4.8
SDL2DIR     D:\sdk\SDL2

Check that PATH includes the path to git.exe for CMakeGUI to find it.

Bullet libraries won't be found by CMake if you didn't put the built libraries manually into <BULLET_ROOT>\lib\Release\ as indicated above. Alternatively modify cmake\FindBullet.cmake to look for ${BULLET_ROOT}/lib.

Similarly, either set MYGUI_INCLUDE_DIRS and MYGUI_PLATFORM_INCLUDE_DIRS manually in CMakeGUI or modify cmake\FindMyGUI.cmake to look for ${MYGUISDK}/include/MYGUI.

Need to remove SDL2main.lib from VS->Properties->Configuration Properties->Linker->Additional Dependencies if you run into linking errors building owmlauncher. One way is to edit CMakeLists.txt so that SDL2_BUILDING_LIBRARY is set before running CMakeGUI. Another way is to set the SDL2_LIBRARY env variable instead of SDL2DIR as indicated above.

set(SDL2_BUILDING_LIBRARY ON)
find_package(SDL2 REQUIRED)

Running and using CMake

First, before opening Cmake, create a sibling directory called "OpenMW - build" next to the root "openmw" so that an out-of-source build can be done. This step is not needed if you're using CMakeGUI, as a separate build directory can be specified at the start.

 "<Cmake's Install Directory>\bin\cmake.exe" ..\openmw -G "Visual Studio 9 2008"

This will create a Visual Studio solution which you can use to compile OpenMW. (Hint: If you are building a debug version, add /bigobj to openmw project in VS->Properties->Configuration Properties->C/C++->Command Line->Additional Options)

Git on Windows

via Cygwin

Git is available on Windows via cygwin. Git can be used directly on Windows instead of grabbing source zip files from Github. The cygwin environment will allow you to use the same git command line commands as are recommended for the Linux environment. Note however that the cygwin version of CMake does not appear to support VS2008 as a valid target; therefore, cygwin can only be used for Git commands and a standard Windows command prompt should be used for invoking CMake.

via msysGit

There is also a stand-alone compiled package called msysgit. This will give you a Cygwin-like console with the git command, which you may find easier than via Cygwin.


via TortoiseGit

There is also a GUI git client for the one used to TortoiseSVN or TortoiseCVS which is called TortoiseGIT. It will give you a nice GUI inside the Windows explorer. This is the easy way.

via Eclipse

First of all, you need the egit plugin. Install it, restart eclipse, "file -> import -> git -> clone"

Linux

Installing Dependencies

Arch

There is a development package available for OpenMW on the AUR. It can be found at [1].

Information about building packages from the Arch User Repository (AUR) can be found at the Arch wiki.

Ubuntu

Key requirements

Because some dependencies of OpenMW are not in the Ubuntu repositories we made a development repository on Launchpad which provides packages for the missing dependencies.

To be able to install these packages you need to add the openmw Launchpad PPA by running:

sudo add-apt-repository ppa:openmw/openmw

and to make sure that the ppa will be used run:

sudo apt-get update

Packages

You will need g++ in order to compile OpenMW.

To setup a build environment and install all dependencies type:

 sudo apt-get install git libopenal-dev libopenscenegraph-dev \
 libsdl2-dev libqt4-dev libboost-filesystem-dev libboost-thread-dev \
 libboost-program-options-dev libboost-system-dev libav-tools \
 libavcodec-dev libavformat-dev libavutil-dev libswscale-dev libavresample-dev \
 libbullet-dev libmygui-dev libunshield-dev libtinyxml-dev cmake build-essential \
 libqt4-opengl-dev

Gentoo

All required dependencies, as well as an ebuild for OpenMW (games-engine/openmw) are available in the Portage tree. However to setup a development environment without emerging the OpenMW package, follow the steps below. Please note that this is a setup that worked, in other words: some use flags may be optional.

# make sure libsdl is compiled with the X and video USE flags
echo "media-libs/libsdl2 X video" >> /etc/portage/package.use
# make sure that the USE flags just set are applied if they need to
emerge -av --changed-use @world
 
# emerge dependencies, but don't pollute the world file which means that the 
# dependencies will not be updated when that's not needed
sudo emerge -av --oneshot dev-vcs/git ">=dev-games/mygui-3.2.2" \
">=dev-libs/boost-1.56.0-r1" dev-libs/tinyxml ">=dev-qt/qtcore-4.8.6-r2:4" \
">=dev-qt/qtgui-4.8.6-r4:4" media-libs/freetype:2 media-libs/libsdl2 \
media-libs/openal ">=sci-physics/bullet-2.80" virtual/ffmpeg \
dev-qt/qtxmlpatterns:4 app-arch/unshield virtual/pkgconfig

Starting with OpenMW-0.37 (including current git builds) openscenegraph is required.

# set use flags needed to build OSG
echo "dev-games/openscenegraph ffmpeg jpeg png qt4 sdl svg truetype zlib" >> /etc/portage/package.use
# build OSG
sudo emerge -av1 ">=dev-games/openscenegraph-3.2.1"

It should be possible now to build OpenMW using cmake or other tools.

In order to be able to build the documentation, execute

sudo emerge -av1 app-doc/doxygen media-gfx/graphviz

Fedora Workstation

Key requirements

Because some dependencies of OpenMW are not in the Fedora Workstation repositories, you need to enable RPMFusion free and non-free repositories which provide packages for the missing dependencies.

Packages

You will need g++ in order to compile OpenMW.

To setup a build environment and install all dependencies type:

sudo dnf groupinstall development-tools; 
sudo dnf install openal-devel OpenSceneGraph-qt-devel SDL2-devel qt4-devel \
boost-filesystem git boost-thread boost-program-options boost-system ffmpeg-devel \
ffmpeg-libs bullet-devel gcc-c++ mygui-devel unshield-devel tinyxml-devel cmake

Fetching the source

Download the source from the main downloads page: [2], or get the latest git snapshot:

 git clone git://github.com/OpenMW/openmw.git
 
 cd openmw

Building

With make

Note that this is an out-of-source build. Generally, this is the preferred method when working with cmake.

 mkdir build
 cd build
 cmake ../

This creates a regular makefile.

Now we can start compiling. Normally you can just run

make

but if you have multiple cores, you can decrease your compile time by doing this:

make -j`getconf _NPROCESSORS_ONLN`

With codeblocks

If you want to create a Code::Blocks project instead, use these lines:

 mkdir build
 cd build
 cmake -G "CodeBlocks - Unix Makefiles" ../openmw/

Please note, that the Code::Blocks generator only generates a makefile with a Code::Blocks wrapper.

With Kdevelop

Kdevelop4 is very nice, easy-to-use and modern IDE. After getting source, just open Kdevelop and click "Project -> Open/Import Project..." and show path to code (.../OpenMW/openmw). You will have to choose build folder.

For building click on button "Build Selection". For running click "Execute". Running first time "Launch Configurations" will pop up. You have to set executable file by selecting "openmw", clicking "+" and choosing "openmw/apps/openmw/openmw" as "Project Target".

OS X

Prerequisites

You must have recent version (4.6.3 or higher) of Xcode & Xcode command line tools. Xcode command line tools can be enough but I'm not sure. Older versions are untested.

Miminal OS X version is determined by minimal Xcode version.

If you're planning to use our homebrew repo for installing dependencies, homebrew is required too, obviously.

Note: this manual assumes that you're using default homebrew prefix (/usr/local). Fix paths where appropriate if you don't.

Dependencies

You will need the following libraries to build OpenMW (Semantic Versioning is used for version numbers):

(Needs updating, +osg)

  • boost ??? (1.48-1.55 are all fine though)
  • Bullet ~> 2.80 (earlier versions could work, but I haven't tested it myself)
  • ffmpeg ~> 1.2.4
  • MyGUI ~> 3.2.0
  • SDL ~> 2.0
  • unshield ~> 0.6

Build tools:

  • CMake. Not sure about version, 2.8.12.2 is fine
  • pkg-config. Recent version from homebrew is okay.

Most of the dependencies can be installed from our homebrew repo. Here we go:

$ brew tap openmw/openmw
$ brew install cmake pkg-config openmw-mygui openmw-bullet openmw-sdl2 openmw-ffmpeg unshield

boost will be installed as dependency.

Keep in mind that if you have already installed boost, bullet, sdl2 or ffmpeg from homebrew default repo, you'll have conflicts. I don't have any solution for that yet, sorry.

Qt

Note that you can install Qt from homebrew too but we previously had some issues with deploying OpenMW binaries built against homebrewed Qt.

$ brew install qt

It's recommended to use Qt SDK from Qt Project site, especially if you're planning to deploy your builds to users since homebrewed Qt has some issues when deployed on older OS X versions. Just download package and install.

Build

First of all you'll need to clone OpenMW source code, either from our main repository or from your fork:

$ git clone https://github.com/OpenMW/openmw.git

Then you can cd into source directory and look around. Please note that out-of-source build is recommended:

$ mkdir build
$ cd build

I assume that openmw & build directories are siblings. Call CMake:

$ cmake \
    -D CMAKE_C_COMPILER=$(xcrun -find clang) \
    -D CMAKE_CXX_COMPILER=$(xcrun -find clang++) \
    -D CMAKE_OSX_SYSROOT="macosx10.9" \
    -D CMAKE_OSX_ARCHITECTURES="x86_64" \
    -D CMAKE_FRAMEWORK_PATH="/usr/local/lib/macosx/Release" \
    -D CMAKE_EXE_LINKER_FLAGS="-F/usr/local/lib/macosx/Release" \
    -D CMAKE_CXX_FLAGS="-stdlib=libstdc++" \
    -D CMAKE_BUILD_TYPE=Debug \
    -G"Unix Makefiles" \
    ../openmw/

Linker flags & CMake framework path should be tuned because Ogre.framework is located in /usr/local/lib/macosx/Release, not just in /usr/local/lib.

Compiler flags should be tuned to set required C++ standard library explicitly, because otherwise compiler will assume libc++ (if deployment target >= 10.9 and OS X version is >= 10.9) and libstdc++ (on older OS X version or if deployment target < 10.9). Alternatively you can specify deployment target (like in release build later), but I don't see any point in setting deployment target for local debug build.

Then build:

$ make

And try:

$ open OpenMW.app
$ open OpenMW-CS.app

Or run binaries directly to see their output:

$ OpenMW.app/Contents/MacOS/openmw-launcher
$ OpenMW.app/Contents/MacOS/openmw
$ OpenMW-CS.app/Contents/MacOS/openmw-cs

Deployment

If you want to make a release build and deploy it, you must set CMake variable OPENMW_OSX_DEPLOYMENT to TRUE:

$ cmake \
    -D CMAKE_C_COMPILER=$(xcrun -find clang) \
    -D CMAKE_CXX_COMPILER=$(xcrun -find clang++) \
    -D CMAKE_OSX_SYSROOT="macosx10.9" \
    -D CMAKE_OSX_ARCHITECTURES="x86_64" \
    -D CMAKE_OSX_DEPLOYMENT_TARGET="10.6" \
    -D CMAKE_FRAMEWORK_PATH="/usr/local/lib/macosx/Release" \
    -D CMAKE_EXE_LINKER_FLAGS="-F/usr/local/lib/macosx/Release" \
    -D CMAKE_BUILD_TYPE=Release \
    -D OPENMW_OSX_DEPLOYMENT=TRUE \
    -D BUILD_ESMTOOL=FALSE \
    -G"Unix Makefiles" ../openmw/

Please note that esmtool is not needed in release builds.

Build & package:

$ make package

After this command completes, you'll have a *.dmg file in current directory. You can publish this file as OpenMW release, send it to your friend, etc.

Note that if you'll try to launch release versions of OpenMW.app or OpenMW-CS.app directrly from build directory they won't work, because they're built in deployment configuration when all dependencies are expected to be inside application bundle, but they're not until everything is packed in *.dmg.

Troubleshooting

If you experiencing configuration or build errors, or just in doubt, please refer to our Travis CI build script, it's proven to be working and should help you setup build environment on almost any compatible Mac with OS X 10.9 or higher (older versions could work too, but we're unable to test on them).

Umbrella script: https://github.com/OpenMW/openmw/blob/master/.travis.yml

Dependency setup: https://github.com/OpenMW/openmw/blob/master/CI/before_install.osx.sh

Build: https://github.com/OpenMW/openmw/blob/master/CI/before_script.osx.sh

Eclipse

You have to use the C/C++ version of Eclipse, that you can download here

Git within Eclipse

If you want to use Eclipse as Git explorer:

  1. From the project explorer, right click, and select "Import..."
  2. Select "Git / Projects from Git"
  3. Click "Next"
  4. Select "Local"
  5. Click "Next"
  6. "Add..." / "Browse", and select openmw's directory
  7. Click "Next"
  8. Select "Use the new project wizard", and "Finish".

Import the project

Select "C/C++ / Makefile project with existing code" as project type. In "Existing code location", click browse, and again,select openmw's folder. Also select "Linux GCC" as toolchain, then click "Finish".

Now right-click on your project, and select "Properties". Go to "C/C++ build", uncheck "use default build command", and specify your command, like

make -j 4 -C ${ProjDirPath}../build

Note: Replace this example with your actual build command! Choose the -j flag based on the amount of effective CPU cores your system has available.

Now you should be able to build openmw.

Fix includes

To fix includes (Eclipse complaining about Bullet, SDL and MyGUI), go to project properties, "C/C++ General", "Paths and symbols", select "GNU C++".

Click the "add" button to add the following paths :

/usr/include/bullet

/usr/include/SDL2

/usr/include/MyGUI

Run

To run it, create a new Run configuration. Select openmw as project, and click "search project" to find the executable (../build/openmw). Then go to the Arguments panel and uncheck "Use default" for working directory, and type in : "${workspace_loc:openmw}../build"

Apply, and you should now be able to run openmw !

Data

For a detailed description of how to obtain the data files check Getting_Data_Files_for_Linux_Install.