[Scummvm-cvs-logs] CVS: web/docs bootparam.xml,1.8,1.9

Wed Mar 9 13:33:55 CET 2005

Update of /cvsroot/scummvm/web/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv15410

Modified Files:
	bootparam.xml 
Log Message:
Give some more information on boot params

Index: bootparam.xml
===================================================================
RCS file: /cvsroot/scummvm/web/docs/bootparam.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -r1.8 -r1.9

--- bootparam.xml	6 Mar 2005 21:42:56 -0000	1.8
+++ bootparam.xml	9 Mar 2005 21:33:35 -0000	1.9
@@ -2,14 +2,59 @@
 <DESC>A partial list of the bootparams of some SCUMM games.</DESC>
 <BODY>
 	<h1>SCUMM boot params</h1>
-<!-- TODO: Explain what a boot param is, how to use them with ScummVM, that they are useful for debugging etc.... -->
-<!-- TODO: Add more bootparams -->
+
+<h2>What are boot params?</h2>
+<p>
+A boot param is a special number which allows you (if used appropriately, see below)
+to get directly to specific part of a game. These boot params are mostly useful
+for debugging and play testing a game; you get teleported to a certain situation
+in a game, with some of the items appropriate for it. It is not always possible to
+continue and complete a game from this, because you may lack important items. But
+for us developers, it's very helpful, because we can quickly get to trouble spots
+in a clean state, and try to reproduce any bugs you report to us.
+</p>
+<p>
+These boot params do not exist by chance or magic: they were put into the game data
+by the original developers of the games, and where meant for exactly the same
+purpose we use them for: to help in debugging the game. Of course, they also make
+a nice cheat system (with some caveats, as I tried to outline above).
+</p>
+
+
+<h2>How do I use a boot param?</h2>
+That's quite simple: pick a game from the list, and a boot param for it. Then, you specify
+it on the command line like this:
+<pre>
+	./scummvm -d0 -b BOOTPARAM TARGET
+</pre>
+To be a bit more specific: Let's say you want to get into the hut of the cannibals in 
+Monkey Island 1. Well, the table below tells us that this is boot param 5555. So, enter
+this on the command line:
+<pre>
+	./scummvm -d0 -b 5555 monkey
+</pre>
+(By the way, this would also work with <code>monkey</code>, <code>monkeyvga</code> etc.).
+
+
+<h2>How did we generate these tables?</h2>
 
 <p>Some of these lists are based on the output of <code>./scummvm -d1 -b1 TARGET</code>; some information is also from
    <a href="http://www.scummbar.com/resources/articles/index.php?newssniffer=readarticle&article=1027">this article</a>.
    In particular, they may contains some mistakes. 
    Ultimately we plan to correct these and maybe enhance the descriptions a bit...</p>
 
+<h2>I see a lot of question marks in some of the tables, why?</h2>
+<p>
+Some of the games contain descriptions for the boot params; some don't. In the latter case,
+we have to manually fill in the descriptions. This hasn't been done in all cases yet, as you can see.
+</p>
+<p>
+Help here is welcome -- if you want, feel free to fill in some of the gaps and
+<a href="contact.php">send us</a> your work, we'll be happy to integrate it here.
+</p>
+
+<h2>Quick access list</h2>
+
 <ul>
 <li><a href="#monkey">The Secret of Monkey Island</a></li>
 <li><a href="#monkey2">Monkey Island 2: LeChuck's revenge</a></li>
@@ -22,6 +67,8 @@
 <!-- <li><a href="#TARGET">FOO</a></li> -->
 </ul>
 
+
+
 <br><a name="monkey"></a>
 <h2>The Secret of Monkey Island</h2>
 



