Developer Central

The purpose of this page is to give a link to all kinds of resources that contain information valuable to current and future developers of xoreos.

Getting started

The first thing you need to be able to do is get the xoreos code from our Git repository.
Then you should compile xoreos.

That was easy, right? Here are some more tips:

Before you write/submit code, you must read our Code Formatting Conventions.
Patches which do not follow them will be rejected or at least delayed until they are cleaned up to comply to them.
If you have write (push) access to our repository, you are expected to have read and to comply with our Commit Guidelines.
Also, please read the tips for using Git here: Git tips.
In particular, note the use of feature branches, when working on refactoring or other large connected changes, rather than committing directly to scummvm/master.
If you do not have write (push) access to our repository, you should submit your contributions by the following method:
- Using a Github Pull Request.
  This requires you to have/register a github account, fork our repository, commit your changes to a branch and then issue a Pull Request.
  This is the current preferred method as it is easier for the team to review, discuss and amend prior to merging.
  You are expected to have read and to comply with our Commit Guidelines.
For those starting out with reverse engineering, check out ScummVM's Reverse Engineering HOWTO.

For people starting out with reverse engineering, here are a few useful resources:

The HOWTO-Reverse Engineering page in ScummVM's wiki
REWiki contains a collection of game reverse engineering knowledge. They have a hints page as well
XentaxWiki focuses on game file formats. They too have a guide page
For audio and video formats, there's MultimediaWiki, which is associated with the ffmpeg and libav projects

Our Main TODO list contains a rambly, non-exhaustive collection of things left to do.