CELayout Editor - Getting Started / Building

Abstract

This page tries to get you up and running with the layout editor. It will explain both the use of a distribution, and downloading from CVS. If you have problems, don't hesitate to visit the forums. And besides, you may alter this page with any information you think will be helpful to future readers of this page. Some parts might be a little too verbose, but better safe then sorry ;-)

Using a distribution (Windows only; linux distribution(s) coming up!)

This is the recommended way. The distributions are stable and compatible with official CEGUI library releases. For example the 0.4.1 editor will work fine ("proven") with the 0.4.1 CEGUI release. Visit the download page for Windows installer(s) and Linux source distribution(s). Before installing a new version, it is recommeded that you uninstall a previous version first, because files might get removed in newer versions and such. On windows you can stop reading now. Linux and/or CVS users must read on for a bit more.

Compiling yourself

If you are a non-windows user, or prefer CVS access over distributions, you must follow the steps mentioned in this topic.

Setup CEGUI

Please see the CEGUI FAQ for downloading and compiling the cegui library.

Setup wxWidgets

This topic explains how to get and setup this cross-platform application framework.

Download

Distributions for many platforms can be found here.

Compile

Because the editor uses the wxGLCanvas, make sure that the setup.h file for your distribution gets its wxUSE_GLCANVAS define set to 1. You might check the install file for compilation details for your distribution, but the following steps should do the trick. On Windows:

• Open wx/msw/setup.h and define wxUSE_GLCANVAS as 1.
• Open build/msw/wx.dsw and build a Static Debug or Release Unicode configuration. (I had problems getting the application to link correctly with wxWidgets DLLs, so i have build wxWidgets as static libraries myself.)

On Linux:

• Enter ./configure --with-opengl --enable-unicode
• Enter make
• Enter make install

Setup the editor

This topic explains how to get and setup the editor from sources.

Download

If you use a non-command line utility such as TortoiseCVS, the basic settings for retrieving the HEAD are as follows:

• CVSROOT= :pserver:anonymous@cvs.sf.net:/cvsroot/crayzedsgui
• Module= CELayoutEditor

Or, from the command line (also for the HEAD):

• Enter cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/crayzedsgui login
• Enter cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/crayzedsgui co -P CELayoutEditor

However if you want the code which corresponds to a stable distribution, you must specify a tag. In Tortoise, you can do this on the "revision" tab. On the command line you need to append a -r<revision> parameter to the checkout command above. The following tags are available (type or select literally):

• "v-0-4-1" (current distribution)
• "before_wxwidgets" (0.3 compatible, but windows only (uses MFC!))

Compile

On windows:

• Open vc++6/CELayoutEditor.dsw (VS6) or vc++6/CELayoutEditor.sln (VS7.1). Conversions should happen automatically when opening on newer versions. Make sure that you add the directories 'wxWidgets-x.x.x\include' and 'wxWidgets-x.x.x\include\msvc' to your Include Directories, and 'wxWidgets-x.x.x\lib\vc_lib' to your Library Directories.
• Build either Debug or Release.

On Linux:

• Enter ./bootstrap
• Enter ./configure
• Enter make
• Enter make install
• Optionally set the CELAYOUTEDITOR_DATAPATH environment variable to point the editor to the correct 'datafiles' directory. If you do not set this variable, the editor will default to the location where it thinks the datafiles were installed (this will be typically be something like /usr/local/share/CELayoutEditor/datafiles). See the configuration file for additional details.

Hopefully, we will have a mac-compatible project or makefile in the future as well, so watch this space! :-)