GCC Logo

This is a step-by-step guide for building Ogre, its dependencies and boost from sources, using your favourite Windows compiler, MinGW :-)
It covers every single step and will be the only tutorial you need to read for building Ogre if this is your desired setup. Tested on Windows 7 x64 with Ogre 1.10.0

Introduction

This guide covers how to do a static Ogre build with a certain plugin setup, but on the important places, a note will be added that tells what to do differently for a dynamic build or other plugins.

We will assume a lot of different folders in the course of this tutorial. You may of course derive from them if you want.

1. Download the Ogre sources

Download the latest Ogre sources, using Mercurial, from the Ogre repository:

http://bitbucket.org/sinbad/ogre/

For the purpose of this tutorial, let's assume you downloaded them to the following folder: C:\Ogre\sources\v1-8

Now make sure you switch your local repository to the branch of Ogre you actually want to use (like v1-8 or v1-9).
For example, with TortoiseHG, you have to "Update" your repo, selecting the branch you need.

2. Download the Ogre dependencies

The same as above, but download them from the following repository:

https://bitbucket.org/cabalistic/ogredeps/downloads
 For TDM MinGW release builds
Using TDM 4.8.1, the Cabalistic ogredeps package only works for debug builds, when building Ogre itself. On release builds you might get errors about multiple definitions of functions, to fix this use this fork of ogredeps, instead of the other one:
https://bitbucket.org/ali1234/ogredeps/downloads

This time, let's assume the following folder: C:\Ogre\sources\dependencies


If you want DirectX support, you will also have to download and install the DirectX SDK:
Download and install DirectX 9 SDK

3. Download and install CMake

Download and install CMake
Be sure to use the latest version.

4. Download and install MinGW

Download the latest MinGW version from here, and install it.
It is advised to install it to the default directory: C:\MinGW
Make sure to use "Download latest repository catalogue". The current pre-packaged is GCC 4.6 only (may change in the future).
Also be sure to add C:\MinGW\bin and C:\MinGW\msys\1.0\bin to your PATH.

Or you can choose to use the TDM version of MinGW, which provides many bug fixes aside from just the MinGW project, from http://tdm-gcc.tdragon.net/download (current version is GCC 4.8.1).
Generally it will automatically add your installation directory to the PATH, but just in case you should check.

5. Download boost

Download boost from here. This tutorial was written with version 1.50 in mind, but should work for any newer version as well.
Let's assume C:\boost as the path.

6. Building boost

Now we come to the fun part - building!

  1. Navigate to C:\boost
  2. Open index.html and go to "Getting Started" -> "Getting Started on Microsoft Windows"
  3. Follow the steps to build boost from sources. You will most likely want to read section 5.3 "Build Binaries from source". Mind the following:
    1. Whenever you're supposed to run "bootstrap.bat", run "bootstrap.bat gcc" instead.
    2. As you are using MinGW, specify gcc as toolset when actually building boost.
    3. Building boost takes much time. Get a cup of tea.
    4. If you use the following line to build boost...
      b2 --build-dir=C:\boost\build toolset=gcc --build-type=complete stage
      ... you will end up with a stage folder in C:\boost. Move the lib folder inside the stage folder to C:\boost so that you end up having a C:\boost\lib folder.
    5. If you get a "Duplicate name of actual target" error when building boost, use "minimal" build-type instead of "complete".
  4. Add C:\boost to PATH and create new environment variables named BOOST_ROOT and Boost_DIR also pointing to C:\boost.

7. Building the Ogre dependencies

  1. Open the CMake GUI.
  2. Set "Where is the source code" to C:\Ogre\sources\dependencies.
  3. Set "Where to build the binaries" to C:\Ogre\building\dep-release. THIS IS NOT the final dependencies folder. It is merely the folder we will use to build the SDK.
  4. Click "Configure" to init CMake. Select "MinGW Makefiles".
  5. Based on your setup, CMake may or may not output some errors. Make sure to resolve them before continuing. CMake is usually pretty verbose about what to do. If you are having trouble, you can always ask in our forums, of course :-). Click "Configure" again until no more errors appear.
  6. Change CMAKE_INSTALL_PREFIX to C:\Ogre\built\dependencies. Click "Generate".
  7. Repeat 3) – 6), this time changing CMAKE_BUILD_TYPE to "Debug". Also change the "Where to build the binaries" folder to C:\Ogre\building\dep-debug.
  8. Open a command line in C:\Ogre\building\dep-release and type in "mingw32-make install". This will take a minute or two. Do this also for the debug folder.
  9. Navigate to C:\Ogre\built\dependencies. Navigate to lib/Release within that folder and copy the cg.lib to lib/Debug. Somehow, the install make misses this.
  10. Create a new folder in C:\Ogre\sources\v1-8, call it Dependencies and copy all the contents from C:\Ogre\built\dependencies there.
 For 64 bit machines
In FreeImage there is an error somewhere within libTIFF4, due to a bad pointer conversion, this is the place:
// Warning: tif_fd is declared as 'int' currently (see libTIFF), 
    // may result in incorrect file pointers inside libTIFF on 
    // 64bit machines (sizeof(int) != sizeof(long)). 
    // Needs to be fixed within libTIFF.
   if (tif) {
      tif->tif_fd = (long)handle;
   }

   return tif;

The comment is mentioning the problem and it tells you to go to the source of libTIFF and fix it there, but an easier fix I found is to just change the line causing the problem to this:

tif->tif_fd = (intptr_t)handle;
intptr_t type is guaranteed to allocate enough space for the data, so no more errors here.

8. Building OIS statically (OPTIONAL)

  1. To build static OIS you will need to build it separately from the other ogredeps. First get the source from
    http://sourceforge.net/projects/wgois/
    . Let's assume you use the original name of the folder which is ois-v-1-3.
  2. Navigate to ois-v-1-3/Win32/ and open ois.cbp with Code::Blocks.
  3. Set the project compiler search path to your DirectX SDK directory, so it can find all the headers needed.
  4. Make some changes in the code, as it will not compile out of the box:

In Win32Joystick.cpp line 587:
hr = CoCreateInstance(uuidof(WbemLocator), NULL, CLSCTX_INPROC_SERVER, uuidof(IWbemLocator), (LPVOID*)&pIWbemLocator);
uses the VC keyword __uuidof, which MingW doesn't have. Change this line to:
hr = CoCreateInstance(CLSID_WbemLocator, NULL, CLSCTX_INPROC_SERVER, IID_IWbemLocator, (LPVOID*)&pIWbemLocator);

Also the two instances of swscanf_s (Microsoft specific) were changed to swscanf.

  1. The libraries that have the Microsoft COM functions that are used in W32Joystick setup need to be linked in. These libraries are ole32 and oleaut32.
  2. OIS static libs (the build targets are Release and Debug) should be successfully, but the .dlls still need more libs to link against, those are: wbemuuid.lib, dinput8 and dxguid.
  3. When you have succesfully compiled all build targets, copy libs from ois-v-1-3/lib into your dependencies folder. Change their names to "libOIS.a" and "libOIS_d.a" for each one respectively and replace the old libs.
  4. Replace the old .dlls with new ones from ois-v-1-3/dll just like you did with the libs.
  5. You have successfully replaced dynamic OIS from ogredeps with static OIS you just compiled.

 Static libs require dependencies to be linked
If you want to use the static OIS library, you will also have to change CMake options for ogre by adding wbemuuid.lib, dinput8 and dxguid as extra libraries to link against.

9. Building the Ogre SDK

 For 64 bit users
Before doing anything, if you use a 64 bit system you need to open CMakeLists.txt in C:\Ogre\sources\v1-8 and look for the flag -march=i686. Change it to -march=x86-64. This will fix any "CPU you selected does not support x86-64 instruction set" errors.

C:\Ogre\sources\v1-8

  1. Open the CMake GUI.
  2. Set "Where is the source code" to .
  3. Set "Where to build the binaries" to C:\Ogre\building\ogre-release. THIS IS NOT the final SDK folder. It is merely the folder we will use to build the SDK.
  4. Click "Configure" to init CMake. Select "MinGW Makefiles".
  5. CMake should find the dependencies but if it does not, set the OGRE_DEPENDENCIES_DIR to C:\Ogre\sources\v1-8\Dependencies manually.
  6. You can ignore the "Boost_DIR-NOTFOUND" if everything else worked well. If you have a look at the vars in "Advanced" CMake mode, you will see that all boost related vars except that one are correct.
  7. Set the CMAKE_INSTALL_PREFIX to C:\Ogre\built\ogre-sdk. Click "Configure" again.
  8. If everything worked out, you will get a load of new configurations. Make sure to select OGRE_STATIC, OGRE_INSTALL_SAMPLES and OGRE_INSTALL_DOCS.
    1. If you want a dynamic build, do not select OGRE_STATIC :-)
    2. You can of course select other plugins as you desire, but this tutorial does only "guarantee" to work for the stated ones.
  9. Click "Configure" again, resolving all problems that might appear, until everything goes well. Click "Generate".
  10. Repeat 3) – 9), this time changing CMAKE_BUILD_TYPE to "Debug". Also change the "Where to build the binaries" folder to C:\Ogre\building\ogre-debug.
  11. Open a command line in C:\Ogre\building\ogre-release and type in "mingw32-make install". This will take some time, so get another cup of tea. Do this also for the debug folder (and get your third cup of tea).
 Again for 64 bit ogre
You may encounter some errors when Ogre::StringConverter is used. These are caused by some #ifdefs that are a bit strange, the errors themselves are "ogre\RenderSystems\GL\src\Win32\OgreWin32Window.cpp|260|error: call of overloaded 'toString(DWORD&)' is ambiguous|", this happens when it tries to use the DWORD type argument (unsigned long long) and there is no overload for this type of argument, the compiler then doesn't know which type to convert to and starts complaining.

This is an example place of where such an error happens: (there are more than 1, but all of them can be fixed using the same logic)

if (!GetMonitorInfo(hMonitor, &monitorInfoEx))
            {
                DWORD le = GetLastError();
                LogManager::getSingleton().logMessage(LML_CRITICAL, 
                    ::Ogre::String("Win32Window::create(): Call to GetMonitorInfo() failed.")
                    + ::Ogre::String(" GetLastError() returns: ")
                    + ::Ogre::StringConverter::toString(le)
                    );
                OGRE_EXCEPT(Exception::ERR_RENDERINGAPI_ERROR, "Call to GetMonitorInfo() failed", "Win32Window::create()");
            }

The fix is converting DWORD to size_t, for which there is an overloaded function.

+ ::Ogre::StringConverter::toString(size_t(le))

10. Done

That's it!
You'll have a ready-to-use-with-MinGW Ogre SDK sitting in C:\Ogre\built\ogre-sdk, both in release and debug version.
Try out the samples, they rock! :-D
Also, you'll probably want to go to the toilet with all that tea you just drank.

help If you should encounter any problems while reading, please post in the forum thread for this article.
<HR>
Creative Commons Copyright -- Some rights reserved.


THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

1. Definitions

  • "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
  • "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
  • "Licensor" means the individual or entity that offers the Work under the terms of this License.
  • "Original Author" means the individual or entity who created the Work.
  • "Work" means the copyrightable work of authorship offered under the terms of this License.
  • "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
  • "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.

2. Fair Use Rights

Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.

3. License Grant

Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:

  • to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
  • to create and reproduce Derivative Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
  • For the avoidance of doubt, where the work is a musical composition:
    • Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
    • Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
    • Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).


The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.

4. Restrictions

The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:

  • You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
  • You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
  • If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.

5. Representations, Warranties and Disclaimer

UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.

6. Limitation on Liability.

EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. Termination

  • This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
  • Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.

8. Miscellaneous

  • Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
  • Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
  • If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
  • No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
  • This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.