Difference between revisions of "Developer Central"

From ScummVM :: Wiki
Jump to navigation Jump to search
(→‎Projects, plans, things to do: Modular backend project is mostly done, the page for it is badly outdated.)
Line 22: Line 22:
 
* [[OpenTasks|List of open tasks]], with relatively detailed descriptions, and contact points. Some rather small ones, some bigger ones, take a look.
 
* [[OpenTasks|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.
 
* [[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.
 
* [[Keymapping Improvements]] -- still in the design stage. Help is welcome.
 
* [[Music drivers redesign]] -- in phase of discussion
 
* [[Music drivers redesign]] -- in phase of discussion

Revision as of 19:02, 4 November 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

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.

Projects, plans, things to do

TODO lists

New GUI

Release Management

CVS/SVN statistics

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

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.

IRC

For all kinds of live discussions we use #scummvm @ freenode.net IRC channel. All ScummVM developers get an operator status there, so if you have some questions, talk to them. There are several notes about usage of this medium:

  • IRC is not the best place for informing everyone about some important development conclusions. I.e. when you discussed something and came up with a solution, it's best to e-mail results to scummvm-devel. That is, don't expect everyone in the team to know that you uttered something at #scummvm.
  • All developers who want to get operator status should register with NickServ. Assistance with registration is provided here.
  • Most people on FreeNode have so-called anti-spam feature turned on. That is, you will not be able to PM them unless you registered with NickServ

We have several bots living there:

  • LeChuck -- our own bot. It's primary usage is infobotting and logs.
  • lisppaste -- paste bot. It notifies when ScummVM-related pastes are posted here
  • CIA -- commit notification bot. It notifies on all commits. Further information could be found on CIA.vc site
  • cmeme -- IRCbrowse log bot. Believed to be defunct, logs were available at here

IRC logs are stored at:

Misc