Difference between revisions of "Developer Central"

Revision as of 10:39, 22 March 2007

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.

The first thing you need to be able to do is Compile ScummVM.
If you write code, please absolutely make sure to read about our Code Formatting Conventions. Patches which do not follow them tend to 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, please make sure to read the Commit Guidelines first!
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.

To prevent SDL from catching segmentation faults (the SDL Parachute), add the following key to the configuration file under [scummvm]:

disable_sdl_parachute=true

or use command line switch

--disable-sdl-parachute

command line option.

To see a generic list of tasks that need to be done, check out the main TODO list.
AGI TODO
Cine TODO
HE Progress
Gob TODO
Residual TODO
SAGA TODO
AGOS TODO

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

@@ Line 3: / Line 3: @@
 == Writing code ==
 * The first thing you need to be able to do is [[Compiling ScummVM|Compile ScummVM]].
-* If you write code, please absolutely make sure to read about our [[Code_Formatting_Conventions |Code Formatting Conventions]]. Patches which do not follow them tend to be rejected or at least delayed until they are cleaned up to comply to them.
+* If you write code, please absolutely make sure to read about our [[Code Formatting Conventions]]. Patches which do not follow them tend to be rejected or at least delayed until they are cleaned up to comply to them.
-* If you have write access to our repository, please make sure to read the [[Commit_Guidelines|Commit Guidelines]] first!
+* Also, please read and respect the [[Portability Guide]].
+* If you have write access to our repository, please make sure to read the [[Commit Guidelines]] first!
 * If you want to provide a new Engine for ScummVM, check out our [[HOWTO-Engines|Engines HOWTO]].
 * If you want to port ScummVM to a new platform, check out our [[HOWTO-Backends |Backends HOWTO]].