Building OGRE From Source

For developers with more experience, building OGRE from source is usually the more attractive option. For some, it is the only option as prebuilt binaries are not available. Source provides the fastest access to bug fixes and allows the developer to debug any aspect of their code or OGRE. It is also necessary for contributing patches. As of version 1.7 (Cthugha), the Ogre project uses CMake as its primary build system. See Building Ogre Shoggoth for previous versions. For the latest stable code (all platforms), you can check out the source from Mercurial. If using windows, you might also want to read a quick guide about getting the sources with tortoisehg, a windows client. The actual stable revision is always in a specific branch, e.g. "v1-7" for Cthugha, and not the default branch. The 'default' branch is the latest unstable version and is not fully API-compatible with the stable stream, and may have temporary issues. Recommended only for experienced developers. [+] Quick Mercurial Guide (Click the + sign to view) To clone OGRE directly to the stable version (Cthugha) do this: Copy to clipboard hg clone http://bitbucket.org/sinbad/ogre/ -u v1-7 For the unstable 'default' branch: Copy to clipboard hg clone http://bitbucket.org/sinbad/ogre/ Note: You can always switch branches at any time. For instance, this command switches to the current stable branch: Copy to clipboard hg update v1-7

Prerequisites 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.
E(wrap="1", colors="bash")}export CPPFLAGS="-I/opt/local/include"
export LDFLAGS="-L/opt/local/lib"{CODE}
Finally, you need to install Cg and OIS. (Not strictly required by Ogre, but required for Demos, and generally recommended.)

{SPLIT}
{VERSIONS}

Quick Start Guide For the impatient: Learn how to build Ogre with CMake in two minutes. If you encounter any problems or need some more advanced procedures, do read the rest of the sections below!

Building Ogre with CMake This section explains how to use CMake to build Ogre from source.

Getting started with CMake This section introduces you to CMake and explains the concepts as well as how you can get and use CMake.

REDIRECT plugin: The redirection to 'https://ogrecave.github.io/ogre/api/latest/setup.html' is disabled in preview mode.

Building Your Projects With CMake This is an introduction to using cmake to build your own Ogre projects. For more detailed information about cmake, refer to the official site.

Introduction

This is a cmake script for building the Ogre Wiki Tutorial Framework, but it can easily be adapted for your own projects.

Works for Visual Studio, MinGW, and the GCC toolchain.

build that are required (Ogre (obviously:)), OIS, boost, etc..) Then the compilation progress indicators

1. Now, issue the command: make install Don't worry: it's a 'fake' install, it's only local. What it does is copy the 'dist' directory over to your build directory.
2. Run the "OgreApp" bin and you should see a blank screen with some OgreSDK info overlays. If you've gotten this far, your build process works!
3. If you get errors, you might need to copy the plugins.cfg from /usr/share/OGRE to your dist directory (use the one in your source directory, not the one in the build directory):
   cp /usr/share/OGRE/plugins.cfg ~/programming/ogreapp/dist/bin/plugins.cfg

If you're a Linux user, be sure to check out Setting Up An Application - Linux for ways to import the CMake script into NetBeans, QtCreator, KDevelop and other development environments.

Happy coding! 😊

For developers: Working with and extending Ogre's CMake build system CMake Build System Overview This section describes in some detail how Ogre's CMake build system works and how you can extend it. This is meant for developers who may need to add source files or entire targets to the build system.

Alias: Building With CMake
Alias: Building From Source
Alias: Building_From_Source