Developer Center

Current developer resources

Start with Contributing and the documentation index in the maintained GitHub repository.

• Build and run — platform prerequisites and development builds.
• Architecture and repository map and compatibility rules.
• Tests and verification and evidence.
• Release and distribution and public release history.
• Issues and bug reports.

See Contributor Center for other contribution paths. The wiki resources below describe historical development; verify implementation details against the current repository.

Historical information

These archived instructions and notes describe older releases. Use the current links above for modern versions.

This page is intended to be the center of the developer community, i.e. people working with direct Git access. The final code documentation should be written by doxygen into Git in docsrc/ directory, but intermediate doc are welcomed here to be worked on.

Resources for developers

These are wiki resources useful for developer:

Compilation and Releases

• Changelog for players, source for release notes. Please update it when you commit a new feature or an important bug fix in the Git.
• Compatibility - one issue should be fixed per release so it's supported on more operating systems
• Releasing a new version - what to do when it's time to release a new version
• Uploading to Savannah - what to do when you're ready to upload the version
• Things to do before 1.0.0 - a list of must do things that need to be incorporated into Globulation before the 1.0.0 release
• Converting from the old map format - After Alpha 23, the format for maps was changed, so you need to convert
• Obtaining the Release Candidate - How to work with the release candidate
• Beta 5 rebalance - Slight gameplay tweaks in beta 5

Packaging

• Building the .deb file - making a package for Debian
• Cross compile glob2 - explains how to compile globulation2 for windows on Debian
• Compile glob2 with mingw - explains how to compile globulation2 on windows using mingw.
• Compiling Glob2 on Mac OSX - maintained by AppleBoy
• Cross compiling deb packages on Hudson - how to cross compile and package using pbuilder.

Coding info

• Proposals for some actively supported issues
• Bounty projects - a list of things people will pay to have implemented.
• General Gameplay Guidelines - what the game must keep to
• The hierarchy of files in glob2's sources. Refer to Git HEAD.
• GUI Theming
• Programming conventions used by source code. Please follow them if you want to contribute to source code. You can comment them in their discussion page.
• View the way code should be documented
• Things to read if you want to enter into glob2's source code.
• Mistake often seen in C++. Please read this and check your code if you are new to C++.
• Campaign Creation Information on adding campaigns into the code
• BuildingSourceInts
• Race Customization
• Making An AI With Echo. Read this if you want to make an AI for Glob2.

Algorithm Descriptions

• Resource growing description
• High level gradient usage description
• High level terrain description

Of course, Resources for contributors, Github as well as IRC are also very useful for developers.

Work in Progress

These sections are still being worked on. While you're welcome to comment on them, you shouldn't spend all day nitpicking on them, as they might be changed completely or removed before you're finished.

• AINicowar
• Universe Background
• USL interface

Request for comments

These files have been written up fully, but need to be peer-reviewed. Please read through these pages, edit and comment on them.

• nothing for now