The Naali viewer codebase uses CMake as its build system, so to generate the project solution files for Microsoft Visual Studio 2008 to use, you need to install CMake from http://www.cmake.org/. To be able to build the source repository, the first thing you need to do is to obtain (and possibly compile) the dependencies that are required by Naali. The second step is to configure the CMake build script to locate those dependencies, and finally you can compile the viewer solution itself.

Microsoft Visual C++ 2005 or earlier versions are not officially supported (but might work).

• Note: This tutorial will not provide instructions on how to use svn in general or how to use any individual SVN clients. One easy to learn client that we recommend is Tortoise SVN.

• Note: This tutorial will use concrete example paths like C:\Naali_trunk and C:\Naali_deps for readability and easier understanding. You can always choose your own paths in you local hard drive.

1. Create the following directory structure to your hard drive C:\Naali_trunk
2. Do a svn checkout from http://realxtend-naali.googlecode.com/svn/trunk/ to C:\Naali_trunk.

You will need two sets of dependencies, build and runtime dependencies. They are provided via a SVN repository so that they are easily updated and changes can be tracked properly. Second option is to build the dependencies yourself from source.

Getting dependencies from SVN repository

Getting dependencies by building from source

Copying runtime dependencies

1. Copy the whole content of C:\Naali_deps\bin\runtime_deps to C:\Naali_trunk\bin
   • Note: Windows will ask if you want to override files. Go ahead and override, but if it asks specificly if you want to override contect of '.svn' folder(s) then select no.

Configuring modules

You can include/exclude certain modules from Naali by editing the cmake files in the trunk folder. This can be handy if some optional module is giving you problems or you want to try additional modules that are not included in the default setup etc.

1. Open up C:\Naali_trunk\CMakeLists.txt in your preferred text editor
2. Configure the set of modules that you want to build by commenting out the unnecessary ones. Read the comments inside the text file for more information what are your options
3. Remember that you need to run cmake_vs2008.bat again every time you make modifications to this file in order for them to affect the solution file.

Prebuild with cmake

This step will create the Visual Studio solution file from the source files. Cmake will find needed dependencies from enviroment variable NAALI_DEP_PATH that you just created and include them in the individual projects include folders for headers and libs. Make sure that cmake\bin is in your PATH before executing cmake_vs2008.bat, easiest way to do this is to check the option "include cmake in system PATH" while installing cmake.

1. Run C:\Naali_trunk\cmake_vs2008.bat. If the cmake window gives any errors, try to determine what dependencies are missing and go back to previous steps.
2. If cmake prints out to the bottom Build files have been written to: C:\Naali_trunk the prebuild step was successful.
3. Press any key to close the window

• Note: Before cmake_vs2008.bat runs cmake.exe it will set QTDIR to our dependecies Qt directory. This is done so you don't manually have to set the env variable. If you have QTDIR set for your other dev reasons this step will not affect it. SET QTDIR=%NAALI_DEP_PATH%\Qt only is in effect for the runtime of the cmake_vs2008.bat.

Building and running the Naali viewer in Visual Studio

1. Open the created solution file C:\Naali_trunk\naali-viewer.sln by double clicking or open it from inside Visual Studio
2. Select debug or release mode from Visual Studio
3. Setting working directory: Right Click on the subproject viewer -> Properties -> From the dialog go to Debugging -> Set Working Directory to C:\Naali_trunk\bin. Remember to do this for both debug and release.
4. Setting the run command: In order for QApplication to find the qt.conf file from C:\Naali_trunk\bin so it will know where qt plugins are located, do the following: Right Click on the subproject viewer -> Properties -> From the dialog go to Debugging -> Set Command to $(SolutionDir)\bin\$(TargetFileName). Remember to do this for both debug and release. If you don't do this, running from visual studio Qt DLLs wont find the plugins as the path was not added via qt.conf file. This is not dangerous though, Naali will run normally but you just wont see images and foreign fonts in QWebView. When running viewer*.exe from naali/bin the plugins will be found due the execute path is correct.
5. Click from the top menu Build -> Build Solution (the usual short key for this operation is F6 or F7)
6. Wait while it builds and check that no errors occurred while building. If there are errors and its about not finding dependencies go back to previous steps as needed.
7. When build is complete without errors click from the top menu Debug -> Start Debugging (the usual short key for this operation is F5)

• Note: When compiling for the first time, compile in debug mode and run the exe at least once. Some data files are created in debug mode which are needed when running in release mode.

Created DLL files
C:\Naali_trunk\bin\modules\core
Created EXE files
Release: C:\Naali_trunk\bin\viewer.exe
Debug: C:\Naali_trunk\bin\viewerd.exe
Python Modules
C:\Naali_trunk\bin\pymodules read the readme.txt from this folder for more information.

Building under Linux

There's a script for building under Ubuntu 9.10 (+ some 3rd party packages) under tools/ in the subversion repository.

First, check out the viewer and viewerdeps modules from the repository.

cd ~/src
svn checkout http://realxtend-naali.googlecode.com/svn/trunk/ rex-viewer
svn checkout http://realxtend-naali-deps.googlecode.com/svn/trunk/ rex-deps

You'll need a recent-ish copy of the Qt, Ogre, OIS and CEGUI libraries. To get them, add the following PPA sources using add-apt-repository or the "Software Sources" GUI tool:

* ppa:mapopa/qt4.6
* ppa:andrewfenn/ogredev

Next, run the tools/build-ubuntu-deps.bash script. It should automagically build the dependencies and naali itself. It should be fairly up to date as our buildbot uses it.

If all went well, you can try running the viewer:

cd bin
./viewer

Troubleshooting

"make VERBOSE=1" lets you see the command lines the build system is using.