Open main menu

Developer Central

Revision as of 03:11, 5 April 2014 by Digitall (talk | contribs) (→‎Release Management: Add technical and legal notes on Bundling ScummVM to relevant section. This also avoids the "orphaned" page issue.)

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 ScummVM.

Getting started

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

  • Some hints on debugging ScummVM.
  • 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.
  • Also, you should read and respect the general Coding Conventions.
  • 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 one of the following methods:
    • 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.
    • Using the patch tracker.
      This requires you to have/register a sourceforge.net account, and generate a patch file, but this may be easier for developers unfamilar with Git or for small single commit changes, where a Pull Request might be considered overkill.
    • If neither of the above methods are suitable, individual developers may be willing to accept patches or amended source files by other methods i.e. e-mail, but please ask in the project IRC channel or by e-mail before doing this.
  • Our Doxygen source code documentation may help you to get the big picture about ScummVM.
  • Also, you might want to check our list for current Platform Limitations.

For Engine authors

  • If you want to provide a new Engine for ScummVM, check out our Engines HOWTO.
  • If you work on a game engine for ScummVM, consider implementing Advanced Engine Features.
  • If your engine supports multiple games / game variants, properly detecting and differentiating them all can be a nuisance. Use the Advanced Detector to overcome this hurdle.
  • Accessing files in a portable fashion is non-trivial. Read all about how to open files.
  • Debugging endian issues can be tricky. This page gives some solutions.
  • If you want to have your engine merged into the ScummVM mainline, check out our Engine Inclusion HOWTO.
  • For those starting out with reverse engineering, check out our Reverse Engineering HOWTO.

For Backend authors

  • If you want to port ScummVM to a new platform, check out our Backends HOWTO.
  • The Dynamic Modules HOWTO describes how to implement loadable modules on a smaller backend, even without operating system support.

For Web site maintainers

  • If you want to update the main web site, update the files you want in /web trunk, and then login to the SF shell, change to the directory /home/project-web/scummvm/htdocs/ and run ./update.sh. To use the Interactive Shell Service of sf.net, check this tutorial.
  • This is also covered in more detail by the relevant section of the Admin HOWTO here.

Projects, plans, things to do

We are usually happy to receive any kind of help with the things listed below.

  • List of open tasks, with relatively detailed descriptions, and contact points. Some rather small ones, some bigger ones, take a look. GSoC Ideas also has some ideas, intended for students applying for Google's Summer of Code.
  • Main TODO list (contains links to many further specialized TODO pages, e.g. for specific engines).
  • Our bug tracker lists bugs that need to be resolved
  • Our feature request tracker also lists features requested by all kinds of people.

The following are partially outdated, but kept for now for the sake of reference.

New GUI

Our "new" GUI is themeable and translatable. If you are interested in writing a custom theme, the following may be of help for you:

Release Management

  • Our release guideline for ScummVM Release HOWTO
  • Our release testing status for the latest stable release Release Testing
  • Anyone who wishes to bundle ScummVM with games for legal commercial and non-commercial release should read the notes here.

Code statistics

Our commit logs are fed to several freely available statistics tools:

Team Member Benefits

Every active ScummVM Team member is eligible for enhanced access to our Project Services and some further benefits:

  • being added to our main credits (do it by yourself in scummvm/devtools/credits.pl)
  • @scummvm.org forwarding address
  • operator status in our IRC Channel #scummvm @ freenode
  • address cloak on freenode (in form of scummvm/undead/nick)
  • moderator status on ScummVM Forums and appropriate badge "ScummVM Developer" or "ScummVM Porter" or special one
  • ScummVM Wiki account
  • having development blog displayed on ScummVM Planet
  • using project donations for purchasing necessary things for the development, such as game copies, software licenses, etc.

If you need any of the above, talk to sev.

If you do admin tasks e.g. responding to bugs, moderating the forums, you should read the Admin HOWTO here for tips and guidelines on doing this.

Misc