Current Status¶
Currently at revision r73
- Simple SDL application that handles basic keyboard and mouse input.
- Original code was based on the linux/SDL code from NeHe Tutorials, lesson 1. This has been significantly altered to provide an Object Oriented structure for our framework.
- Project is made up from 3 sub-projects: editor, game, and library. Any functionality that is shared between the editor and the game is placed in the dynamic library. The library is in essence the game engine.
- Builds on Windows using Visual CPP 2008 or Eclipse 3.4.2. Builds on Linux using Eclipse 3.4.2 or scons
- For specifics on what features have been complete or are in progress, please refer to the Roadmap and the Roadmap Forum
General instructions
- Checkout latest revision from the repository using SVN client
- SDL 1.2.13, SDL_image 1.2, SDL_mixer 1.2 and OpenGL support required to build and run this project
Visual CPP 2008 instructions
- Download SDL for Visual C++ 2005 Service Pack 1 and unzip to an appropriate location, placing SDL.dll in binary search path (Usually C:\WINDOWS\system32)
- Download SDL_image for VC9 and SDL_mixer for VC8 and place the include and library files where you put SDL. All DLL files should go in binary search path (Usually C:\WINDOWS\system32)
- Add include and lib directories to search path (Tools | Options | Projects and Solutions | VC++ Directories)
- Open solution file in root folder, select either the engine or game as Startup project, should build and run without additional configuration
- Optional: Download and install Visual Leak Detector, reconfigure for VC2008 as per the forum post Can't get VLD 1.9g to detect leaks with VS 2008 in order to detect memory leaks using the WinDebug_VLD target.
Eclipse 3.4.2 Windows
- Install the CDT plugin for Eclipse through Software Updates (Help | Software Updates | Available software | Ganymede Update site | C and C++ Development | Select 'Eclipse C++ Development Platform' and 'Eclipse C++ Development Tools')
- Download and install MingW, gdb and MSYS as per this site
- Download SDL for Mingw32 and unzip to an appropriate location
- Place SDL.dll from SDL for Visual C++ 2005 Service Pack 1 in binary search path (Usually C:\WINDOWS\system32)
- There is no Mingw specific versions of SDL_image or SDL_image. Download SDL_image for VC9 and SDL_mixer for VC8 and place the include and library files where you put SDL. All DLL files should go in binary search path (Usually C:\WINDOWS\system32)
- Add an environment variable called SDL_MINGW that points to the SDL for MingW32 root folder
- Import projects from engine, game, and libtoap, should build without additional configuration. To run the game or editor you need to open the run configuration and add an environment variable "Path" with value "${env_var:Path};${workspace_loc:/toap_lib/WinDebug}" (remove the quotes, and change WinDebug to WinRelease as appropriate). This allows you to run the project from inside eclipse without the need to copy the DLL file over every time the library is rebuilt. So the exe files can see the 'res' folder, you need to set the working directory to ${workspace_loc:toap_game}/../ or ${workspace_loc:toap_editor}/../ as appropriate
Eclipse 3.4.2 Linux
- Install the CDT plugin for Eclipse through Software Updates (Help | Software Updates | Available software | Ganymede Update site | C and C++ Development | Select 'Eclipse C++ Development Platform' and 'Eclipse C++ Development Tools')
- Run the command sudo apt-get install libsdl1.2-dev libsdl-mixer1.2-dev libsdl-image1.2-dev to get SDL and required extensions
- Import projects from engine, game, and libtoap, should build without additional configuration. To run the game or editor you need to open the run configuration and add an environment variable "LD_LIBRARY_PATH" with value "${env_var:LD_LIBRARY_PATH};${workspace_loc:/toap_lib/LinDebug}" (remove the quotes, and change LinDebug to LinRelease as appropriate). This allows you to run the project from inside eclipse without the need to copy the .so file over every time the library is rebuilt.
Scons
Compiles under Linux, not tested for Windows.
- Run the command sudo apt-get install scons libsdl1.2-dev libsdl-mixer1.2-dev libsdl-image1.2-dev to scons, SDL and required extensions
- Run command in toap root directory: scons