Coding

Contribute: Coding, Debugging, Scripting, Packaging

Getting the source

Just have a look at our Getting the source page to get more information about this.

Requirements

In order to compile UFO:Alien Invasion under Linux you need to install some packages. First of all make sure, that you have gcc installed.

gcc/g++
OpenGL-header files (usually comes with your graphic card drivers; or you may use the 'mesa' source package)
ogg vorbis header
libjpeg8 header
libpng header
libcurl header
zlib header version >= 1.2.3
SDL (incl. headers)
- SDL version >= 1.2.10
- SDL_ttf (sdl-ttf) version >= 2.0.7
- SDL_mixer (libsdl-mixer) version >= 1.2.7
make

Compiling the source

Don't forget to compile the maps when you are not using any pre packaged version. Otherwise the tactical missions won't start up.

Also make sure, that you compile the language files (po-files from Template:Path). Otherwise you will only see placeholders in the ufopedia and some other places.

You can now create the pk3 archives by typing

make pk3

- also see the packaging notes. This step is optional.

After compiling the source and maps you will most likely run the game.

Debugging the game

There is a debugging article available with more information about this topic.

The Debug commands will help you here as well.

Contributing

If you want to contribute to the project you need an account at sourceforge.net or submit your patches anonymously to our issue tracker. There is also a TODO-list and a Changelog available. Please also have a look at the coding guidelines.

Documentation

The Doxygen code documentation can be found here. It is most likely out of date, but you can always generate a current one yourself by typing:

make doxygen-docs

in the root of your ufoai working directory.

External Links

UFO:AI Project homepage at SourceForge
CIA Bot - Repository changelog with some statistics
Pre-defined Operating System Macros

Coding help

Tutorials on the net

some of them are Quake1 or Quake3 related but maybe give a starting point...