Contributing to Artificial Planet

Developer Set Up

To develop with AIPlanet, you should use CVS. There are source ZIPs with GLScene DCUs available, but they are not updated frequently. You will need CVS to get the latest version of both AIPlanet and GLScene.

Initial Setup

Obtain Delphi
Create a SourceForge Account
Install Tortoise CVS
Setup Project Directories
Install GLScene
Install Jedi Code Library (JCL)
Install Jedi Visual Component Library (JVCL)
Install TeeChart Reporting Components
Install Indy
Install AIPlanet
Compile AIPlanet

Developing

Join the Team
Communication
Install Pageant
Submitting Code
Bug Reports
Optimizing

Initial Setup: 1. Obtain Delphi

If you do not already own a copy of Delphi, you may download the free Delphi 6 Personal Edition (and the 6.2 update) from: http://www.mathcs.concord.edu/software/
Delphi 6 Personal Edition requires a free key. You can obtain a key from: http://www.borland.com/products/downloads/download_delphi.html

Initial Setup: 2. Create a SourceForge Account

Visit SourceForge and create an account: http://sourceforge.net

Initial Setup: 3. Install TortoiseCVS

You may use other CVS tools, but Tortoise is recommended for Windows users.

Download and install: http://www.tortoisecvs.org/

Initial Setup: 4. Setup Project Directories

You may want to use a different directory structure, especially if any of the Delphi components will be used for other projects.

c:\AIPlanet
c:\AIPlanet\GLScene
c:\AIPlanet\indy
c:\AIPlanet\jedi

Initial Setup: 5. Install GLScene¹

AIPlanet uses the latest GLScene for 3D graphics.

You should read this first: GLSceneCVS Tutorial
Open Windows Explorer
Right-click on the "GLScene" created in step 4, and select "CVS Checkout"
If you are not a developer, then use "Password server" for Protocol, and 'anonymous' for User name
If you are a developer, then use "Secure shell" for Protocol, and your SourceForge account for User name
For Server, type "cvs.sourceforge.net"
For Repository, type "/cvsroot/glscene"
For Module, type "Source"
Then click OK
Repeat the above steps, with Module "Delphi6" instead of "Source". If you are using Delphi7 or other version then type that version instead. This tutorial assumes version 6.
Open the "GLScene\Delphi6" directory, and Open "GLScene6.dpk"
Recommended: Add "GLScene\Delphi6\" and "GLScene\Source\" along with all subdirectories to the Delphi Library Path (Tools->Environment Options->Library->Library path).
Recommended: Click Options and set the Output directory to: "C:\Program Files\Borland\Delphi6\Lib". This allows Delphi to find the GLScene DCUs anywhere.
Compile,then Install
Open the "GLScene\Delphi6" directory, and Open "GLSS_BASS6.dpk"
Recommended: Click Options and set the Output directory to: "C:\Program Files\Borland\Delphi6\Lib". This allows Delphi to find the GLScene DCUs anywhere.
Compile, then Install.

Initial Setup: 6. Install Jedi Code Library (JCL)²

From http://homepages.borland.com/jedi/jcl/, select Download->Source pack
Download the latest JCL Release .zip file
Extract the downloaded file to the "jedi" directory created in step 4
Verify that Delphi is closed
From the "jedi\jcl" directory run the "install.bat" file
More information is available from "jedi\jcl\docs\Readme.html"

Initial Setup: 7. Install Jedi Visual Component Library (JVCL)²

From http://homepages.borland.com/jedi/jvcl/, select Downloads
Download the latest JVCL Release .zip file
Extract the downloaded file to the "jedi" directory created in step 4
Verify that Delphi is closed
From the "jedi\jvcl" directory run the "install.bat" file
More information is available from "jedi\jvcl\readme.htm"

Initial Setup: 8. Install TeeChart Reporting Components

From http://www.steema.com/download/TeeChart_v5/index.htm, download "TeeChart502Delphi6Eval.exe"
Install "TeeChart502Delphi6Eval.exe"

Initial Setup: 9. Install Indy

From http://www.nevrona.com/Indy/download/Files/Indy9.html, download the latest .zip file for Indy 9
Extract the downloaded file to the "indy" directory created in step 4
From the "indy\Source" directory run the "FullDX.bat" file for your Delphi installation (e.g. "FullD6.bat" for Delphi 6)
Open Delphi and select Component->Install Packages...->Add... and pick the .bpl file in the DX directory created by the "FullDX.bat" file (e.g. "indy\D6\dcIndy60.bpl" for Delphi 6)
Recommended: Add "indy\DX\" to the Delphi Library Path (Tools->Environment Options->Library->Library path).
More information is available from "indy\Source\ManualInstall.txt"

Initial Setup: 10. Install AIPlanet

Open Windows Explorer
Right-click on the "AIPlanet" directory created in step 4, and select "CVS Checkout"
If you are not a developer, then use "Password server" for Protocol, and 'anonymous' for User name
If you are a developer, then use "Secure shell" for Protocol, and your SourceForge account for User name
For Server, type "cvs.sourceforge.net"
For Repository, type "/cvsroot/aiplanet"
For all Module, type "aireality".
Then click OK. There is about 50megabytes to download so be patient.

Initial Setup: 11. Compile AIPlanet

In the directory "aireality\aiplanet\Project" is the file "aiplanet.dpr". This is the project file. Open it with Delphi.
Select "Build All"
If it compiles successfully, then you are ready to develop!
If it does not compile, you may have not installed GLScene correctly, or the GLScene DCUs cannot be found.
Try "Running" aiplanet and have fun!

Notes:

If compilation issues are encountered for GLScene, consider downloading an earlier version from: http://sourceforge.net/project/showfiles.php?group_id=29749
If compilation issues are encountered for JCL and/or JVCL, consider downloading an earlier version from: http://sourceforge.net/project/showfiles.php?group_id=45786 (e.g. "JVCL210FullInstall.zip")

Developing: 1. Join the Team

Visit SourceForge.net and create a user account.
Ask Dave to add you to the developer list.
You will now have access to the developer forum.
Please join the developer mailing list.

Developing: 2. Communication

You should post a message to the forum and say what you would like to do.
If you have any problems someone will help you out.

Developing: 3. Install Pageant

You may want to run Pageant as it automatically types your password for you when using CVS.
It is included in the Putty suite: http://www.chiark.greenend.org.uk/~sgtatham/putty/

Developing: 4. Submitting Code

Open Windows Explorer.
Find the directory with your modified file.
Click that directory with the right mouse button.
Select CVS Commit if you changed a file or CVS Add if you made a new file.
Please do not submit DCUs.

Developing: 5. Bug Reports

Post a message in the forums about the bug.
If it is a serious bug, or no one is fixing it, use the SourceForge bug reporting tool.

Developing: 6. Optimizing

Use GpProfile to optimize code: GpProfile

written by David Kerr