aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEugene Sandulenko2006-06-05 21:36:16 +0000
committerEugene Sandulenko2006-06-05 21:36:16 +0000
commit0c00df4d7cfe6c0f22be5c506f0ab02f8f9b9158 (patch)
tree58f627f1a2832c062ed9c4fabb001952d7c1d963 /doc
parent4297d973040af642ee3c32e993e8f197ce74a08e (diff)
downloadscummvm-rg350-0c00df4d7cfe6c0f22be5c506f0ab02f8f9b9158.tar.gz
scummvm-rg350-0c00df4d7cfe6c0f22be5c506f0ab02f8f9b9158.tar.bz2
scummvm-rg350-0c00df4d7cfe6c0f22be5c506f0ab02f8f9b9158.zip
WIP from Joachim of putting TeX documentation in sync. Please, do not modify.
It does not compile and is not finished, do not fix any errors yet. svn-id: r22947
Diffstat (limited to 'doc')
-rw-r--r--doc/about.tex11
-rw-r--r--doc/bugs.tex19
-rw-r--r--doc/contact.tex4
-rw-r--r--doc/games-bass.tex14
-rw-r--r--doc/games-c64.tex15
-rw-r--r--doc/games-copyprot.tex38
-rw-r--r--doc/games-feeble.tex7
-rw-r--r--doc/games-gob.tex13
-rw-r--r--doc/games-ite.tex26
-rw-r--r--doc/games-kyra.tex11
-rw-r--r--doc/games-mmnes.tex29
-rw-r--r--doc/games-problems.tex55
-rw-r--r--doc/games-queen.tex22
-rw-r--r--doc/games-simon.tex13
-rw-r--r--doc/games-sword.tex50
-rw-r--r--doc/games.tex131
-rw-r--r--doc/running-mac-games.tex24
-rw-r--r--doc/running-multicd.tex102
-rw-r--r--doc/running.tex4
19 files changed, 353 insertions, 235 deletions
diff --git a/doc/about.tex b/doc/about.tex
index 508c899492..d50662597a 100644
--- a/doc/about.tex
+++ b/doc/about.tex
@@ -8,14 +8,15 @@
\section{About}
ScummVM is a collection of interpreters, capable of emulating several
-adventure game engines. ScummVM mainly supports engines created using
+adventure game engines. ScummVM mainly supports games created using
SCUMM (Script Creation Utility for Maniac Mansion), used in various
-LucasArts games such as Monkey Island, Day of the Tentacle, and others.
+LucasArts games such as Monkey Island and numerous Humongous Entertainment
+games.
ScummVM also contains interpreters for several non-SCUMM games. Currently
-these are Beneath a Steel Sky, Broken Sword 1 \& 2, Flight of the Amazon Queen,
-Gobliiins, Inherit the Earth, Simon the Sorcerer 1 \& 2 and The Legend of
-Kyrandia.
+these are Beneath a Steel Sky, Broken Sword 1 and 2, Flight of the
+Amazon Queen, Gobliiins, Inherit the Earth: Quest for the Orb,
+Simon the Sorcerer 1 and 2, The Feeble Files and The Legend of Kyrandia.
At this time ScummVM should be considered beta software, and is still
under heavy development. Be aware that whilst we attempt to make sure
diff --git a/doc/bugs.tex b/doc/bugs.tex
index 11c1dc0acb..db12f4ca95 100644
--- a/doc/bugs.tex
+++ b/doc/bugs.tex
@@ -1,10 +1,19 @@
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
\subsection{Reporting Bugs} \label{sect-reporting-bugs}
To report a bug, please create a SourceForge account and follow the bugs
link from our homepage. Please make sure the bug is reproducible, and
-still occurs in the latest daily build/current CVS version. Also check
-the known bugs list (below) and compatibility listing for that game, to
-ensure the issue is not already known.
+still occurs in the latest SVN/Daily build version. Also check the known
+problems list (below) and the compatibility list on our website for that
+game, to ensure the issue is not already known:
+
+ http://www.scummvm.org/compatibility_stable.php
Also do not report bugs on games that are not listed as being completable
in the 'Supported Games' section, or compatibility list. We \textit{know} those
@@ -12,12 +21,12 @@ games have bugs.
Please include the following information:
\begin{itemize}
-\item ScummVM version (PLEASE test the latest CVS/Daily build)
+\item ScummVM version (PLEASE test the latest SVN/Daily build)
\item Bug details, including instructions on reproducing
\item Language of game (English, German, ...)
\item Version of game (talkie, floppy, ...)
\item Platform and Compiler (Win32, Linux, FreeBSD, ...)
-\item Attach a save game if possible
+\item Attach a savegame if possible
\item If this bug only occurred recently, please note the last
version without the bug, and the first version including
the bug. That way we can fix it quicker by looking at the
diff --git a/doc/contact.tex b/doc/contact.tex
index e770108988..692508d67a 100644
--- a/doc/contact.tex
+++ b/doc/contact.tex
@@ -1,7 +1,7 @@
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
@@ -9,7 +9,7 @@
The easiest way to contact the ScummVM team is by submitting bug reports or
commenting in our forums. You can also join and e-mail the scummvm-devel
-mailing list, or chat with us on IRC (\#scummvm on irc.freenode.net)
+mailing list, or chat with us on IRC (#scummvm on irc.freenode.net)
Please do not ask us to support an unsupported game -- read the FAQ on our
web site first.
diff --git a/doc/games-bass.tex b/doc/games-bass.tex
index 8ccfc6eb09..f2c7905273 100644
--- a/doc/games-bass.tex
+++ b/doc/games-bass.tex
@@ -1,7 +1,15 @@
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
\subsection{Beneath a Steel Sky notes}
-As of ScummVM 0.8.0 you need the additional SKY.CPT file to run Beneath a
-Steel Sky.
+Starting with ScummVM 0.8.0 you need the additional 'SKY.CPT' file to run
+Beneath a Steel Sky.
This file is available on the 'Compatibility' page of the ScummVM
website, you can place it in either the directory containing the other
-datafiles (SKY.DNR, SKY.DSK) or in your extrapath.
+game data files (SKY.DNR, SKY.DSK), in your extrapath, or in the directory
+where your ScummVM executable resides.
diff --git a/doc/games-c64.tex b/doc/games-c64.tex
index 490879c569..0bf1d73c89 100644
--- a/doc/games-c64.tex
+++ b/doc/games-c64.tex
@@ -1,6 +1,15 @@
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
\subsection{Commodore64 games notes}
+
Both Maniac Mansion and Zak McKracken run but Maniac Mansion is not yet
-playable. Either use extract\_mm\_c64 (but then game will not be autodetected)
-or name D64 disks as "maniac1.d64", "maniac2.d64" and "zak1.d64", "zak2.d64"
-respectively. If you add the game manually, make sure that platform is set to
+playable. Either use extract\_mm\_c64 from the tools package (but then the
+game will not be autodetected by ScummVM) or name the D64 disks as
+"maniac1.d64", "maniac2.d64" and "zak1.d64", "zak2.d64" respectively.
+If you add the game manually, make sure that the platform is set to
Commodore64.
diff --git a/doc/games-copyprot.tex b/doc/games-copyprot.tex
index a88852de87..8e4491ba22 100644
--- a/doc/games-copyprot.tex
+++ b/doc/games-copyprot.tex
@@ -1,3 +1,10 @@
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
\subsection{Copy Protection}
The ScummVM team does not condone piracy. However, there are cases when
@@ -7,26 +14,23 @@ bypasses them. There is no way for us to tell the difference between legitimate
and pirated data files, so for the games where we know the original interpreter
may have been cracked ScummVM will always have to bypass the copy protection.
-Wyrmkeep Entertainment kindly let us skip protection in floppy version of
-Inherit the Earth since it was disabled in all CD releases of the game.
+In some cases ScummVM will still show the copy protection screen. Try entering
+any answer. Chances are that it will work.
-At the time of writing, that includes the following games:
+ScummVM will skip copy protection in the following games:
\begin{tabular}{l}
-Indiana Jones \& the Last Crusade (EGA)\\
-Indiana Jones \& the Last Crusade (FM-TOWNS version)\\
-Inherit the Earth (floppy version)\\
-Loom (16 color floppy version)\\
Maniac Mansion\\
-Monkey Island 1 (EGA)\\
-Monkey Island 1 (VGA)\\
-Monkey Island 2\\
-Zak McKracken (EGA)\\
-Zak McKracken (FM-TOWNS version)\\
-\\
-Beneath a Steel Sky (bypassed with permission from Revolution)\\
-Inherit the Earth: Quest for the Orb
+Zak McKracken and the Alien Mindbenders\\
+Indiana Jones and the Last Crusade (EGA)\\
+Loom (EGA)\\
+The Secret of Monkey Island (EGA)\\
+The Secret of Monkey Island (VGA)\\
+Monkey Island 2: LeChuck's Revenge\\
\end{tabular}
-In some cases ScummVM will still show the copy protection screen. Try entering
-any answer. Chances are that it will work.
+Beneath a Steel Sky bypassed with kind permission from Revolution Software.
+
+Inherit the Earth: Quest for the Orb (Floppy version) bypassed with kind
+permission from Wyrmkeep Entertainment, since it was bypassed in all CD
+releases of the game.
diff --git a/doc/games-feeble.tex b/doc/games-feeble.tex
index 5567ceb495..9ac2e4159a 100644
--- a/doc/games-feeble.tex
+++ b/doc/games-feeble.tex
@@ -1,3 +1,10 @@
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
\subsection{The Feeble Files notes}
If you have the Windows version of The Feeble Files, there are two things to
note. First of all, more than 300 files, most of them necessary for the game to
diff --git a/doc/games-gob.tex b/doc/games-gob.tex
index 13b17aa191..4ef7d4ab26 100644
--- a/doc/games-gob.tex
+++ b/doc/games-gob.tex
@@ -1,3 +1,12 @@
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
\subsection{Gobliiins notes}
-CD version of Gobliiins contains one big audio track which needs to be ripped
-and copied into game directory. See section \ref{sect-compressing-audiofiles}.
+The CD version of Gobliiins contains one big audio track which you need to rip
+(See the section on using compressed audio files) and copy into the game
+directory if you want to have in-game music without the CD in the drive
+all the time.
diff --git a/doc/games-ite.tex b/doc/games-ite.tex
index 82ba4e83b7..7a8e8456d5 100644
--- a/doc/games-ite.tex
+++ b/doc/games-ite.tex
@@ -1,16 +1,24 @@
-\subsection{Inherit the Earth notes}
-In order to run MacOS X wyrmkeep rerelease of the game you will need to copy
-over data from the CD to hard drive. If you're on PC then consult
-\url{http://www.scummvm.org/documentation.php?view=maccd-howto}
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
-Although it talks about SCUMM games, it describes HFVExplorer utility. Note
-that you will need to put speech data "Inherit the Earth Voices" in same
-directory as game data which is stored in
+
+\subsection{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 drive. If you're on a PC then consult:
+
+ \url{http://wiki.scummvm.org/index.php/HOWTO-Mac_Games}
+
+Although it primarily talks about SCUMM games, it mentions the "HFVExplorer"
+utility which you need to extract the files.
+Note that you have to put the speech data "Inherit the Earth Voices" in the
+same directory as the game data which is stored in:
\begin{verbatim}
Inherit the Earth.app/Contents/Resources
\end{verbatim}
-For old Mac OS9 release you will need to copy files in MacBinary format,
-i.e. they should have both resource and data forks. Just copy all 'ITE *' files.
+For the old Mac OS 9 release you need to copy the files in MacBinary format,
+as they should include both resource and data forks. Copy all 'ITE *' files.
diff --git a/doc/games-kyra.tex b/doc/games-kyra.tex
index 4acd681be0..8c9c3ab50d 100644
--- a/doc/games-kyra.tex
+++ b/doc/games-kyra.tex
@@ -1,3 +1,10 @@
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
\subsection{The Legend of Kyrandia notes}
-To run The Legend of Kyrandia under ScummVM you need the kyra.dat file,
-which can be found in the Downloads section of the ScummVM website.
+To run The Legend of Kyrandia under ScummVM you need the 'kyra.dat' file,
+which can be found in the downloads section of the ScummVM website.
diff --git a/doc/games-mmnes.tex b/doc/games-mmnes.tex
index ed32aae2ba..e38f19f47d 100644
--- a/doc/games-mmnes.tex
+++ b/doc/games-mmnes.tex
@@ -1,24 +1,33 @@
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
\subsection{Maniac Mansion NES notes}
-Supported versions are English USA (E), French (F), German (G), Swedish (SW)
-and European (U). ScummVM requires just PRG section to run and not whole ROM.
+
+Supported versions are English GB (E), French (F), German (G), Swedish (SW)
+and English US (U).
+ScummVM requires just the PRG section to run and not the whole ROM.
In order to get the game working, you will have to strip out the first
16 bytes from the ROM you are trying to work with. Any hex editor will work
as long as you are able to copy/paste. After you open the ROM with the
-hex editor, copy everything from second row (17th byte) to the end. After
-you do this, paste it to a new hex file. Give the new file name
-"Maniac Mansion (XX).prg" where XX depends on version you are working
+hex editor, copy everything from the second row (17th byte) to the end.
+After you do this, paste it to a new hex file. Name the new file
+"Maniac Mansion (XX).prg" while XX stands for the version you are working
with (E, F, G, SW, or U). The final size should be exactly 262144 bytes.
-If you add game manually make sure that platform is set to NES.
+If you add the game manually make sure that the platform is set to NES.
-Most common mistakes which prevent game from running:
+Most common mistakes which prevents the game from running:
\begin{itemize}
\item Bad file
\item ROM extracted with the 0.7.0 tools
- \item You try to feed ScummVM with the FULL rom and not just the PRG section.
+ \item You try to feed ScummVM with the FULL ROM and not just the PRG section.
\end{itemize}
-Also it is possible to extract separate LFL files from PRG section. Use
-extract\_mm\_nes utility from tools package.
+It is also possible to extract the separate LFL files from the PRG section.
+To do so use the extract\_mm\_nes utility from the tools package.
diff --git a/doc/games-problems.tex b/doc/games-problems.tex
index 10707646ac..a228fea597 100644
--- a/doc/games-problems.tex
+++ b/doc/games-problems.tex
@@ -1,43 +1,44 @@
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
+
\subsection{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 bug that is not
-listed here, nor in the compatibility table on the web site, please see
-section \ref{sect-reporting-bugs}.
+listed here, nor in the compatibility list on the web site, please see
+the section on reporting bugs. \ref{sect-reporting-bugs}.
CD Audio Games:
\begin{itemize}
- \item When playing games that use CD Audio (Towns variants, Loom CD, etc),
- users of Microsoft Windows 2000/XP may experience random crashes.
- This is due to a long-standing Windows bug, resulting in corrupt
- game files being read from the CD. Please copy the game data to
- your harddrive to avoid this.
+ \item When playing games that use CD Audio (FM-TOWNS games, Loom CD, etc)
+ users of Microsoft Windows 2000/XP may experience random crashes.
+ This is due to a long-standing Windows bug, resulting in corrupt
+ game files being read from the CD. Please copy the game data to
+ your harddrive to avoid this.
\end{itemize}
-FM-TOWNS versions:
+FM-TOWNS Versions:
\begin{itemize}
- \item Kanji versions require the FM-TOWNS Font ROM
- \end{itemize}
-Humongous Entertainment Games
- \begin{itemize}
- \item No support for printing images
+ \item The Kanji versions require the FM-TOWNS Font ROM
+ \item ScummVM will crash randomly when using the FM-TOWNS Font ROM for
+ the Kanji versions of the following games:
+ The Secret of Monkey Island, Monkey Island 2: LeChuck's Revenge
+ and Indiana Jones and the Fate of Atlantis
\end{itemize}
Loom (EGA):
-Monkey Island 1 (EGA):
+The Secret of Monkey Island (EGA):
\begin{itemize}
\item MIDI support requires the Roland update from LucasArts
\end{itemize}
Beneath a Steel Sky:
\begin{itemize}
\item Amiga versions aren't supported
- \item Floppy demo aren't supported
- \item Not a bug: CD version is missing speech for some dialog, this is
- normal
+ \item Floppy demos aren't supported
+ \item Not a bug: CD version is missing speech for some dialogs, this is
+ normal.
\end{itemize}
Broken Sword 1:
\begin{itemize}
@@ -54,24 +55,28 @@ Flight of the Amazon Queen:
\end{itemize}
Inherit the Earth:
\begin{itemize}
- \item Amiga versions aren't supported
+ \item Amiga CD version isn't supported
\end{itemize}
Simon the Sorcerer 1:
\begin{itemize}
\item Amiga versions aren't supported
- \item Subtitles aren't available in the English and German CD versions,
- they are missing the majority of subtitles.
+ \item Subtitles aren't available in the English and German CD versions
+ as they are missing the majority of subtitles.
\end{itemize}
Simon the Sorcerer 2:
\begin{itemize}
\item Combined speech and subtitles will often cause speech to be
- cut off early, this is limitation of original game.
- \item Only default language (English) in data files is supported
- in Amiga and Macintosh versions.
+ cut off early, this is a limitation of the original game.
+ \item Only default language (English) of data files is supported
+ in Amiga and Macintosh versions.
\end{itemize}
The Feeble Files
\begin{itemize}
\item Subtitles are often imcomplete, they were always disabled in the
- original game.
+ original game.
+ \end{itemize}
+Humongous Entertainment Games
+ \begin{itemize}
+ \item No support for printing images
\end{itemize}
diff --git a/doc/games-queen.tex b/doc/games-queen.tex
index e56d77ab07..0797ca36ba 100644
--- a/doc/games-queen.tex
+++ b/doc/games-queen.tex
@@ -1,11 +1,19 @@
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
\subsection{Flight of the Amazon Queen notes}
-In order to use a non-freeware version of Flight of the Amazon Queen (i.e.
-your own), you will need to have the 'queen.tbl' file (available from the
+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 (available from the
Compatibility page on our website) in either the directory containing the
-'queen.1' datafile or in the directory where your ScummVM executable resides.
-
-Alternatively, you can use the 'compress\_queen' tool from the Tools module to
-'rebuild' your FOTAQ datafile to include the table for that specific version,
-and thus removing the run-time dependency on the 'queen.tbl' file.
+'queen.1' game data file, in your extrapath, or in the directory where your
+ScummVM executable resides.
+
+Alternatively, you can use the 'compress\_queen' tool from the tools package to
+'rebuild' your FOTAQ data file to include the table for that specific version,
+and thus removing the run-time dependency on the 'queen.tbl' file.
This tool also allows you to compress the speech and sound effects with MP3,
OGG or FLAC.
diff --git a/doc/games-simon.tex b/doc/games-simon.tex
index 0f701240cb..e87e341678 100644
--- a/doc/games-simon.tex
+++ b/doc/games-simon.tex
@@ -1,4 +1,11 @@
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
\subsection{Simon the Sorcerer 1 and 2 notes}
-If you have the dual version of Simon the Sorcerer 1 or 2 on CD,
-then you will find the Windows version in the main directory of the CD
-and the DOS Talkie version in the DOS directory of the CD.
+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.
diff --git a/doc/games-sword.tex b/doc/games-sword.tex
index d97bdce597..45d519b4d1 100644
--- a/doc/games-sword.tex
+++ b/doc/games-sword.tex
@@ -1,14 +1,56 @@
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
\subsection {Broken Sword notes}
-Broken Sword 1 and 2 both come with in-game cutscenes compressed using
+Broken Sword 1 and 2 both come with in-game cutscenes compressed using
RAD Game Tools legacy Smacker(tm) format. As RAD is unwilling to open
the older legacy versions of this format to us, and have requested we not
reverse engineer it, Revolution Software has kindly allowed us to provide
-re-encoded Broken Sword cutscenes for download on our website.
+re-encoded Broken Sword cutscenes for download on our website:
+
+ http://www.scummvm.org/downloads.php
These cutscenes are provided in MPEG2 format with OGG Vorbis audio.
-Viewing these cutscenes thus requires a version of ScummVM compiled
+Viewing these cutscenes thus requires a version of ScummVM compiled
with both libmpeg2 (preferably 0.4.0 or greater) and libVorbis support.
The cutscenes should be placed in the main game data directory. Note that
-currently this requires either copying the game to harddisk or reburning
+currently this requires either copying the game to hard disk or reburning
customised versions of the game CDs.
+
+The instructions for the Broken Sword games are for the Sold-Out Software
+versions, which are the ones you are probably most likely to find in stores
+now.
+
+\subsubsection{Broken Sword 1}
+For this game, you'll need all of the files from the clusters directories on
+both CDs. You will also need the speech.clu files from the speech directories,
+but since they are not identical you'll need to rename them speech1.clu and
+speech2.clu for CD 1 and 2 respectively.
+
+In addition, you will need a music subdirectory with all of the files from the
+music subdirectories on both CDs. Some of these files appear on both CDs, but
+in these cases they are either identical or, in one case, so nearly identical
+that it makes little difference.
+
+ScummVM does not support the original cutscene files, so there is no need to
+copy them.
+
+\subsubsection{Broken Sword 2}
+For this game, you'll need all of the files from the clusters directories on
+both CDs. (Actually, a few of them may not be strictly necessary, but the ones
+that I'm uncertain about are all fairly small.) You will need to rename the
+speech.clu and music.clu files speech1.clu, speech2.clu, music1.clu and
+music2.clu so that ScummVM can tell which ones are from CD 1 and which ones are
+from CD 2. Any other files that appear in both cluster directories are
+identical. Use whichever you like.
+
+In addition, you will need the cd.bin, cd.inf and startup.inf files from the
+sword2 directory on CD 1.
+
+ScummVM does not support the original cutscene files, so there is no need to
+copy them.
diff --git a/doc/games.tex b/doc/games.tex
index c22f22c9bb..72aee249be 100644
--- a/doc/games.tex
+++ b/doc/games.tex
@@ -1,21 +1,21 @@
%%% Local Variables:
%%% mode: latex
-%%% TeX-master: "readme"
+%%% TeX-master: "readme.tex"
%%% End:
\section{Supported Games}
At the moment the following games have been reported to work, and should
-be playable to the end.
+be playable to the end:
\begin{itemize}
\item SCUMM Games by LucasArts:\\
\begin {tabular} [h] {ll}
Maniac Mansion& [maniac]\\
Zak McKracken and the Alien Mindbenders& [zak]\\
- Indiana Jones \& the Last Crusade& [indy3]\\
+ Indiana Jones and the Last Crusade& [indy3]\\
Loom& [loom]\\
The Secret of Monkey Island& [monkey]\\
Monkey Island 2: LeChuck's Revenge& [monkey2]\\
@@ -26,41 +26,6 @@ be playable to the end.
The Dig& [dig]\\
The Curse of Monkey Island& [comi]\\
\end{tabular}
-\item SCUMM Games by Humongous Entertainment:\\
- \begin{tabular}[h]{ll}
- Backyard Football& [football]\\
- Big Thinkers Kindergarten& [thinkerk]\\
- Fatty Bear's Birthday Surprise& [fbear]\\
- Fatty Bear's Fun Pack& [fbpack]\\
- Freddi Fish 1: The Case of the Missing Kelp Seeds& [freddi]\\
- Freddi Fish 2: The Case of the Haunted Schoolhouse& [fredd2]\\
- Freddi Fish 3: The Case of the Stolen Conch Shell& [freddi3]\\
- Freddi Fish 4: The Case of the Hogfish Rustlers of Briny Gulch&[freddi4]\\
- Freddi Fish and Luther's Maze Madness& [maze]\\
- Freddi Fish and Luther's Water Worries& [water]\\
- Let's Explore the Airport with Buzzy& [airport]\\
- Let's Explore the Farm with Buzzy& [farm]\\
- Let's Explore the Jungle with Buzzy& [jungle]\\
- Pajama Sam 1: No Need to Hide When It's Dark Outside& [pajama]\\
- Pajama Sam 2: Thunder and Lightning Aren't so Frightening& [pajama2]\\
- Pajama Sam 3: You Are What You Eat From Your Head to Your Feet&[pajama3]\\
- Pajama Sam's Lost \& Found& [lost]\\
- Pajama Sam's Sock Works& [socks]\\
- Putt-Putt Enters the Race& [puttrace]\\
- Putt-Putt Goes To The Moon& [puttmoon]\\
- Putt-Putt Joins the Circus& [puttcircus]\\
- Putt-Putt Joins the Parade& [puttputt]\\
- Putt-Putt Saves the Zoo& [puttzoo]\\
- Putt-Putt Travels Through Time& [putttime]\\
- Putt-Putt and Pep's Balloon-O-Rama& [balloon]\\
- Putt-Putt and Pep's Dog on a Stick& [dog]\\
- Putt-Putt \& Fatty Bear's Activity Pack& [activity]\\
- Putt-Putt's Fun Pack& [funpack]\\
- SPY Fox 1: Dry Cereal& [spyfox]\\
- SPY Fox 2: Some Assembly Required& [spyfox2]\\
- SPY Fox in Cheese Chase& [chase]\\
- SPY Fox in Hold the Mustard& [mustard]\\
- \end{tabular}
\item Other Games:\\
\begin{tabular}[h]{ll}
Beneath a Steel Sky& [sky]\\
@@ -74,49 +39,99 @@ be playable to the end.
The Feeble Files& [feeble]\\
The Legend of Kyrandia& [kyra1]\\
\end{tabular}
+\item SCUMM Games by Humongous Entertainment:\\
+ \begin{tabular}[h]{ll}
+ Backyard Football& [football]\\
+ Big Thinkers Kindergarten& [thinkerk]\\
+ Fatty Bear's Birthday Surprise& [fbear]\\
+ Fatty Bear's Fun Pack& [fbpack]\\
+ Freddi Fish 1: The Case of the Missing
+ Kelp Seeds& [freddi]\\
+ Freddi Fish 2: The Case of the Haunted
+ Schoolhouse& [freddi2]\\
+ Freddi Fish 3: The Case of the Stolen
+ Conch Shell& [freddi3]\\
+ Freddi Fish 4: The Case of the Hogfish
+ Rustlers of Briny Gulch& [freddi4]\\
+ Freddi Fish and Luther's Maze Madness& [maze]\\
+ Freddi Fish and Luther's Water Worries& [water]\\
+ Let's Explore the Airport with Buzzy& [airport]\\
+ Let's Explore the Farm with Buzzy& [farm]\\
+ Let's Explore the Jungle with Buzzy& [jungle]\\
+ Pajama Sam 1: No Need to Hide When It's
+ Dark Outside& [pajama]\\
+ Pajama Sam 2: Thunder and Lightning
+ Aren't so Frightening& [pajama2]\\
+ Pajama Sam 3: You Are What You Eat
+ From Your Head to Your Feet& [pajama3]\\
+ Pajama Sam's Lost \& Found& [lost]\\
+ Pajama Sam's Sock Works& [socks]\\
+ Putt-Putt Enters the Race& [puttrace]\\
+ Putt-Putt Goes to the Moon& [puttmoon]\\
+ Putt-Putt Joins the Circus& [puttcircus]\\
+ Putt-Putt Joins the Parade& [puttputt]\\
+ Putt-Putt Saves the Zoo& [puttzoo]\\
+ Putt-Putt Travels Through Time& [putttime]\\
+ Putt-Putt and Pep's Balloon-O-Rama& [balloon]\\
+ Putt-Putt and Pep's Dog on a Stick& [dog]\\
+ Putt-Putt \& Fatty Bear's Activity Pack& [activity]\\
+ Putt-Putt's Fun Pack& [funpack]\\
+ SPY Fox 1: Dry Cereal& [spyfox]\\
+ SPY Fox 2: Some Assembly Required& [spyfox2]\\
+ SPY Fox in Cheese Chase& [chase]\\
+ SPY Fox in Hold the Mustard& [mustard]\\
+ \end{tabular}
- The following games should load, but are not yet fully playable. Play these at your own risk, and please do not file bug reports about them. If you want
+The following games should load, but are not yet fully playable. Play these at
+your own risk, and please do not file bug reports about them. If you want
the latest updates on game compatibility, visit our web site and view the
compatibility chart.
-\begin{tabular}{ll}
- Backyard Baseball& [baseball]\\
- Backyard Soccer& [soccer]\\
- Big Thinkers First Grade& [thinker1]\\
- SPY Fox 3: Operation Ozone& [spyozon]\\
-\end{tabular}
+ \begin{tabular}{ll}
+ Backyard Baseball& [baseball]\\
+ Backyard Soccer& [soccer]\\
+ Big Thinkers First Grade& [thinker1]\\
+ SPY Fox 3: Operation Ozone& [spyozon]\\
+ \end{tabular}
+
+The following games are SCUMM engine, but NOT supported by ScummVM (yet):
- The following games are SCUMM engine, but NOT supported by ScummVM (yet).
\begin{itemize}
\item Other Humongous Entertainment titles
\end{itemize}
-%
+
Please be aware that the engine may contain bugs and unimplemented features
that sometimes make it impossible to finish the game. Save often, and please
-file a bug report (instructions on submitting bug reports are below) if you
+file a bug report (instructions on submitting bug reports are above) if you
encounter such a bug in a 'supported' game.
+
\end{itemize}
+
%% next section
\input {games-copyprot.tex}
%% next section
-\input {games-simon.tex}
+\input {games-c64.tex}
+%% next section
+\input {games-mmnes.tex}
+%% next section
+\input {running-mac-games.tex}
+%% next section
+\input {running-multicd.tex}
%% next section
\input {games-sword.tex}
%% next section
+\input {games-bass.tex}
+%% next section
\input {games-queen.tex}
%% next section
-\input {games-bass.tex}
+\input {games-gob.tex}
%next section
\input {games-ite.tex}
%% next section
-\input {games-gob.tex}
-%next section
+\input {games-simon.tex}
+%% next section
\input {games-feeble.tex}
-%next section
+%% next section
\input {games-kyra.tex}
-%next section
-\input {games-mmnes.tex}
-%next section
-\input {games-c64.tex}
-%next section
+%% next section
\input {games-problems.tex}
diff --git a/doc/running-mac-games.tex b/doc/running-mac-games.tex
index 920cf09115..41a94f01ec 100644
--- a/doc/running-mac-games.tex
+++ b/doc/running-mac-games.tex
@@ -1,8 +1,16 @@
-\subsection {Using data files from Macintosh game versions}
-All LucasArts SCUMM based adventures except CMI also exist in versions for the
-Macintosh. ScummVM can use most (all?) of them, however, in some case some
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
+\subsection {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 cases some
additional work is required. First off, if you are not using a Macintosh for
-this, accessing the CD/floppy data might be tricky, since the mac uses a
+this, accessing the CD/floppy data might be tricky, since the mac uses a
special disk format called HFS which other systems usually do not support.
However, there are various free tools on the net which allow reading such HFS
volumes (for example "HFVExplorer" for Windows and "hfsutils" for Linux and
@@ -11,7 +19,7 @@ other Unix-like operating systems).
Secondly, most of the newer games shipped only with a single data file on the
Macintosh. You used to have to manually convert that data file, but this is no
longer necessary, as ScummVM can now open and understand the format natively.
-%%% Local Variables:
-%%% mode: latex
-%%% TeX-master: "readme"
-%%% End:
+
+See also:
+
+ http://wiki.scummvm.org/index.php/HOWTO-Mac_Games
diff --git a/doc/running-multicd.tex b/doc/running-multicd.tex
index ceab5649a6..b417e319c4 100644
--- a/doc/running-multicd.tex
+++ b/doc/running-multicd.tex
@@ -1,69 +1,35 @@
-\subsection{Multi-CD Games}
-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
-directory. Even if ScummVM does make some provisions for asking the
-user to change CD, the original games usually install a small number
-of files to hard disk. Unless these files can be found on all the CDs,
-ScummVM will be in trouble.
-
-Fortunately, ScummVM has no problems running the games entirely from
-hard disk, if you create a directory with the correct combination of
-files. Usually, when a file appears on more than one CD you can pick
-either of them.
-
-These instructions are written for the PC versions (which in some case
-is the only version) of the games. Windows and DOS use
-case-insensitive file systems, so if one CD has a file called
-MONKEY.DAT and another has a file called monkey.dat, they are the same
-files. These instructions give file names in all lower-case names,
-even if that's not always how they appear on the CDs. In fact, on
-case-sensitive file systems you will have to make sure that all
-filenames use either all upper- or all lower-case letters for ScummVM
-to be able to find the files.
-
-The instructions for the Broken Sword games are for the Sold-Out
-Software versions, which are the ones you are probably most likely to
-find in stores now.
-
-
-\subsubsection{The Curse of Monkey Island}
-For this game, you'll need the comi.la0, comi.la1 and comi.la2 files.
-The comi.la0 file can be found on either CD, but since they are
-identical it doesn't matter which one of them you use.
-
-In addition, you'll need a resource subdirectory with all of the files
-from the resource subdirectories on both CDs. Some of the files appear
-on both CDs, but again they're identical.
-
-\subsubsection{Broken Sword 1}
-For this game, you'll need all of the files from the clusters
-directories on both CDs. You will also need the speech.clu files from
-the speech directories, but since they are not identical you'll need
-to rename them speech1.clu and speech2.clu for CD 1 and 2
-respectively.
-
-In addition, you will need a music subdirectory with all of the files
-from the music subdirectories on both CDs. Some of these files appear
-on both CDs, but in these cases they are either identical or, in one
-case, so nearly identical that it makes little difference.
-
-ScummVM does not support the original cutscene files, so there is no
-need to copy them.
-
-\subsubsection{Broken Sword 2}
-
-For this game, you'll need all of the files from the clusters
-directories on both CDs. (Actually, a few of them may not be strictly
-necessary, but the ones that I'm uncertain about are all fairly
-small.) You will need to rename the speech.clu and music.clu files
-speech1.clu, speech2.clu, music1.clu and music2.clu so that ScummVM
-can tell which ones are from CD 1 and which ones are from CD 2. Any
-other files that appear in both cluster directories are identical. Use
-whichever you like.
-
-In addition, you will need the cd.bin, cd.inf and startup.inf files
-from the sword2 directory on CD 1.
-
-ScummVM does not support the original cutscene files, so there is no
-need to copy them.
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme.tex"
+%%% End:
+
+
+\subsection{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 directory.
+Even if ScummVM does make some provisions for asking the user to change CD, the
+original games usually install a small number of files to the hard disk. Unless
+these files can be found on all the CDs, ScummVM will be in trouble.
+
+Fortunately, ScummVM has no problems running the games entirely from hard disk,
+if you create a directory with the correct combination of files. Usually, when
+a file appears on more than one CD you can pick either of them.
+
+These instructions are written for the PC versions (which in some case is the
+only version) of the games. Windows and DOS use case-insensitive file systems,
+so if one CD has a file called MONKEY.DAT and another has a file called
+monkey.dat, they are the same files. These instructions give file names in all
+lower-case names, even if that's not always how they appear on the CDs. In
+fact, on case-sensitive file systems you will have to make sure that all
+filenames use either all upper- or all lower-case letters for ScummVM to be
+able to find the files.
+
+\subsubsection{The Curse of Monkey Island notes}
+For this game, you'll need the comi.la0, comi.la1 and comi.la2 files. The
+comi.la0 file can be found on either CD, but since they are identical it
+doesn't matter which one of them you use.
+
+In addition, you'll need a resource subdirectory with all of the files from the
+resource subdirectories on both CDs. Some of the files appear on both CDs, but
+again they're identical.
diff --git a/doc/running.tex b/doc/running.tex
index d52a5ae367..ccd82e50fb 100644
--- a/doc/running.tex
+++ b/doc/running.tex
@@ -33,7 +33,3 @@ arguments -- see the next section.
\input {running-graphics-filters.tex}
%next section
\input {running-hotkeys.tex}
-%next section
-\input {running-mac-games.tex}
-%next section
-\input {running-multicd.tex}