Obtaining the library source from Subversion

From CEGUI Wiki - Crazy Eddie's Gui System for Games (Open Source)
Revision as of 12:50, 22 May 2011 by Crazyeddie (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Written for CEGUI 0.7


Works with versions 0.7.x (obsolete)

Written for CEGUI 0.6


Works with versions 0.6.x (obsolete)

Written for CEGUI 0.5


Works with versions 0.5.x (obsolete)

Written for CEGUI 0.4


Works with versions 0.4.x (obsolete)





We now use Mercurial so this page can be considered obsolete



Much of this information has been incorporated into the official developer documentation, see Obtaining the code and Supported systems and compilation


Contents

Abstract

PLEASE note: if you'd rather use precreated releases (tarballs or SDKs), please follow Downloads.

All the code for CrazyEddie's GUI System (and its tools) is kept in a revision control system known as Subversion(SVN). This is a tool that allows us to easily track changes to the code (who did what, and when), to maintain multiple different versions (branches) for the code, and, where necessary, undo, revert, or merge code changes. This page explains the URLs of these repositories.

Branches and trunks

Generally speaking, each stable release series has a seperate branch, and any changes made on those branches are largely bug-fixes and non-breaking (where possible) changes. The main 'trunk', or HEAD, code is where the latest and greatest code can be found, although this version of the code is generally to be considered as unstable / testing code. On the whole, we maintain two branches at once; whichever is the latest 'stable' branch, and the main trunk code. When a new release is made, previous release branches are generally considered obsolete (this will continue at least until we reach version 1.0.0 - at this stage we may consider maintaining support for multiple released versions).

Accessing Subversion

It is possible to browse the SVN repository online by visiting http://crayzedsgui.svn.sourceforge.net/viewvc/crayzedsgui/cegui_mk2/ However, in order to actually compile the code you need to get the sources on your machine. On Linux you'd use the 'svn' command, and on Windows we'd suggest the Tortoise SVN Client utility, which nicely integrates with your Explorer. Note that the 'svn' command expects the local target directory in the command, where TortoiseSVN expects it in an editbox of its interface. Either way, the URLs mentioned next will be the same. Note the s's; the repository has a secure URL. Retreiving is always "anonymous", so it should work immediately.

The URLs

From the commandline

  • CEGUI itself:
    • For the current stable version code:
      svn co https://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/cegui_mk2/branches/v0-7 cegui_mk2-0-7
    • For the cutting edge, unstable development version code:
      svn co https://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/cegui_mk2/trunk cegui_mk2-trunk
  • CEGUI Layout Editor:
    • For the current stable version code:
      svn co https://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CELayoutEditor/branches/v0-6-1 LayoutEditor
    • For the cutting edge, unstable development version code:
      svn co https://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CELayoutEditor/trunk LayoutEditor
  • CEGUI Imageset Editor:
    • For the current stable version code:
      svn co https://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CEImagesetEditor/tags/v0-6-1 ImagesetEditor
    • For the cutting edge, unstable development version code:
      svn co https://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CEImagesetEditor/trunk ImagesetEditor

From TortoiseSVN

  • CEGUI itself:
    • For the current stable version code:
      https://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/cegui_mk2/branches/v0-7
    • For the cutting edge, unstable development version code:
      https://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/cegui_mk2/trunk
  • CEGUI Layout Editor:
    • For the current stable version code:
      https://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CELayoutEditor/branches/v-0-6-1
    • For the cutting edge, unstable development version code:
      https://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CELayoutEditor/trunk
  • CEGUI Imageset Editor:
    • For the current stable version code:
      https://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CEImagesetEditor/tags/v0-6-1
    • For the cutting edge, unstable development version code:
      https://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CEImagesetEditor/trunk

TODO: What's next

Now that you have the sources locally available, it's time to compile them. Depending on your OS, please follow one of the following links:

  • For Windows, click here: <link here>
  • For Linux, click here: <link here>
  • For Mac OS, click here: <link here>

Compiling on Windows

Now that you have the code, you probably want to compile it :)

On windows, Premake is used to create project and solution files for different versions of Visual Studio. These files can be found in the directory 'makefiles/premake'. Per supported Visual Studio version there is one batch file for CEGUI itself, and one for the samples. After running a batch file, a corresponding .sln file is written in the same directory, which you can open.

Compiling on Linux

The first thing to do is to run bootstrap, which will run automake, autoconf, and various other tools to initialise the build environment and create the main configure script. If you have problems with bootstrap, make sure you're using a recent version of automake (1.9 is known to work).

./bootstrap

Now you should be on familiar territorty. To configure the build, run configure:

./configure

There are various things you can change about the way the system is built, to get information about these options, pass the --help option to configure like so:

./configure --help

Once configure has run successfully, you need to run make as usual:

make

And finall, install as root:

su  <and enter password ;) >
make install

Compiling for the Ogre3D Engine / Compiling the OgreRenderer

Building CEGUI for Ogre / OgreRenderer

Documentation

Since you are using the library from SVN instead of using the precreated packages, you need to get the documentation by yourself. Please follow Documentation.