[Scummvm-devel] Resource problems

Jeroen Janssen japj at darius.demon.nl
Wed Nov 21 12:52:02 CET 2001


Tom Dunstan wrote:

>> Docbook, of course. It can be processed and turned into any format you 
>> care to name.
> 
> Docbook is certainly the 'in' thing atm for documentation. The nicest 


> bunch of predefined TeX macros to make stuff look pretty. How easy is it 
> to customise the end output like that when using DocBook? I haven't used 
> it before.


> <goes off to have a play with docbook>

I don't have any 'real' experience with docbook either...

While 'everyone' goes out and experiment a bit with it, I would like to come up with some kind of a list that shows what topics should be addressed by the documentation we're going 
to write.

* 'archive' formats
* 'chunk' formats (this includes how do to decode specific information (compressed audio/video/bitmaps/etc))
* differences between chunk formats for different interpreters
* list of interpreter version & their (new) features (with a reference to the games using a specific interpreter)
* an 'general' explanation of how the scumm interpreter works (basic concepts like rooms, costumes, actors, scripts, etc)
* more indepth explanation of the scumm interpreter (how scripts are run, memory/stack layout, how everything is drawn)

With regards to possible differences between interpreters we should also have some 'namingconvention' for formats & types
(ie. if a room chunk has a different format in "all" versions we should have room_chunk_v1 .. room_chunk_vX specs)
so a possible naming convention could be to have _vX appended to a name and this _vX tells what interpreter version a chunk (format) was used/introduced in

-- 
Jeroen Janssen





More information about the Scummvm-devel mailing list