Author: Paul D Turner

Supported Systems

Crazy Eddie's GUI System Mk-2 is currently known to compile and run on the following systems:

Various flavors of Linux using gcc.
Microsoft Windows using Visual C++ versions 7.1 through 9 (both express and professional versions where applicable).
Apple Mac OS X running Xcode (tested on version 10.5.8 with Xcode 3.1).

It is very possible that the system will compile with other compilers and run on other systems, though those mentioned above have been tested.

Requirements

As well as one of the above supported systems, Crazy Eddie's GUI System Mk-2 can also make use of some third party external libraries. These libraries are as follows:

Optionally: Freetype2 (http://www.freetype.org)
Optionally: PCRE (http://www.pcre.org)
Optionally: Xerces-C++ XML parser (http://xml.apache.org/xerces-c)
Optionally: Expat XML parser (http://expat.sourceforge.net)
Optionally: LibXML XML parser (http://www.xmlsoft.org)
Optionally: DevIL image loading library (http://openil.sourceforge.net)
Optionally: Corona image loading library (http://corona.sourceforge.net)
Optionally: FreeImage image loading library (http://freeimage.sourceforge.net)
Optionally: SILLY image loading library (http://www.cegui.org.uk/wiki/index.php/SILLY)
Optionally: Lua programming language (http://www.lua.org/)

Compiling on Microsoft Windows with MSVC++

To compile on MSVC++ the first thing you need is the dependencies package, for details about where to obtain this please see Obtaining the code. The dependencies zip file should be extracted into the source package root directory so that you end up with a new directory named 'dependencies'.

If you're using code directly from subversion you will need a copy of the premake executable (currently you need version 3.6, which is available here. This executable should either be placed in the projects/premake directory or somewhere one your path.

Now you should navigate to the projects/premake directory in the source and open the config.lua file in a text editor of some kind. Take a few moments to look over the available options and make any required configuration changes you desire.

Next you should execute one of the provided 'build_*.bat' batch files. These do not actually build the code, but rather they invoke premake to generate an appropriate solution file and project files for the selected version of MSVC++ (so for example, build_vs2008.bat generates the solution for MSVC++ 2008).

Once this has run all you need to do is load the generated solution (CEGUI.sln) into MSVC++, select an appropriate build configuration (Debug, Release, etc) and press the build solution button.

The exact same approach is used when building the samples solution (unless you chose to build them as part of the main solution).

Compiling on GNU/Linux systems

Compiling on GNU/Linux and similar systems follows the familiar configure, make, make install idiom.

If you're using the code directly from subversion, the first thing you need to do is generate the configure script. This is achieved by running the bootstrap script in the source root directory (Note that running this requires Automake, Autoconf and Libtool).

Firstly it's highly recommended to look at the available configuration options for CEGUI, so run:

./configure --help

Once you've decided on the options you would like to set, you can invoke configure (add any options you need, obviously!):

./configure

Hopefully this will finish successfully and give you a summary of what options were configured. If the summary shows something you didn't want, go back and check your configure options.

Now you can build the code:

make

Once this has successfully completed, you can install the system. If you're installing in the 'usual' places, such as /usr or /usr/local you will need to install as root, so perhaps you would run

sudo make install

Finally, you'll probably need to run ldconfig so that the system configure and caches the newly installed libraries:

sudo ldconfig

Compiling on Mac OS X with Xcode

To compile with Xcode the first thing you need is the dependencies package, for details about where to obtain this please see Obtaining the code. The dependencies zip file should be extracted into the source package root directory so that you end up with a new directory named 'dependencies'.

Next you should navigate to the projects/Xcode directory and open the Xcode project file 'CEGUI.xcodeproj' in Xcode.

Now it's recommended that you take a few moments to look over the file at CEGUI/CEGUI/Base/include/CEGUIConfig.h in the Groups & Files panel. This file contains many of the options that you can change when building the system (some other options, related to external libraries, are available by selecting the project root and bringing up an Info window by pressing Command + I, select the Build tab, choose an appropriate build configuration and choose to show User-Defined Settings and make any desired changes.

Finally to build the code just select an appropriate target (like the default 'Crazy Eddie's GUI System' that builds everything except the Ogre and Irrlicht renderer frameworks), choose your build configuration and press the Build button.