History: Building CEGUI

            {maketoc}

!!General
Since the ((Cthugha|Ogre 1.7)) version, {LEX()}CEGUI{LEX} is not an Ogre dependency anymore and was replaced with a very simple UI overlay used for the demos. Users now have to compile the CEGUI against Ogre by themselves. This guide was made to help accomplish this.

__For versions 0.8.X and higher, as well as repository versions of CEGUI, we recommend you to use [http://cegui.org.uk/wiki/Building_CEGUI_for_Ogre_/_OgreRenderer| CEGUI wiki version of this site] as this guide here is currently outdated!__

If you want to use old versions of CEGUI and Ogre together, you can grab the latest precompiled dependencies from [http://www.ogre3d.org/download/|the Ogre download section] and [http://www.cegui.org.uk/wiki/index.php/Downloads|the CEGUI download section].
However it is recommended to use the latest official CEGUI version, together with a fitting Ogre version. Using the latest CEGUI release (0.8.2) together with Ogre is pretty straight-forward as CMake is being used there to replace premake. All you need to do is to fill out the CMake fields specifying the Ogre header and libs (as well as maybe also OIS if wanted) and generate your projects and building it.


__The part below here refers to an older version of CEGUI (0.7) and is outdated for versions 0.8.X and higher__

Here are all the links you will need:
*For the __source code__ it's recommended to get the [https://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/cegui_mk2/branches/v0-7|latest stable branch] from SVN (link leads to CEGUI 0.7 version which is the latest version right now). You can also just download it packed from [http://crayzedsgui.svn.sourceforge.net/viewvc/crayzedsgui/cegui_mk2/branches/v0-7.tar.gz?view=tar|here]
''Note'': If the branch version's source code seems to be unstable or not working at all, you can try the [http://sourceforge.net/projects/crayzedsgui/files/CEGUI%20Mk-2/snapshot|latest stable snapshot] which will most definitely be stable and working.
*__Additionally __to the source code you will need [http://sourceforge.net/projects/crayzedsgui/files/|dependencies suiting your compiler]. Download them for your CEGUI version and unpack the "dependencies" folder into your CEGUI main folder, so that it will co-exist next to the folders "bin", "cegui","datafiles" etc.

*Otherwise, if you find the info here unsufficient, you might wanna check this link on [http://www.cegui.org.uk/wiki/index.php/HOWTO:_Obtain_the_library_source_from_subversion|how to obtain libray source for CEGUI] in the CEGUI wiki. Or you can just use the source code from any release package, which you can find in the CEGUI download section (link above).


!!Step-by-step guide
# Get the appropriate __CEGUI__ version from the CEGUI download page or get the very latest CEGUI version from the SVN repository (see links and info above).
# Get the latest __Ogre__ version. If you are compiling it yourself, you will need to build it first to get Ogre's .lib and .dll files ready for CEGUI.
# In your CEGUI folder there should be a folder called "__projects__" with a subfolder called "__premake__". It is recommended to use the [https://sourceforge.net/projects/crayzedsgui/files/CEGUI%20Mk-2/premake/premake-3.7-custom.zip/download|custom premake version of CEGUI]. Otherwise you can get version 3.6 or 3.7 of premake. Once you have premake extract the __premake.exe__ file into the said folder.
# Open __config.lua__ in the premake folder and edit the Ogre and OIS paths accordingly, so that they will point to the dependency files. In my case for example the 2 lines look like this (having the OGRE and CEGUI main folders on the same level):
+ {CODE(wrap="1",colors="lua")}OGRE_PATHS = { "../OGRE", "include/OGRE", "lib" }
OIS_PATHS = { "../OGRE", "include/OIS", "lib" }{CODE}
+ %note% __Note:__ Remember to use forward slashes here! Just copying the paths from the Windows explorer will give you backward slashes. Replace them!
+ Next, set all Renderers you do not need to "false", in this case we will only need ''OGRE_RENDERER''. You can also set all samples to false, except maybe ''SAMPLES_OGRE'' if you want to compile those.
+ __Important:__ Since Ogre 1.7 the "boost" library is a new dependency of OGRE. If you are unsure if your Ogre version needs boost, you might want to check if there is a boost folder in your Ogre main folder. In case your Ogre version makes use of boost, you will additionally add boost to the extra paths of CEGUIOgreRenderer, in my case it looks like this:
+ {CODE(wrap="1", colors="lua")}CEGUI_EXTRA_PATHS = { 
{ "../OGRE/boost_1_42", "", "lib", "CEGUIOgreRenderer" }
 }{CODE}
+ %note% __Note:__ Make sure the path to your boost folder uses the version number that matches your setup!
# Next, we create our Visual Studio Projects - Execute __build_vs2008.bat__ to create a Visual Studio 2008 project or execute any other .bat file for your respective compiler version. (The next step will also explain how to proceed with other compilers.)
# This should create __CEGUI.sln__ in the premake folder; open it.
+ %note% __Note:__ If you are working Visual Studio 2010, use it to open the generated 2008 project. You will be asked if you want to convert it to a 2010 project, which should work without producing any errors.
+ %note% __Note:__ If you're using MinGW, you can try the experimental CEGUI version; if that doesn't work (and you're using the Code::Blocks IDE), you ''might'' be able to import the Visual Studio solution (File > Import project > MS Visual Studio solution...).
# If you have the Ogre lib files separated into Debug and Release folders, you will have to change the path in the __Linker__ settings of the project so they will point to the __lib/Debug__ or __lib/Release__ folder for each configuration respectively.
# Also, if you have the Ogre include files separated into OGRE and OIS folders, you will have to change the path in the __C++__ settings of the project so they will point to the __include/OGRE__
# __Build__ the __CEGUIOgreRenderer__ in Debug and Release mode. You must also build the CEGUIBase, CEGUIExpatParser and CEGUIFalagardWRBase projects to get their .dlls.
# Now that you have built the .dll files and .lib files for CEGUI by yourself, you only have to change the linker settings of your project so that the needed .lib files and their folder paths are included there. Also you might want to include the dll's into a folder where your executable application will find them (for example just the folder your executable starts from). Finally remember to set the CEGUI __include__ directory (for example "..\..\CEGUI\cegui\include\cegui") inside your C++ project settings.


If everything worked out, you now have CEGUI up and running!

!!Questions
For any suggestions and questions send a PM to me (Ident) or just ask in the forums and someone else will help you for sure...
In case you need help building Ogre, I'd recommend reading for example [http://blog.tidalware.com/2009/08/building-ogre-with-visual-studio/|this short guide].
---
Alias: (alias(Building_CEGUI))