Skip to main content

History: Prerequisites

Preview of version: 56

prerequisites.jpg

What you need to build Ogre from source.

Introduction

This is a small check list of things you need to do before you're ready to build Ogre from source.


Image

Done Compiler Specific Prerequisites

Done Visual Studio

You need the latest service packs for your version of Visual Studio:
Visual Studio 2008 (VC9) Service pack 1 and the ATL security fix (available from Microsoft Update).
Visual Studio 2005 (VC8) Service pack 1


Visual Studio Express users should install the latest Express edition as separate service pack installs for those aren't available.
Get it from http://www.microsoft.com/express/Downloads/.


-

Done MinGW

You need to grab the latest MinGW GCC from Twilight Dragon Media:
http://www.tdragon.net/recentgcc/
At this time of writing, it's tdm-mingw-1.908.0-4.4.1-2, based on GCC 4.4.1.
The official MinGW won't do. It must be based on GCC 4.4.x.
Install it to C:\mingw and add C:\mingw\bin to your PATH.


-

Done DirectX SDK

You need to install the DirectX SDK if you intend to build and use the Direct3D render systems and/or OIS (for the samples).
The DirectX SDK - February 2010 would be an excellent choice, as both Visual Studio and MinGW builds successfully against it.

When installed, it should have registered an environment variable called DXSDK_DIR.
You can check this by running set DXSDK_DIR in a command prompt:
Copy to clipboard
C:\>set DXSDK_DIR DXSDK_DIR=C:\Program Files\Microsoft DirectX SDK (February 2010)\

If the environment variable DXSDK_DIR isn't present or set, you need to set it as CMake depends on it for finding DirectX.


-

Done Boost

Boost is not required to build Ogre - it's optional. 😊
The Boost Threads library is used by the paging component, which in turn is used by the terrain component, enabling background loading and thus faster response times.
It's recommended to get Boost 1.42.0.
Lucky users of Visual Studio 2003 - 2008 can use the Boostpro Boost Installers. Be sure to install Boost Date Time and Boost Thread.
Users of Visual Studio 2010 and MinGW need to build Boost from source.
Get Boost 1.42.0 from www.boost.org and the bjam executable as detailed on the Boost compile page.
This line builds Boost date_time and thread using VC10:
Copy to clipboard
bjam --build-dir="C:\boost-vc10" toolset=msvc-10.0 --build-type=complete --with-date_time --with-thread

Info Use the Visual Studio Command Prompt when issuing the command.
When done building, move the contents of build_dir/stage/lib to boost_dir/lib.

CMake depends on the following environment variables to find Boost succesfully:
BOOST_ROOT (C:\Program Files\boost\boost_1_42)
BOOST_INCLUDEDIR (C:\Program Files\boost\boost_1_42)
BOOST_LIBRARYDIR (C:\Program Files\boost\boost_1_42\lib)
Well, at least BOOST_ROOT, but it can't hurt to set the two others.

-

Done Dependencies

Visual Studio users need to compile the dependencies themselves: Visual Studio Dependencies
MinGW users can grab the precompiled MinGW Dependencies

Unpack the dependencies into either your Ogre source directory, your Ogre build directory or somewhere else.
The directory should be named Dependencies if put into either the source or the build directory.
If you choose to place it elsewhere, you can name it however you like, as long as you're setting an environment variable OGRE_DEPENDENCIES_DIR pointing to its location.

It's recommended to use the last option - OGRE_DEPENDENCIES_DIR - as it makes it easier to manage several different dependencies (vc9, vc10, mingw) on the same computer, against the same Ogre source directory.

Tip_icon.png Be sure to build the dependencies if using Visual Studio! Find the solution file in Dependencies/src. And don't forget to build in both configurations: debug and release.

-(Linux)-

Image

Done Ubuntu

Image
For Ubuntu Karmic and above:

Compiler And Configuration Tools
Copy to clipboard
sudo apt-get install build-essential automake libtool

Required Dependencies
Copy to clipboard
sudo apt-get install libzzip-dev libxt-dev libxaw7-dev libxrandr-dev libfreeimage-dev freeglut3-dev libois-dev libfreetype6-dev libpng3-dev

Not Strictly Required Dependencies
Copy to clipboard
sudo apt-get install nvidia-cg-toolkit libois-dev libboost-thread-dev

Entirely Optional Dependencies
Copy to clipboard
sudo apt-get install doxygen graphviz libcppunit-dev


Info While nvidia-cg-toolkit, libois-dev and libboost-dev are not strictly required, you'll want to install them:
  • nvidia-cg-toolkit is used by the Cg plugin for Cg shaders.
  • libois-dev is used as input library for the demos.
  • libboost-thread-dev is used by the paging component and other background threading.

Could probably use libglew1.5-dev instead of freeglut3-dev. It is an open question whether or not libxt-dev and libpng3-dev is required.

-

Done Fedora

fedora.jpg
This is a list of packages to install for Fedora 13:
Copy to clipboard
gcc-c++ libxaw-devel freetype-devel freeimage-devel boost-devel ois-devel zziplib-devel


-(Mac OSX)-

Image
Precompiled archive containing PPC and i386 binaries compiled against the 10.4u SDK: OS X Dependencies

History

Information Version
Thu 15 of Oct, 2015 18:20 GMT-0000 Sauermann Added note about DirectX 9 SDK 125
Sat 14 of Feb, 2015 07:17 GMT-0000 gtsiam123 Added a warning about the install path 124
Thu 05 of Feb, 2015 11:39 GMT-0000 raffamaiden 123
Mon 06 of Oct, 2014 07:36 GMT-0000 spacegaier 122
Fri 04 of Jul, 2014 02:50 GMT-0000 excaliburHisSheath Updates the out-of-date warning for the Ubuntu apt repository to be accurate for Ubuntu 14.4 121
Thu 17 of Apr, 2014 02:58 GMT-0000 excaliburHisSheath Adds a note about installing DirectX on windows 120
Mon 23 of Dec, 2013 15:24 GMT-0000 jakesee 119
Wed 22 of May, 2013 16:55 GMT-0000 spacegaier 118
Tue 22 of Jan, 2013 08:31 GMT-0000 Transporter Update _ITERATOR_DEBUG_LEVEL bug note: The original instructions have been written for the original source and not CMake 117
Mon 23 of Jul, 2012 16:54 GMT-0000 TheSHEEEP 116
Sun 22 of Jul, 2012 12:55 GMT-0000 TheSHEEEP 115
Sun 22 of Jul, 2012 12:49 GMT-0000 TheSHEEEP 114
Sun 22 of Jul, 2012 12:04 GMT-0000 TheSHEEEP 113
Sun 22 of Jul, 2012 10:57 GMT-0000 TheSHEEEP Added likely "outdated" information 112
Sun 22 of Jul, 2012 10:53 GMT-0000 TheSHEEEP 111
Sun 22 of Jul, 2012 10:35 GMT-0000 TheSHEEEP Inserted link to CMake guide. 110
Sun 22 of Jul, 2012 10:15 GMT-0000 TheSHEEEP 109
Sun 22 of Jul, 2012 10:08 GMT-0000 TheSHEEEP More info 108
Sun 22 of Jul, 2012 10:06 GMT-0000 TheSHEEEP 107
Sun 22 of Jul, 2012 10:05 GMT-0000 TheSHEEEP Added note for building boost with MinGW 106
Sun 22 of Jul, 2012 10:01 GMT-0000 TheSHEEEP 105
Sun 22 of Jul, 2012 10:00 GMT-0000 TheSHEEEP bjam --> b2 104
Sun 22 of Jul, 2012 09:57 GMT-0000 TheSHEEEP Boost manual restructured. 103
Sun 22 of Jul, 2012 09:56 GMT-0000 TheSHEEEP 102
Sun 22 of Jul, 2012 09:55 GMT-0000 TheSHEEEP 101