README: Describe DOTT easter egg support. Text by eriktorbjorn.

1 files changed, 67 insertions, 44 deletions

diff --git a/README b/README
index 5b0569089c..b78ee24dfd 100644
--- a/README
+++ b/README
@@ -15,26 +15,27 @@ Table of Contents:
  * 2.1 Reporting Bugs
 3.0) Supported Games
  * 3.1 Copy Protection
- * 3.2 Commodore64 games notes
- * 3.3 Maniac Mansion NES notes
- * 3.4 Macintosh games notes
- * 3.5 Multi-CD games notes
- * 3.6 The Curse of Monkey Island notes
- * 3.7 Broken Sword games notes
- * 3.8 Beneath a Steel Sky notes
- * 3.9 Flight of the Amazon Queen notes
- * 3.10 Gobliiins notes
- * 3.11 Inherit the Earth: Quest for the Orb notes
- * 3.12 Simon the Sorcerer notes
- * 3.13 The Feeble Files notes
- * 3.14 The Legend of Kyrandia notes
- * 3.15 Sierra AGI games Predictive Input Dialog notes
- * 3.16 Mickey's Space Adventure notes
- * 3.17 Winnie the Pooh notes
- * 3.18 Troll's Tale notes
- * 3.19 Dragon History notes
- * 3.20 Simultaneous speech and subtitles in Sierra SCI games
- * 3.21 Known Problems
+ * 3.2 Day of the Tentacle notes
+ * 3.3 Commodore64 games notes
+ * 3.4 Maniac Mansion NES notes
+ * 3.5 Macintosh games notes
+ * 3.6 Multi-CD games notes
+ * 3.7 The Curse of Monkey Island notes
+ * 3.8 Broken Sword games notes
+ * 3.9 Beneath a Steel Sky notes
+ * 3.10 Flight of the Amazon Queen notes
+ * 3.11 Gobliiins notes
+ * 3.12 Inherit the Earth: Quest for the Orb notes
+ * 3.13 Simon the Sorcerer notes
+ * 3.14 The Feeble Files notes
+ * 3.15 The Legend of Kyrandia notes
+ * 3.16 Sierra AGI games Predictive Input Dialog notes
+ * 3.17 Mickey's Space Adventure notes
+ * 3.18 Winnie the Pooh notes
+ * 3.19 Troll's Tale notes
+ * 3.20 Dragon History notes
+ * 3.21 Simultaneous speech and subtitles in Sierra SCI games
+ * 3.22 Known Problems
 4.0) Supported Platforms
 5.0) Running ScummVM
  * 5.1 Command Line Options
@@ -410,7 +411,29 @@ ScummVM will skip copy protection in the following games:
   * Zak McKracken and the Alien Mindbenders
 
 
-3.2) Commodore64 games notes:
+3.2) Day of the Tentacle notes:
+---- --------------------------
+
+At one point in the game, you come across a computer that allows you
+to play the original Maniac Mansion as an easter egg. ScummVM supports
+this, with a few caveats:
+
+ScummVM will scan your configuration file for a game that's in a
+'Maniac' sub-folder of your Day of the Tentacle folder. If you've
+copied the data files from the CD version, this should already be the
+case but you have to add the game to ScummVM as well.
+
+To return to Day of the Tentacle, press F5 and select "Return to
+Launcher".
+
+This means that you could in theory use any game as the easter egg.
+Indeed, there is a "secret" configuration setting, "easter_egg", to
+override the ID of the game to run. Be aware, though, that not all
+games support returning to the launcher, and setting it up to use Day
+of the Tentacle itself as the easter egg game is not recommended.
+
+
+3.3) Commodore64 games notes:
 ---- ------------------------
 Both Maniac Mansion and Zak McKracken run but Maniac Mansion is not yet
 playable. Simply name the D64 disks "maniac1.d64" and "maniac2.d64"
@@ -424,7 +447,7 @@ to Commodore64. We recommend using the much simpler approach described
 in the previous paragraph.
 
 
-3.3) Maniac Mansion NES notes:
+3.4) Maniac Mansion NES notes:
 ---- -------------------------
 Supported versions are English GB (E), French (F), German (G), Italian (I),
 Swedish (SW) and English US (U). ScummVM requires just the PRG section
@@ -453,7 +476,7 @@ section. To do so use the 'extract_mm_nes' utility from the tools
 package.
 
 
-3.4) Macintosh games notes:
+3.5) Macintosh games notes:
 ---- ----------------------
 All LucasArts SCUMM based adventures, except COMI, also exist in versions
 for the Macintosh. ScummVM can use most (all?) of them, however, in some
@@ -481,7 +504,7 @@ disk see:
   http://wiki.scummvm.org/index.php/HOWTO-Mac_Games
 
 
-3.5) Multi-CD games notes:
+3.6) Multi-CD games notes:
 ---- ---------------------
 In general, ScummVM does not deal very well with Multi-CD games. This is
 because ScummVM assumes everything about a game can be found in one
@@ -496,7 +519,7 @@ files. Usually, when a file appears on more than one CD you can pick
 either of them.
 
 
-3.6) The Curse of Monkey Island notes:
+3.7) The Curse of Monkey Island notes:
 ---- ---------------------------------
 For this game, you will need the comi.la0, comi.la1 and comi.la2 files.
 The comi.la0 file can be found on either CD, but since they are
@@ -508,7 +531,7 @@ two CDs. Some of the files appear on both CDs, but again they're
 identical.
 
 
-3.7) Broken Sword games notes:
+3.8) Broken Sword games notes:
 ---- -------------------------
 The instructions for the Broken Sword games are for the Sold-Out
 Software versions, with each game on two CDs, since these were the
@@ -517,7 +540,7 @@ them. Hopefully they are general enough to be useful to other releases
 as well.
 
 
-3.7.1) Broken Sword games cutscenes:
+3.8.1) Broken Sword games cutscenes:
 ------ -----------------------------
 The cutscenes for the Broken Sword games have a bit of a history (see
 the next section, if you are interested), but in general all you need to
@@ -558,7 +581,7 @@ currently does not work when running PlayStation videos. (Broken Sword
 II already has subtitles; no extra work is needed for them.)
 
 
-3.7.2) Broken Sword games cutscenes, in retrospect:
+3.8.2) Broken Sword games cutscenes, in retrospect:
 ------ --------------------------------------------
 The original releases of the Broken Sword games used RAD Game Tools's
 Smacker(tm) format. As RAD was unwilling to open the older legacy
@@ -583,7 +606,7 @@ decoding MPEG movies added a lot of complexity, and they didn't look as
 good as the Smacker and DXA versions anyway.
 
 
-3.7.3) Broken Sword:
+3.8.3) Broken Sword:
 ------ -------------
 For this game, you will need all of the files from the clusters
 directories on both CDs. For the Windows and Macintosh versions, you
@@ -600,7 +623,7 @@ makes little difference. The PlayStation version requires tunes.dat and
 tunes.tab.
 
 
-3.7.4) Broken Sword II:
+3.8.4) Broken Sword II:
 ------ ----------------
 For this game, you will need all of the files from the clusters
 directories on both CDs. (Actually, a few of them may not be strictly
@@ -615,7 +638,7 @@ In addition, you will need the cd.inf and, optionally, the startup.inf
 files from the sword2 directory on CD 1.
 
 
-3.8) Beneath a Steel Sky notes:
+3.9) Beneath a Steel Sky notes:
 ---- --------------------------
 Starting with ScummVM 0.8.0 you need the additional 'SKY.CPT' file to
 run Beneath a Steel Sky.
@@ -626,7 +649,7 @@ files (SKY.DNR, SKY.DSK), in your extrapath, or in the directory where
 your ScummVM executable resides.
 
 
-3.9) Flight of the Amazon Queen notes:
+3.10) Flight of the Amazon Queen notes:
 ---- ---------------------------------
 In order to use a non-freeware version of Flight of the Amazon Queen
 (from original CD), you will need to place the 'queen.tbl' file
@@ -641,7 +664,7 @@ specific version, and thus removing the run-time dependency on the
 sound effects with MP3, OGG or FLAC.
 
 
-3.10) Gobliiins notes:
+3.11) Gobliiins notes:
 ----- ----------------
 The CD versions of the Gobliiins series contain one big audio track
 which you need to rip (see the section on using compressed audio files)
@@ -651,7 +674,7 @@ track and its volume is therefore changed with the music volume control
 as well.
 
 
-3.11) Inherit the Earth: Quest for the Orb notes:
+3.12) Inherit the Earth: Quest for the Orb notes:
 ----- -------------------------------------------
 In order to run the Mac OS X Wyrmkeep re-release of the game you will
 need to copy over data from the CD to your hard disk. If you're on a PC
@@ -671,14 +694,14 @@ format, as they should include both resource and data forks. Copy all
 'ITE *' files.
 
 
-3.12) Simon the Sorcerer 1 and 2 notes:
+3.13) Simon the Sorcerer 1 and 2 notes:
 ----- ---------------------------------
 If you have the dual version of Simon the Sorcerer 1 or 2 on CD, you
 will find the Windows version in the main directory of the CD and the
 DOS version in the DOS directory of the CD.
 
 
-3.13) The Feeble Files notes:
+3.14) The Feeble Files notes:
 ----- -----------------------
 If you have the Windows version of The Feeble Files, there are several
 things to note.
@@ -696,7 +719,7 @@ Rename voices.wav on CD3 to voices3.wav
 Rename voices.wav on CD4 to voices4.wav
 
 
-3.14) The Legend of Kyrandia notes:
+3.15) The Legend of Kyrandia notes:
 ----- -----------------------------
 To run The Legend of Kyrandia under ScummVM you need the 'kyra.dat'
 file. The file should always be included in official ScummVM packages.
@@ -707,7 +730,7 @@ thus you only need to grab it in case ScummVM complains about the file
 being missing.
 
 
-3.15) Sierra AGI games Predictive Input Dialog notes:
+3.16) Sierra AGI games Predictive Input Dialog notes:
 ----- -----------------------------------------------
 The Predictive Input Dialog is a ScummVM aid for running AGI engine
 games (which notoriously require command line input) on devices with
@@ -761,7 +784,7 @@ naturally mapping the functionality to the numeric keypad. Also, the
 dialog's buttons can be navigated with the arrow and the enter keys.
 
 
-3.16) Mickey's Space Adventure notes:
+3.17) Mickey's Space Adventure notes:
 ----- -------------------------------
 To run Mickey's Space Adventure under ScummVM, the original executable
 of the game (mickey.exe) is needed together with the game's data files.
@@ -776,7 +799,7 @@ game's screen to change location, similar to many adventure games, which
 is simpler and more straightforward than moving around using the menu.
 
 
-3.17) Winnie the Pooh notes:
+3.18) Winnie the Pooh notes:
 ----- ----------------------
 It is possible to import saved games from the original interpreter of the
 game into ScummVM.
@@ -791,14 +814,14 @@ game's screen to change location, similar to many adventure games, which
 is simpler and more straightforward than moving around using the menu.
 
 
-3.18) Troll's Tale notes:
+3.19) Troll's Tale notes:
 ----- -------------------
 The original game came in a PC booter disk, therefore it is necessary to
 dump the contents of that disk in an image file and name it "troll.img"
 to be able to play the game under ScummVM.
 
 
-3.19) Dragon History notes:
+3.20) Dragon History notes:
 ----- ---------------------
 There are 4 language variants of the game: Czech, English, Polish and
 German.  Each of them is distributed in a separate archive.  The only
@@ -816,7 +839,7 @@ All game files and the walkthrough can be downloaded from
 http://www.ucw.cz/draci-historie/index-en.html
 
 
-3.20) Simultaneous speech and subtitles in Sierra SCI games:
+3.21) Simultaneous speech and subtitles in Sierra SCI games:
 ----- ------------------------------------------------------
 Certain CD versions of Sierra SCI games had both speech and text
 resources. Some have an option to toggle between the two, but there are
@@ -864,7 +887,7 @@ Space Quest 4 CD:
     options dialog, or via ScummVM's audio options.
 
 
-3.21) Known Problems:
+3.22) Known Problems:
 ----- ---------------
 This release has the following known problems. There is no need to
 report them, although patches to fix them are welcome. If you discover a