Difference between revisions of "Developer Central"

Revision as of 10:12, 25 February 2008

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

The first thing you need to be able to do is compile ScummVM.
Some hints on debugging ScummVM.
Before you write/submit code, you must read about 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, please read and respect the Portability Guide.
If you have write access to our repository, you are expect to have read and to comply to the Commit Guidelines.
If you want to provide a new Engine for ScummVM, check out our Engines HOWTO.
If you want to port ScummVM to a new platform, check out our Backends HOWTO.
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

Projects, plans, things to do

List of open tasks, with relatively detailed descriptions, and contact points. Some rather small ones, some bigger ones, take a look.
Small Devices Backend -- this is under development as part of the GSoC, but additional help is welcome.
Modular Backends -- partially implemented. More work needed.
Keymapping Improvements -- still in the design stage. Help is welcome.

TODO lists

New GUI

Release Management

Our release guideline for ScummVM Release HOWTO
Our release testing status for the latest stable release Release Testing

CVS/SVN statistics

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

FishEye SVN statistics
FishEye CVS statistics prior to Feb 6th, 2006
CIA SVN statistics, current development
ohloh project analysis nice graphs and devs activity
Koders statistics

Mailing Lists

Primary channel for important development-related discussion is scummvm-devel mailing list. All developers should subscribe to it.

The full set of public lists are:

scummvm-devel -- development-related discussions
scummvm-cvs-logs -- commit logs. Basically we're on SVN now, but the list name was not changed
scummvm-tracker -- Notifications of all new bugs, patches and feature requests

There is one note about scummvm-cvs-logs. Consider it as a read-only list, i.e. if you have comments/questions on someone's commit, post your follow-up to scummvm-devel.

Misc

MIME types, useful for setting the svn:mime-type.
Documentation on how we performed our CVS to Subversion conversion.

Old / obsolete stuff

Discussion about Autodetection of games in ScummVM.
Discussion about CVS versus Subversion

@@ Line 45: / Line 45: @@
 * [http://ohloh.net/opensource/software/scummvm ohloh project analysis] nice graphs and devs activity
 * [http://www.koders.com/info.aspx?c=ProjectInfo&pid=U3QTDTL99GE34QCUP16HXPSKSB Koders statistics]
+== Mailing Lists ==
+Primary channel for important development-related discussion is ''scummvm-devel'' mailing list. All developers should subscribe to it.
+The full set of public lists are:
+* [https://sourceforge.net/mailarchive/forum.php?forum_name=scummvm-devel ''scummvm-devel''] -- development-related discussions
+* [https://sourceforge.net/mailarchive/forum.php?forum_name=scummvm-cvs-logs ''scummvm-cvs-logs''] -- commit logs. Basically we're on SVN now, but the list name was not changed
+* [https://sourceforge.net/mailarchive/forum.php?forum_name=scummvm-tracker ''scummvm-tracker''] -- Notifications of all new bugs, patches and feature requests
+There is one note about scummvm-cvs-logs. Consider it as a read-only list, i.e. if you have comments/questions on someone's commit, post your follow-up to ''scummvm-devel''.
 == Misc ==