About

this contains information about developing the RoRToolkit, this is the gateway to all information if you wish to write code or just report a bug.

Homepage

https://sourceforge.net/projects/roreditor/

Project Components

• Starter (lib/ror)
  • This component should allow the user to select settings for the editors (ror-dirs) and check for system requirements. (i.e. disable DirectX driver or so)

• TerrainEditor (lib/rorterraineditor)
  • terrain editor for placing objects into the terrain

• RoR Common Code parts (lib/ror)
  • common parts for all editors: settings, parser

• TruckEditor (lib/rortruckeditor)
  • edit truck and loads

Requirements

• just have python 2.5 installed

Useful Tools

• Windows PowerToy "Open Command Window Here":
  • http://www.microsoft.com/windowsxp/downloads/powertoys/xppowertoys.mspx
  • http://download.microsoft.com/download/whistler/Install/2/WXP/EN-US/CmdHerePowertoySetup.exe

Python Editors =

• simple and easy, but nothing python specific:
  • http://notepad-plus.sourceforge.net/

• Pydev eclipse plugin: Full fledged editor and IDE, includes python debugger
  • http://pydev.sourceforge.net/

Helping Out

Debugging

Don't have any programming experience but still want to help the toolkit out? look here for more information

Development

Check here if you feel comfortable with python, or are willing to learn. This section is reserved for implementing and designing the toolkit.

Getting Started

This section will be filled out further in the future.

• Installing Eclipse
• Installing Pydev
• Installing Subclipse
• Setting Up Your Environment
• Creating and submitting patches

Get the Sources

• get http://tortoisesvn.tigris.org/
• use these information: http://sourceforge.net/svn/?group_id=189150

Subversion Repository Overview

• trunk/ : startup files, setup files, ogre dlls
  • lib/ : local python include path, added on startup (so these modules must not be installed in global site-packages)
    • ogre/ : http://www.python-ogre.org, no linux binaries :((
    • ror/ : shared classes among several parts
    • rorterraineditor/ : the terrain editor
    • rortruckeditor/ : the truck editor
    • wx/ : http://www.wxpython.org, missing linux binaries :(
    • wxogre/ : self - written implementation of ogre for wxWidgets (wxPython)
  • devtools/
    • originalcode/ : various code by pricorde
• branches/
  • dev/ : linux branch this contains code specific for the linux version
• tags/ : unused

To Be Done

• Starter
  • rework gui - looks awful as it is now
  • use something like this (http://cfgparse.sourceforge.net/) or that (http://docs.python.org/lib/module-ConfigParser.html) to store ror editor settings.
• so much things that are not written down here

Mailing Lists

• svn commit messages:
  • https://lists.sourceforge.net/lists/listinfo/roreditor-svn

Old Guides

• RoRToolkit HowToBetaTest