Getting Started with Development

Getting the Code

Pioneer is managed using Git, and is stored on Github. The official repository is the best one to get. To get it:

git clone git://github.com/pioneerspacesim/pioneer.git

This will get you on the "master" branch, which is where new code is merged. This is the latest and greatest development and is quite unstable. To build a specific alpha, you need to checkout the appropriate release tag:

git checkout alpha20

Compiling Pioneer on Windows

An MSVC 2008 project file can be found in the win32/vc2008 folder. Open this project file and Pioneer should build just fine. All dependencies are provided so you don't need to compile any libraries.

Copy the .dll files from win32/vc2008 into the root folder (the one containing data, src, win32 directories), and you will be able to run the pioneer .exe file you just compiled.

Compiling Pioneer on Linux

Requirements

• libtool
• sigc++-2.0
• freetype2
• GL and GLU
• GLEW
• SDL 1.2
• SDLimage

Since pioneer is currently only available from the source repository, you also need autoconf and automake in order to generate the ./configure script (by running ./bootstrap)

You also need git to check the source code out from the repository.

Ubuntu commands to install all the requisite libraries

These may work on other versions of Ubuntu, and possibly Debian or their derivatives too.

Ubuntu 10.4

sudo apt-get install libsigc++-2.0-dev libglut3-dev libglew1.5-dev libsdl1.2-dev libvorbis-dev libsdl-image1.2-dev dh-autoreconf git libfreetype6-dev

Ubuntu 11.10

sudo apt-get install libsigc++-2.0-dev freeglut3-dev libglew1.5-dev libsdl1.2-dev libvorbis-dev libsdl-image1.2-dev dh-autoreconf git libfreetype6-dev

Fedora commands to install all the requisite libraries

These might work on other Fedora verisons, and Redhat-based systems.

Fedora 16

yum install libtool libsigc++20-devel mesa-libGL-devel mesa-libGLU-devel glew-devel SDL-devel SDL_image-devel freetype-devel libvorbis-devel libpng-devel gcc-c++

Building it

./bootstrap
./configure
make

Currently Pioneer runs from where it is built, and doesn't require (or work with) make install. To run it:

./src/pioneer

Debugging

For developers, gdb can be used for debugging

gdb ./src/pioneer
run

Bugs, and feature requests, should be logged on the issue tracker.