Difference between revisions of "Developer Center"

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

Resources for developers

These are wiki resources usefull 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 Mercurial.
• Compatibility - one issue should be fixed per release so its supported on more operating systems
• Releasing a new version - what to do when its time to release a new version
• Uploading to Savannah - what to do when your 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
• Developer Todo - list of things the developers are working on (includes roadmap)
• Current Issues with Using Globulation 2 - list of things that we hope will be fixed by 1.0
• 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

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

Coding info

• 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 Mercurial 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 ther 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++.
• Proposals for some actively supported issues
• Campaign Creation Information on adding campaigns into the code
• BuildingSourceInts
• Race Customization

Algorithm Descriptions

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

New Programming Documents / Tutorials

• The old ghost proposal
• The New Echo AI System. Some early information about Echo design.
• Making An AI With Echo. Read this if you want to make an AI for Glob2.
• Next Generation YOG
• New YOG Protocol Design Documents. Read this for a description of the new YOG system (still in development)
• Core Engine Design Document. Read this for a general description of the new core Engine
• Networked Games Design Document. A design document for our network engine.
• Completely Decoupled Event Driven GUI. A new idea for a completely modular, event driven GUI

Of course, Resources for contributors, savannah as well as IRC are also very usefull 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

Documentation in progress for Nicowar AI.

• Universe Background

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