Crazy Eddie's GUI System 0.8.7
CEGUI uses CMake build generation system (http://www.cmake.org/) to configure the build and generate makefiles or project files of whatever kind you choose – basically this means that if cmake can spit out build files for it, then you should be able to successfully use it to build CEGUI.
You may have already noticed that CEGUI has a lot of dependencies. Don't be scared! These are mostly – if not all – optional. CEGUI uses these third-party libraries to provide various functionality ranging from the obvious rendering and image loading to more obscure things such as providing regular expression based validation of edit box content and bi-directional text.
For Windows and Apple OS X users, a source based dependency package is provided. This contains the source for the dependencies that you may wish to use. Please note that this dependency package is the only supported approach to getting the dependencies on these systems. See Obtaining and Building the Dependencies (Windows and OS X) for instructions related to building the dependency pack.
For GNU/Linux systems, it is expected that you will install the development packages for the libraries that you intend to use – either via your distribution's package management system or by manually building and installing if that is more appropriate for you.
The procedure for building CEGUI is about as simple as things can get and is effectively the same as building any other library you might have built. Things to note are that, as already mentioned, CEGUI uses the cmake build generator and provides a source based dependency pack for Microsoft Windows and Apple OS X users.
I will now overview the basic steps, since these are mostly trivial long descriptions are not given for most steps.
dependenciesdirectory from the location where you built the dependencies to the root CEGUI source directory. This means that if your CEGUI directory is called
C:\cegui-0.8.0, your dependencies should be at
Now you must use CMake to configure the build and generate the appropriate build files so that you can actually compile the source files. I recommend the CMake GUI utility – at least initially until you are familiar with the available build options. The steps below reflect this choice, if you choose not to use the GUI utility for this, then it is assumed you are sufficiently familiar with both CMake and CEGUI and therefore do not require additional guidance.
Once you have the CMake GUI utility running:
You should now take the generated build files and build them! This may involve loading solution or project files into your IDE and pressing build buttons or entering commands – such as
make – into the terminal. Once the build is complete, you should find libraries and perhaps executable binaries in subdirectories beneath your chosen build location.
Building the 'install' target will copy the files required to use CEGUI to some appropriate location on your system:
make install– or some equivalent operation to trigger the install target – you will cause the libraries, headers and other items to be installed to the system. It is likely that you will need appropriate privileges to achieve this unless you set the install prefix to some other location that you already have access to.
install_manifest.txtthat contains a list of all files copied during install. This allows you to uninstall by doing something similar to:
xargs rm <install_manifest.txt
This has been an overview of the build for CEGUI. You should now have your libraries built and be ready and able to make use of the system.