From 87c3aa27afce797317286f3eae9b8d588ae6445b Mon Sep 17 00:00:00 2001 From: Max Horn Date: Thu, 6 Apr 2006 22:06:03 +0000 Subject: Started to rename the LaTeX files based on their content instead of their numbering (which changes all the time anyway) svn-id: r21649 --- doc/01.tex | 26 ----- doc/02.tex | 16 --- doc/03.tex | 119 --------------------- doc/04.tex | 56 ---------- doc/05.tex | 39 ------- doc/06.tex | 32 ------ doc/07.tex | 44 -------- doc/08.tex | 146 -------------------------- doc/09.tex | 84 --------------- doc/10.tex | 305 ------------------------------------------------------ doc/about.tex | 26 +++++ doc/audio.tex | 44 ++++++++ doc/compiling.tex | 84 +++++++++++++++ doc/config.tex | 146 ++++++++++++++++++++++++++ doc/contact.tex | 16 +++ doc/credits.tex | 305 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/games.tex | 119 +++++++++++++++++++++ doc/platforms.tex | 56 ++++++++++ doc/readme.tex | 20 ++-- doc/running.tex | 39 +++++++ doc/saves.tex | 32 ++++++ 21 files changed, 877 insertions(+), 877 deletions(-) delete mode 100644 doc/01.tex delete mode 100644 doc/02.tex delete mode 100644 doc/03.tex delete mode 100644 doc/04.tex delete mode 100644 doc/05.tex delete mode 100644 doc/06.tex delete mode 100644 doc/07.tex delete mode 100644 doc/08.tex delete mode 100644 doc/09.tex delete mode 100644 doc/10.tex create mode 100644 doc/about.tex create mode 100644 doc/audio.tex create mode 100644 doc/compiling.tex create mode 100644 doc/config.tex create mode 100644 doc/contact.tex create mode 100644 doc/credits.tex create mode 100644 doc/games.tex create mode 100644 doc/platforms.tex create mode 100644 doc/running.tex create mode 100644 doc/saves.tex diff --git a/doc/01.tex b/doc/01.tex deleted file mode 100644 index 508c899492..0000000000 --- a/doc/01.tex +++ /dev/null @@ -1,26 +0,0 @@ - -%%% Local Variables: -%%% mode: latex -%%% TeX-master: "readme.tex" -%%% End: - - -\section{About} - -ScummVM is a collection of interpreters, capable of emulating several -adventure game engines. ScummVM mainly supports engines created using -SCUMM (Script Creation Utility for Maniac Mansion), used in various -LucasArts games such as Monkey Island, Day of the Tentacle, and others. - -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. - -At this time ScummVM should be considered beta software, and is still -under heavy development. Be aware that whilst we attempt to make sure -that many games can be completed with few major bugs, crashes can happen. - -If you enjoy ScummVM feel free to donate using the PayPal button on the -ScummVM homepage. This will help us buy utilities needed to develop ScummVM -easier and quicker. If you cannot donate, help and contribute a patch! diff --git a/doc/02.tex b/doc/02.tex deleted file mode 100644 index 2b102a99f8..0000000000 --- a/doc/02.tex +++ /dev/null @@ -1,16 +0,0 @@ - -%%% Local Variables: -%%% mode: latex -%%% TeX-master: "readme" -%%% End: - - -\section{Contacting} - -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) -Please do not ask us to support an unsupported game -- read the FAQ on our -web site first. - -\input {02_01.tex} diff --git a/doc/03.tex b/doc/03.tex deleted file mode 100644 index 987b75d115..0000000000 --- a/doc/03.tex +++ /dev/null @@ -1,119 +0,0 @@ - -%%% Local Variables: -%%% mode: latex -%%% TeX-master: "readme" -%%% End: - - -\section{Supported Games} - -At the moment the following games have been reported to work, and should -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]\\ - Loom& [loom]\\ - The Secret of Monkey Island& [monkey]\\ - Monkey Island 2: LeChuck's Revenge& [monkey2]\\ - Indiana Jones and the Fate of Atlantis& [atlantis]\\ - Day of the Tentacle& [tentacle]\\ - Sam \& Max Hit the Road& [samnmax]\\ - Full Throttle& [ft]\\ - 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]\\ - Broken Sword 1: The Shadow of the Templars& [sword1]\\ - Broken Sword 2: The Smoking Mirror& [sword2]\\ - Flight of the Amazon Queen& [queen]\\ - Gobliiins& [gob1]\\ - Inherit the Earth: Quest for the Orb& [ite]\\ - The Legend of Kyrandia& [kyra1]\\ - Simon the Sorcerer 1& [simon1]\\ - Simon the Sorcerer 2& [simon2]\\ - \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 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} - - 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 -encounter such a bug in a 'supported' game. -\end{itemize} -%% next section -\input {03_01.tex} -%% next section -\input {03_02.tex} -%% next section -\input {03_03.tex} -%% next section -\input {03_04.tex} -%% next section -\input {03_05.tex} -%next section -\input {03_06.tex} -%% next section -\input {03_07.tex} -%next section -\input {03_08.tex} -%next section -\input {03_09.tex} -%next section -\input {03_10.tex} -%next section -\input {03_11.tex} diff --git a/doc/04.tex b/doc/04.tex deleted file mode 100644 index 462bb53a78..0000000000 --- a/doc/04.tex +++ /dev/null @@ -1,56 +0,0 @@ - -%%% Local Variables: -%%% mode: latex -%%% TeX-master: "readme" -%%% End: - -\section{Supported Platforms} -ScummVM has been ported to run on many platforms and operating systems. -Links to these ports can be found either on the ScummVM web page or by a -Google search. Many thanks to the effort of porters. If you have a port of -ScummVM and wish to commit it into the main CVS, feel free to contact us! - -Supported platforms include (but are not limited to): - -\begin{tabular}{ll} -UNIX &(Linux, Solaris, IRIX, *BSD)\\ -Windows \\ -Windows Mobile &(iPAQ and other handheld devices)\\ -Mac OS X \\ -AmigaOS \\ -BeOS \\ -Dreamcast \\ -PalmOS \\ -Playstation 2 \\ -Playstation Portable\\ -RISC OS \\ -Symbian \\ -\end{tabular} - -The Dreamcast port does not support Curse of Monkey Island, nor The Dig. -The PalmOS port does not support Curse of Monkey Island, Beneath a Steel -Sky, nor either Simon the Sorcerer 1 or 2. The Dig will only work on some -Palm devices (those with a large dynamic heap). - -In the Macintosh port, the right mouse button is emulated via Cmd-Click (that -is, you click the mouse button while holding the Command/Apple/Propeller key). - -For the following platforms, custom backends were supported at one point -but currently are not being maintained (usually due to lack of a qualified -maintainer). In some cases (e.g. Linux), the standard SDL support works -instead. - -\begin{tabular}{ll} -MorphOS\\ -GP32 \\ -Linux \\ -\end{tabular} - -We have reports about unofficial ports to the following platforms. Please -note that this are not made by us, so we neither endorse nor support them. -Use at your own risk! - -\begin{tabular}{ll} -Nintendo DS\\ -Xbox \\ -\end{tabular} diff --git a/doc/05.tex b/doc/05.tex deleted file mode 100644 index d68e763790..0000000000 --- a/doc/05.tex +++ /dev/null @@ -1,39 +0,0 @@ - -%%% Local Variables: -%%% mode: latex -%%% TeX-master: "readme" -%%% End: - - -\section{Running ScummVM} - -Before you run the engine, you need to put the game's datafiles in a -directory. The filenames must not be in mixed case on *nix systems -(for example, these are valid names: ``monkey2.000'', ``MONKEY2.000'', while -this is a bad one: "Monkey2.000"). If you use a game with speech, the file -monster.sou must reside in the same directory as the datafiles. - -Please note that by default, ScummVM will save games in the directory -it is executed from, so you should refrain from running it from more than -one location. Further information, including how to specify a specific save -directory to avoid this issue, are in section 6.0. - -ScummVM can be launched directly by running the executable. In this case, -the in-built launcher will activate. From this, you can add games (click -'Add Game'), or launch games which have already been configured. - -ScummVM can also be launched into a game directly using Command Line -arguments -- see the next section. - -%next section -\input {05_01.tex} -%next section -\input {05_02.tex} -%next section -\input {05_03.tex} -%next section -\input {05_04.tex} -%next section -\input {05_05.tex} -%next section -\input {05_06.tex} diff --git a/doc/06.tex b/doc/06.tex deleted file mode 100644 index 3cfb466109..0000000000 --- a/doc/06.tex +++ /dev/null @@ -1,32 +0,0 @@ -\section {Savegames} -Savegames are by default put in the current directory on some platforms and -preset directories on others. You can specify the save in the config file by -setting the savepath parameter. See the example config file later in this -readme. - -The platforms that currently have a different default directory are: -% -\begin{itemize} -\item Mac OS X: \verb#$HOME/Documents/ScummVM Savegames/# -\item Other unices: \verb#$HOME/.scummvm/# -\end{itemize} -% -You can also use the environment variable SCUMMVM\_SAVEPATH to specify where to -put save games. Don't forget the trailing directory separator. Also be aware -that saved games may break between ScummVM releases. - -Bash (Unix) example: -\begin{verbatim} - export SCUMMVM_SAVEPATH=/tmp/scummvm_savegames/ -\end{verbatim} -Windows example: -\begin{verbatim} - set SCUMMVM_SAVEPATH=C:\saved_games\ -\end{verbatim} - -%%next section -\input {06_01.tex} -%%% Local Variables: -%%% mode: latex -%%% TeX-master: "readme" -%%% End: diff --git a/doc/07.tex b/doc/07.tex deleted file mode 100644 index fc36b8c8d1..0000000000 --- a/doc/07.tex +++ /dev/null @@ -1,44 +0,0 @@ - -%%% Local Variables: -%%% mode: latex -%%% TeX-master: "readme" -%%% End: - -\section{Music and Sound} \label{sect-music-and-sound} -By default, on most operating systems, ScummVM will automatically use Adlib -emulation. MIDI may not be available on all operating systems or may need -manual configuration. If you ARE using MIDI, you have several different -choices of output, depending on your operating system and configuration. - -\begin{tabular}[h]{ll} - null & Null output. Don't play any music.\\ - & \\ - adlib & Uses internal Adlib Emulation (default)\\ - fluidsynth & Uses FluidSynth MIDI Emulation\\ - mt32 & Uses internal MT-32 Emulation\\ - pcjr & Uses internal PCjr Emulation \\ - pcspk & Uses internal PC Speaker Emulation\\ - towns & Uses FM-TOWNS YM2612 Emulation\\ - & \\ - alsa & Output using ALSA sequencer device. See below.\\ - core & CoreAudio sound, for Mac OS X users.\\ - coremidi & CoreMIDI sound, for Mac OS X users. Use only if you have a hardware MIDI synthesizer.\\ - qt & Quicktime sound, for Macintosh users.\\ - seq & Uses /dev/sequencer for MIDI, *nix users. See below.\\ - windows & Windows MIDI. Uses built-in sequencer, for Windows users\\ -\end{tabular} - -To select a sound driver, pass its name via the '-e' option to scummvm, -for example: -\begin{verbatim} - scummvm -e adlib monkey2 -\end{verbatim} - -\input {07_01.tex} -\input {07_02.tex} -\input {07_03.tex} -\input {07_04.tex} -\input {07_05.tex} -\input {07_06.tex} -\input {07_07.tex} -\input {07_08.tex} diff --git a/doc/08.tex b/doc/08.tex deleted file mode 100644 index e2e44c7bc8..0000000000 --- a/doc/08.tex +++ /dev/null @@ -1,146 +0,0 @@ - -%%% Local Variables: -%%% mode: latex -%%% TeX-master: "readme" -%%% End: - -\section{Configurations Files} - - -By default, the configuration file is saved in, and loaded from: -% -\begin{itemize} -\item Windows: \verb#\scummvm.ini# -\item Unix: \verb#~/.scummvmrc# -\item Mac OS X: \verb#~/Library/Preferences/ScummVM Preferences# -\item Others: \verb#scummvm.ini# in the current directory -\end{itemize} -% -An example config file looks as follows: -% -\begin{verbatim} - [scummvm] - gfx_mode=supereagle - fullscreen=true - savepath=C:\saves\ - - [sky] - path=C:\games\SteelSky\ - - [germansky] - gameid=sky - language=de - path=C:\games\SteelSky\ - description=Beneath a Steel Sky w/ German subtitles - - [germandott] - gameid=tentacle - path=C:\german\tentacle\ - description=German version of DOTT - - [tentacle] - path=C:\tentacle\ - subtitles=true - music_volume=40 - sfx_volume=255 - - [loomcd] - cdrom=1 - path=C:\loom\ - talkspeed=5 - savepath=C:\loom\saves\ - - [monkey2] - path=C:\amiga_mi2\ - music_driver=windows -\end{verbatim} -% -The following keywords are recognized: - -\begin{tabular}[hf]{lll} - basename &string\\ - path &string The path to where a game's data files are\\ - read\_only &bool If true, ScummVM will never try to overwrite\\ - & the configuration file.\\ - autosave\_period&number The seconds between autosaving (default: 300) - save\_slot &number The save game number to load on startup.\\ - savepath &string The path to where a game will store its\\ - & savegames.\\ - versioninfo &string The version of the ScummVM that created the\\ - & configuration file.\\ -\\ - gameid &string The real id of a game. Useful if you have\\ - & several versions of the same game, and want\\ - & different aliases for them. See the example.\\ - description &string The description of the game as it will appear\\ - & in the launcher.\\ -\\ - language &string Specify language (en, de, fr, it, pt, es, jp,\\ - & zh, kr, se, gb, hb, cz, ru)\\ - speech\_mute &bool &If true, speech is muted\\ - subtitles &bool Set to true to enable subtitles.\\ - talkspeed &number Text speed\\ -\\ - fullscreen &bool Fullscreen mode\\ - aspect\_ratio &bool Enable aspect ratio correction\\ - gfx\_mode &string Graphics mode (normal, 2x, 3x, 2xsai,\\ - & super2xsai, supereagle, advmame2x, advmame3x,\\ - & hq2x, hq3x, tv2x, dotmatrix)\\ -\\ - cdrom &number Number of CD-ROM unit to use for audio. If\\ - & negative, don't even try to access the CD-ROM.\\ - joystick\_num &number Number of joystick device to use for input\\ - music\_driver &string The music engine to use.\\ - output\_rate &number The output sample rate to use, in Hz. Sensible\\ - & values are 11025, 22050 and 44100.\\ - alsa\_port &string Port to use for output when using the\\ - & ALSA music driver.\\ - music\_volume &number The music volume setting (0-255)\\ - multi\_midi &bool If true, enable combination Adlib and native\\ - & MIDI.\\ - soundfont &string The SoundFont to use for MIDI playback. (Only\\ - & supported by some MIDI drivers.)\\ - native\_mt32 &bool If true, disable GM emulation and assume that\\ - & there is a true Roland MT-32 available.\\ - enable\_gs &bool If true, enable Roland GS-specific features to\\ - & enhance GM emulation. If native\_mt32 is also\\ - & true, the GS device will select an MT-32 map\\ - & to play the correct instruments.\\ - sfx\_volume &number The sfx volume setting (0-255)\\ - tempo &number The music tempo (50-200) (default: 100)\\ - speech\_volume &number The speech volume setting (0-255)\\ - midi\_gain &number The MIDI gain (0-1000) (default: 100) (Only\\ - & supported by some MIDI drivers.)\\ -\\ - copy\_protection&bool Enable copy protection in SCUMM games, when\\ - & ScummVM disables it by default.\\ - demo\_mode &bool Start demo in Maniac Mansion\\ - alt\_intro &bool Use alternative intro for CD versions of \\ - & Beneath a Steel Sky and Flight of the Amazon\\ - & Queen -\\ - boot\_param &number Pass this number to the boot script\\ -\end{tabular} - -Broken Sword 2 adds the following non-standard keywords:\\ -\begin{tabular}[h]{lll} - gfx\_details &number &Graphics details setting (0-3)\\ - music\_mute &bool &If true, music is muted\\ - object\_labels &bool &If true, object labels are enabled\\ - reverse\_stereo &bool &If true, stereo channels are reversed\\ - sfx\_mute &bool &If true, sound effects are muted\\ -\end{tabular} - -Flight of the Amazon Queen adds the following non-standard keywords:\\ -\begin{tabular}[h]{lll} - music\_mute &bool &If true, music is muted\\ - sfx\_mute &bool &If true, sound effects are muted\\ -\end{tabular} - -Simon the Sorcerer 1 \& 2 add the following non-standard keywords:\\ -\begin{tabular}[h]{lll} - fade &bool &If true, fade effect is enabled\\ - music\_mute &bool &If true, music is muted\\ - slow\_down &number &Makes games slower (1- 10)\\ - sfx\_mute &bool &If true, sound effects are muted\\ -\end{tabular} diff --git a/doc/09.tex b/doc/09.tex deleted file mode 100644 index 1b1e3adfb3..0000000000 --- a/doc/09.tex +++ /dev/null @@ -1,84 +0,0 @@ - -%%% Local Variables: -%%% mode: latex -%%% TeX-master: "readme" -%%% End: - -\section{Compiling} - -You need SDL-1.2.2 or newer (older versions may work, but are unsupported), and -a supported compiler. Several compilers, including GCC, mingw and Microsoft -Visual C++ are supported. If you wish to use MP3-compressed CD tracks or -.SOU files, you will need to install the MAD library and define -USE\_MAD. Tools for compressing .SOU files to .SO3 files can be -found in the 'tools' SVN module, or in the 'scummvm-tools' package. - -Some parts of ScummVM, particularly scalers, have highly optimized versions -written in assembler. If you wish to use this option, you will need to install -nasm assembler (see \url{http://nasm.sf.net}). Note, that currently we have only x86 -MMX optimized versions, and they will not compile on other processors. - -On Win9x/NT/XP you can define USE\_WINDBG and attach WinDbg to browse debug -messages (see \url{http://www.sysinternals.com/ntw2k/freeware/debugview.shtml}). - -\subsection{GCC} - \begin{itemize} - \item Type \texttt{./configure} - \item Type \texttt{make} (or \texttt{gmake}, or \texttt{gnumake}, depending - on what GNU make is called on your system) and hopefully ScummVM will - compile for you. - \end{itemize} -\subsection{Microsoft Visual C++ 6.0} - \begin{itemize} - \item Open the workspace, scummwm.dsw - \item Enter the path to the needed libraries and includes in - Tools|Options|Directories - \item Now it should compile successfully. - \end{itemize} -\subsection{Microsoft Visual C++ 7.0} - \begin{itemize} - \item Open the solution file scummwm.sln - \item Enter the path to the needed libraries and includes in - Tools|Options|Directories - \item Now it should compile successfully. - \end{itemize} -\subsection{Windows Mobile with Microsoft eMbedded Visual C++ 3 or 4} - \begin{itemize} - \item Download SDL with additional Windows Mobile tweaks:\\ - \url{http://arisme.free.fr/ports/SDL.php} - \item Download additional third party libraries:\\ - \url{http://arisme.free.fr/ports} - \item Modify your include and library paths accordingly in EVC3/EVC4. - \item Open the ScummVM project dists$\backslash$msevc4$\backslash$PocketSCUMM.vcw - \item Modify the libraries and config parameters if necessary. - \item Now it should compile successfully. - \end{itemize} -\subsection{Debian GNU/Linux} - \begin{itemize} - \item Install the packages 'build-essential', 'fakeroot', 'debhelper', - and 'libsdl1.2-dev' on your system. - \item nstall any of these packages (optional): 'libvorbis-dev' (for Ogg - Vorbis support), 'libasound2-dev' (for ALSA sequencer support), - 'libmad0-dev' (for MAD MP3 support), 'zlib1g-dev' (for compressed - saves support). - \item Run 'make deb' - \item Finally run 'dpkg -i ../scummvm-cvs*deb', and you're done. - \end{itemize} -\subsection{Mac OS X} -\begin{itemize} -\item Make sure you have the developer tools installed. -\item The SDL developer package for OS X available on the SDL web site is - \textit{not} suitable. Rather, you require a unix-style build of SDL. One - way to get that is to install SDL via Fink\\ - (\url{http://fink.sf.net}). - - Alternatively you could compile SDL manually from source using its - unix build system\\ - (\texttt{configure \&\& make}). -\item Type \texttt{./configure} in the ScummVM directory -\item You can now type \texttt{make} to create a command line binary. -\item To get a version you can run from Finder, type \texttt{make bundle} which - will create ScummVM.app (this only works if you installed SDL - etc. via Fink and into /sw. If you have installed SDL in another - way, you'll have to edit the Makefile). -\end{itemize} diff --git a/doc/10.tex b/doc/10.tex deleted file mode 100644 index a0301fbc13..0000000000 --- a/doc/10.tex +++ /dev/null @@ -1,305 +0,0 @@ -% This file was generated by credits.pl. Do not edit by hand! -\section{Credits} -\begin{trivlist} -\item \textbf{\LARGE ScummVM Team} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \textbf{\large Project Leaders} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - James Brown & \textit{}\\ - Max Horn & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{\large Engine Teams} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \textbf{ SCUMM} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Torbj\"orn Andersson & \textit{}\\ - James Brown & \textit{}\\ - Jonathan Gray & \textit{}\\ - Max Horn & \textit{}\\ - Travis Howell & \textit{}\\ - Pawe{\l} Ko{\l}odziejski & \textit{Codecs, iMUSE, Smush, etc.}\\ - Eugene Sandulenko & \textit{FT INSANE, MM NES, MM C64, game detection, Herc/CGA}\\ - \end{tabular} -\end{list} -\item \textbf{ HE} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Jonathan Gray & \textit{}\\ - Travis Howell & \textit{}\\ - Gregory Montoir & \textit{}\\ - Eugene Sandulenko & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ BASS} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Robert G\"offringmann & \textit{}\\ - Oliver Kiehl & \textit{}\\ - Joost Peters & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ Broken Sword 1} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Robert G\"offringmann & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ Broken Sword 2} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Torbj\"orn Andersson & \textit{}\\ - Jonathan Gray & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ Cinematique evo 1} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Pawe{\l} Ko{\l}odziejski & \textit{}\\ - Gregory Montoir & \textit{}\\ - Eugene Sandulenko & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ FOTAQ} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - David Eriksson & \textit{}\\ - Gregory Montoir & \textit{}\\ - Joost Peters & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ Gob} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Torbj\"orn Andersson & \textit{}\\ - Sven Hesse & \textit{}\\ - Willem Jan Palenstijn & \textit{}\\ - Eugene Sandulenko & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ Kyra} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Oystein Eftevaag & \textit{}\\ - Gregory Montoir & \textit{}\\ - Johannes Schickel & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ SAGA} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Torbj\"orn Andersson & \textit{}\\ - Andrew Kurushin & \textit{}\\ - Eugene Sandulenko & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ Simon} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Travis Howell & \textit{}\\ - Oliver Kiehl & \textit{}\\ - \end{tabular} -\end{list} -\end{list} -\item \textbf{\large Backend Teams} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \textbf{ Dreamcast} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Marcus Comstedt & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ SymbianOS} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Jurgen Braam & \textit{}\\ - Lars Persson & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ PalmOS} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Chris Apers & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ PocketPC / WinCE} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Nicolas Bacca & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ Playstation 2} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Robert G\"offringmann & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ PSP (PlayStation Portable)} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Joost Peters & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ SDL (Win/Linux/OS X/etc.)} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Max Horn & \textit{}\\ - Eugene Sandulenko & \textit{Asm routines, GFX layers}\\ - \end{tabular} -\end{list} -\end{list} -\item \textbf{\large Other subsystems} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Jerome Fisher & \textit{MT-32 emulator}\\ - Jochen Hoenicke & \textit{Speaker \& PCjr sound support, Adlib work}\\ - \end{tabular} -\end{list} -\item \textbf{\large Website (content)} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item -All active team members -\end{list} -\item \textbf{\large Retired Team Members} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Tore Anderson & \textit{Former Debian GNU/Linux maintainer}\\ - Ralph Brorsen & \textit{Help with GUI implementation}\\ - Jamieson Christian & \textit{iMUSE, MIDI, all things musical}\\ - Vincent Hamm & \textit{Co-Founder, original CinE engine author}\\ - Ruediger Hanke & \textit{Port: MorphOS}\\ - Felix Jakschitsch & \textit{Zak256 reverse engineering}\\ - Mutwin Kraus & \textit{Original MacOS porter}\\ - Peter Moraliyski & \textit{Port: GP32}\\ - Jeremy Newman & \textit{Former webmaster}\\ - Ludvig Strigeus & \textit{Original ScummVM and SimonVM author}\\ - Lionel Ulmer & \textit{Port: X11}\\ - \end{tabular} -\end{list} -\end{list} -\item \textbf{\LARGE Other contributions} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \textbf{\large Packages} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \textbf{ AmigaOS 4} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Hans-J\"org Frieden & \textit{}\\ - Juha Niemim\"aki & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ BeOS} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Stefan Parviainen & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ Debian GNU/Linux} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - David Weinehall & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ Fedora / RedHat} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Willem Jan Palenstijn & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ Mac OS X} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Max Horn & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ OS/2} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Paul Smedley & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ PocketPC 2002} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Kostas Nakos & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ SlackWare} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Robert Kelsen & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ Win32} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Travis Howell & \textit{}\\ - \end{tabular} -\end{list} -\item \textbf{ Win64} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Chris Gray & \textit{}\\ - \end{tabular} -\end{list} -\end{list} -\item \textbf{\large Website (design)} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Dob\'o Bal\'azs & \textit{Website design}\\ - Yaroslav Fedevych & \textit{HTML/CSS for the website}\\ - David Jensen & \textit{SVG logo conversion}\\ - Jean Marc & \textit{ScummVM logo}\\ - \end{tabular} -\end{list} -\item \textbf{\large Code contributions} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Stuart Caie & \textit{Decoders for Simon 1 Amiga data files}\\ - Paolo Costabel & \textit{PSP port contributions}\\ - Janne Huttunen & \textit{V3 actor mask support, Dig/FT SMUSH audio}\\ - Kov\'acs Endre J\'anos & \textit{Several fixes for Simon1}\\ - Jeroen Janssen & \textit{Numerous readability and bugfix patches}\\ - Andreas Karlsson & \textit{Initial port for EPOC/SymbianOS}\\ - Claudio Matsuoka & \textit{Daily Linux builds}\\ - Thomas Mayer & \textit{PSP port contributions}\\ - Mikesch Nepomuk & \textit{MI1 VGA floppy patches}\\ - Nicolas Noble & \textit{Config file and ALSA support}\\ - Quietust & \textit{Sound support for Amiga SCUMM V2/V3 games, MM NES support}\\ - Andreas R\"over & \textit{Broken Sword 1/2 MPEG2 cutscene support}\\ - Edward Rudd & \textit{Fixes for playing MP3 versions of MI1/Loom audio}\\ - Daniel Schepler & \textit{Final MI1 CD music support, initial Ogg Vorbis support}\\ - Andr\'e Souza & \textit{SDL-based OpenGL renderer}\\ - Tim ??? & \textit{Initial MI1 CD music support}\\ - \end{tabular} -\end{list} -\item -And to all the contributors, users, and beta testers we've missed. Thanks! -\end{list} -\item \textbf{\LARGE Special thanks to} -\begin{list}{}{\setlength{\leftmargin}{0.2cm}} -\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} - Sander Buskens & \textit{For his work on the initial reversing of Monkey2}\\ - Canadacow & \textit{For the original MT-32 emulator}\\ - Kevin Carnes & \textit{For Scumm16, the basis of ScummVM's older gfx codecs}\\ - Ivan Dubrov & \textit{For contributing the initial version of the Gobliiins engine}\\ - Joachim Eberhard & \textit{For numerous contributions to documentation}\\ - Jezar & \textit{For his freeverb filter implementation}\\ - Jim Leiterman & \textit{Various info on his FM-TOWNS/Marty SCUMM ports}\\ - lloyd & \textit{For deep tech details about C64 Zak \& MM}\\ - Jimmi Th{\o}gersen & \textit{For ScummRev, and much obscure code/documentation}\\ - Tristan & \textit{For additional work on the original MT-32 emulator}\\ - \end{tabular} -\item -Tony Warriner and everyone at Revolution Software Ltd. for sharing with us the source of some of their brilliant games, allowing us to release Beneath a Steel Sky as freeware... and generally being supportive above and beyond the call of duty. -\item -John Passfield and Steve Stamatiadis for sharing the source of their classic title, Flight of the Amazon Queen and also being incredibly supportive. -\item -Joe Pearce from The Wyrmkeep Entertainment Co. for sharing the source of their famous title Inherit the Earth and always prompt replies to our questions. -\item -Aric Wilmunder, Ron Gilbert, David Fox, Vince Lee, and all those at LucasFilm/LucasArts who made SCUMM the insane mess to reimplement that it is today. Feel free to drop us a line and tell us what you think, guys! -\end{list} -\end{trivlist} - diff --git a/doc/about.tex b/doc/about.tex new file mode 100644 index 0000000000..508c899492 --- /dev/null +++ b/doc/about.tex @@ -0,0 +1,26 @@ + +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "readme.tex" +%%% End: + + +\section{About} + +ScummVM is a collection of interpreters, capable of emulating several +adventure game engines. ScummVM mainly supports engines created using +SCUMM (Script Creation Utility for Maniac Mansion), used in various +LucasArts games such as Monkey Island, Day of the Tentacle, and others. + +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. + +At this time ScummVM should be considered beta software, and is still +under heavy development. Be aware that whilst we attempt to make sure +that many games can be completed with few major bugs, crashes can happen. + +If you enjoy ScummVM feel free to donate using the PayPal button on the +ScummVM homepage. This will help us buy utilities needed to develop ScummVM +easier and quicker. If you cannot donate, help and contribute a patch! diff --git a/doc/audio.tex b/doc/audio.tex new file mode 100644 index 0000000000..fc36b8c8d1 --- /dev/null +++ b/doc/audio.tex @@ -0,0 +1,44 @@ + +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "readme" +%%% End: + +\section{Music and Sound} \label{sect-music-and-sound} +By default, on most operating systems, ScummVM will automatically use Adlib +emulation. MIDI may not be available on all operating systems or may need +manual configuration. If you ARE using MIDI, you have several different +choices of output, depending on your operating system and configuration. + +\begin{tabular}[h]{ll} + null & Null output. Don't play any music.\\ + & \\ + adlib & Uses internal Adlib Emulation (default)\\ + fluidsynth & Uses FluidSynth MIDI Emulation\\ + mt32 & Uses internal MT-32 Emulation\\ + pcjr & Uses internal PCjr Emulation \\ + pcspk & Uses internal PC Speaker Emulation\\ + towns & Uses FM-TOWNS YM2612 Emulation\\ + & \\ + alsa & Output using ALSA sequencer device. See below.\\ + core & CoreAudio sound, for Mac OS X users.\\ + coremidi & CoreMIDI sound, for Mac OS X users. Use only if you have a hardware MIDI synthesizer.\\ + qt & Quicktime sound, for Macintosh users.\\ + seq & Uses /dev/sequencer for MIDI, *nix users. See below.\\ + windows & Windows MIDI. Uses built-in sequencer, for Windows users\\ +\end{tabular} + +To select a sound driver, pass its name via the '-e' option to scummvm, +for example: +\begin{verbatim} + scummvm -e adlib monkey2 +\end{verbatim} + +\input {07_01.tex} +\input {07_02.tex} +\input {07_03.tex} +\input {07_04.tex} +\input {07_05.tex} +\input {07_06.tex} +\input {07_07.tex} +\input {07_08.tex} diff --git a/doc/compiling.tex b/doc/compiling.tex new file mode 100644 index 0000000000..1b1e3adfb3 --- /dev/null +++ b/doc/compiling.tex @@ -0,0 +1,84 @@ + +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "readme" +%%% End: + +\section{Compiling} + +You need SDL-1.2.2 or newer (older versions may work, but are unsupported), and +a supported compiler. Several compilers, including GCC, mingw and Microsoft +Visual C++ are supported. If you wish to use MP3-compressed CD tracks or +.SOU files, you will need to install the MAD library and define +USE\_MAD. Tools for compressing .SOU files to .SO3 files can be +found in the 'tools' SVN module, or in the 'scummvm-tools' package. + +Some parts of ScummVM, particularly scalers, have highly optimized versions +written in assembler. If you wish to use this option, you will need to install +nasm assembler (see \url{http://nasm.sf.net}). Note, that currently we have only x86 +MMX optimized versions, and they will not compile on other processors. + +On Win9x/NT/XP you can define USE\_WINDBG and attach WinDbg to browse debug +messages (see \url{http://www.sysinternals.com/ntw2k/freeware/debugview.shtml}). + +\subsection{GCC} + \begin{itemize} + \item Type \texttt{./configure} + \item Type \texttt{make} (or \texttt{gmake}, or \texttt{gnumake}, depending + on what GNU make is called on your system) and hopefully ScummVM will + compile for you. + \end{itemize} +\subsection{Microsoft Visual C++ 6.0} + \begin{itemize} + \item Open the workspace, scummwm.dsw + \item Enter the path to the needed libraries and includes in + Tools|Options|Directories + \item Now it should compile successfully. + \end{itemize} +\subsection{Microsoft Visual C++ 7.0} + \begin{itemize} + \item Open the solution file scummwm.sln + \item Enter the path to the needed libraries and includes in + Tools|Options|Directories + \item Now it should compile successfully. + \end{itemize} +\subsection{Windows Mobile with Microsoft eMbedded Visual C++ 3 or 4} + \begin{itemize} + \item Download SDL with additional Windows Mobile tweaks:\\ + \url{http://arisme.free.fr/ports/SDL.php} + \item Download additional third party libraries:\\ + \url{http://arisme.free.fr/ports} + \item Modify your include and library paths accordingly in EVC3/EVC4. + \item Open the ScummVM project dists$\backslash$msevc4$\backslash$PocketSCUMM.vcw + \item Modify the libraries and config parameters if necessary. + \item Now it should compile successfully. + \end{itemize} +\subsection{Debian GNU/Linux} + \begin{itemize} + \item Install the packages 'build-essential', 'fakeroot', 'debhelper', + and 'libsdl1.2-dev' on your system. + \item nstall any of these packages (optional): 'libvorbis-dev' (for Ogg + Vorbis support), 'libasound2-dev' (for ALSA sequencer support), + 'libmad0-dev' (for MAD MP3 support), 'zlib1g-dev' (for compressed + saves support). + \item Run 'make deb' + \item Finally run 'dpkg -i ../scummvm-cvs*deb', and you're done. + \end{itemize} +\subsection{Mac OS X} +\begin{itemize} +\item Make sure you have the developer tools installed. +\item The SDL developer package for OS X available on the SDL web site is + \textit{not} suitable. Rather, you require a unix-style build of SDL. One + way to get that is to install SDL via Fink\\ + (\url{http://fink.sf.net}). + + Alternatively you could compile SDL manually from source using its + unix build system\\ + (\texttt{configure \&\& make}). +\item Type \texttt{./configure} in the ScummVM directory +\item You can now type \texttt{make} to create a command line binary. +\item To get a version you can run from Finder, type \texttt{make bundle} which + will create ScummVM.app (this only works if you installed SDL + etc. via Fink and into /sw. If you have installed SDL in another + way, you'll have to edit the Makefile). +\end{itemize} diff --git a/doc/config.tex b/doc/config.tex new file mode 100644 index 0000000000..e2e44c7bc8 --- /dev/null +++ b/doc/config.tex @@ -0,0 +1,146 @@ + +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "readme" +%%% End: + +\section{Configurations Files} + + +By default, the configuration file is saved in, and loaded from: +% +\begin{itemize} +\item Windows: \verb#\scummvm.ini# +\item Unix: \verb#~/.scummvmrc# +\item Mac OS X: \verb#~/Library/Preferences/ScummVM Preferences# +\item Others: \verb#scummvm.ini# in the current directory +\end{itemize} +% +An example config file looks as follows: +% +\begin{verbatim} + [scummvm] + gfx_mode=supereagle + fullscreen=true + savepath=C:\saves\ + + [sky] + path=C:\games\SteelSky\ + + [germansky] + gameid=sky + language=de + path=C:\games\SteelSky\ + description=Beneath a Steel Sky w/ German subtitles + + [germandott] + gameid=tentacle + path=C:\german\tentacle\ + description=German version of DOTT + + [tentacle] + path=C:\tentacle\ + subtitles=true + music_volume=40 + sfx_volume=255 + + [loomcd] + cdrom=1 + path=C:\loom\ + talkspeed=5 + savepath=C:\loom\saves\ + + [monkey2] + path=C:\amiga_mi2\ + music_driver=windows +\end{verbatim} +% +The following keywords are recognized: + +\begin{tabular}[hf]{lll} + basename &string\\ + path &string The path to where a game's data files are\\ + read\_only &bool If true, ScummVM will never try to overwrite\\ + & the configuration file.\\ + autosave\_period&number The seconds between autosaving (default: 300) + save\_slot &number The save game number to load on startup.\\ + savepath &string The path to where a game will store its\\ + & savegames.\\ + versioninfo &string The version of the ScummVM that created the\\ + & configuration file.\\ +\\ + gameid &string The real id of a game. Useful if you have\\ + & several versions of the same game, and want\\ + & different aliases for them. See the example.\\ + description &string The description of the game as it will appear\\ + & in the launcher.\\ +\\ + language &string Specify language (en, de, fr, it, pt, es, jp,\\ + & zh, kr, se, gb, hb, cz, ru)\\ + speech\_mute &bool &If true, speech is muted\\ + subtitles &bool Set to true to enable subtitles.\\ + talkspeed &number Text speed\\ +\\ + fullscreen &bool Fullscreen mode\\ + aspect\_ratio &bool Enable aspect ratio correction\\ + gfx\_mode &string Graphics mode (normal, 2x, 3x, 2xsai,\\ + & super2xsai, supereagle, advmame2x, advmame3x,\\ + & hq2x, hq3x, tv2x, dotmatrix)\\ +\\ + cdrom &number Number of CD-ROM unit to use for audio. If\\ + & negative, don't even try to access the CD-ROM.\\ + joystick\_num &number Number of joystick device to use for input\\ + music\_driver &string The music engine to use.\\ + output\_rate &number The output sample rate to use, in Hz. Sensible\\ + & values are 11025, 22050 and 44100.\\ + alsa\_port &string Port to use for output when using the\\ + & ALSA music driver.\\ + music\_volume &number The music volume setting (0-255)\\ + multi\_midi &bool If true, enable combination Adlib and native\\ + & MIDI.\\ + soundfont &string The SoundFont to use for MIDI playback. (Only\\ + & supported by some MIDI drivers.)\\ + native\_mt32 &bool If true, disable GM emulation and assume that\\ + & there is a true Roland MT-32 available.\\ + enable\_gs &bool If true, enable Roland GS-specific features to\\ + & enhance GM emulation. If native\_mt32 is also\\ + & true, the GS device will select an MT-32 map\\ + & to play the correct instruments.\\ + sfx\_volume &number The sfx volume setting (0-255)\\ + tempo &number The music tempo (50-200) (default: 100)\\ + speech\_volume &number The speech volume setting (0-255)\\ + midi\_gain &number The MIDI gain (0-1000) (default: 100) (Only\\ + & supported by some MIDI drivers.)\\ +\\ + copy\_protection&bool Enable copy protection in SCUMM games, when\\ + & ScummVM disables it by default.\\ + demo\_mode &bool Start demo in Maniac Mansion\\ + alt\_intro &bool Use alternative intro for CD versions of \\ + & Beneath a Steel Sky and Flight of the Amazon\\ + & Queen +\\ + boot\_param &number Pass this number to the boot script\\ +\end{tabular} + +Broken Sword 2 adds the following non-standard keywords:\\ +\begin{tabular}[h]{lll} + gfx\_details &number &Graphics details setting (0-3)\\ + music\_mute &bool &If true, music is muted\\ + object\_labels &bool &If true, object labels are enabled\\ + reverse\_stereo &bool &If true, stereo channels are reversed\\ + sfx\_mute &bool &If true, sound effects are muted\\ +\end{tabular} + +Flight of the Amazon Queen adds the following non-standard keywords:\\ +\begin{tabular}[h]{lll} + music\_mute &bool &If true, music is muted\\ + sfx\_mute &bool &If true, sound effects are muted\\ +\end{tabular} + +Simon the Sorcerer 1 \& 2 add the following non-standard keywords:\\ +\begin{tabular}[h]{lll} + fade &bool &If true, fade effect is enabled\\ + music\_mute &bool &If true, music is muted\\ + slow\_down &number &Makes games slower (1- 10)\\ + sfx\_mute &bool &If true, sound effects are muted\\ +\end{tabular} diff --git a/doc/contact.tex b/doc/contact.tex new file mode 100644 index 0000000000..2b102a99f8 --- /dev/null +++ b/doc/contact.tex @@ -0,0 +1,16 @@ + +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "readme" +%%% End: + + +\section{Contacting} + +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) +Please do not ask us to support an unsupported game -- read the FAQ on our +web site first. + +\input {02_01.tex} diff --git a/doc/credits.tex b/doc/credits.tex new file mode 100644 index 0000000000..a0301fbc13 --- /dev/null +++ b/doc/credits.tex @@ -0,0 +1,305 @@ +% This file was generated by credits.pl. Do not edit by hand! +\section{Credits} +\begin{trivlist} +\item \textbf{\LARGE ScummVM Team} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \textbf{\large Project Leaders} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + James Brown & \textit{}\\ + Max Horn & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{\large Engine Teams} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \textbf{ SCUMM} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Torbj\"orn Andersson & \textit{}\\ + James Brown & \textit{}\\ + Jonathan Gray & \textit{}\\ + Max Horn & \textit{}\\ + Travis Howell & \textit{}\\ + Pawe{\l} Ko{\l}odziejski & \textit{Codecs, iMUSE, Smush, etc.}\\ + Eugene Sandulenko & \textit{FT INSANE, MM NES, MM C64, game detection, Herc/CGA}\\ + \end{tabular} +\end{list} +\item \textbf{ HE} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Jonathan Gray & \textit{}\\ + Travis Howell & \textit{}\\ + Gregory Montoir & \textit{}\\ + Eugene Sandulenko & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ BASS} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Robert G\"offringmann & \textit{}\\ + Oliver Kiehl & \textit{}\\ + Joost Peters & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ Broken Sword 1} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Robert G\"offringmann & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ Broken Sword 2} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Torbj\"orn Andersson & \textit{}\\ + Jonathan Gray & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ Cinematique evo 1} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Pawe{\l} Ko{\l}odziejski & \textit{}\\ + Gregory Montoir & \textit{}\\ + Eugene Sandulenko & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ FOTAQ} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + David Eriksson & \textit{}\\ + Gregory Montoir & \textit{}\\ + Joost Peters & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ Gob} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Torbj\"orn Andersson & \textit{}\\ + Sven Hesse & \textit{}\\ + Willem Jan Palenstijn & \textit{}\\ + Eugene Sandulenko & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ Kyra} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Oystein Eftevaag & \textit{}\\ + Gregory Montoir & \textit{}\\ + Johannes Schickel & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ SAGA} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Torbj\"orn Andersson & \textit{}\\ + Andrew Kurushin & \textit{}\\ + Eugene Sandulenko & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ Simon} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Travis Howell & \textit{}\\ + Oliver Kiehl & \textit{}\\ + \end{tabular} +\end{list} +\end{list} +\item \textbf{\large Backend Teams} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \textbf{ Dreamcast} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Marcus Comstedt & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ SymbianOS} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Jurgen Braam & \textit{}\\ + Lars Persson & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ PalmOS} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Chris Apers & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ PocketPC / WinCE} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Nicolas Bacca & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ Playstation 2} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Robert G\"offringmann & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ PSP (PlayStation Portable)} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Joost Peters & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ SDL (Win/Linux/OS X/etc.)} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Max Horn & \textit{}\\ + Eugene Sandulenko & \textit{Asm routines, GFX layers}\\ + \end{tabular} +\end{list} +\end{list} +\item \textbf{\large Other subsystems} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Jerome Fisher & \textit{MT-32 emulator}\\ + Jochen Hoenicke & \textit{Speaker \& PCjr sound support, Adlib work}\\ + \end{tabular} +\end{list} +\item \textbf{\large Website (content)} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item +All active team members +\end{list} +\item \textbf{\large Retired Team Members} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Tore Anderson & \textit{Former Debian GNU/Linux maintainer}\\ + Ralph Brorsen & \textit{Help with GUI implementation}\\ + Jamieson Christian & \textit{iMUSE, MIDI, all things musical}\\ + Vincent Hamm & \textit{Co-Founder, original CinE engine author}\\ + Ruediger Hanke & \textit{Port: MorphOS}\\ + Felix Jakschitsch & \textit{Zak256 reverse engineering}\\ + Mutwin Kraus & \textit{Original MacOS porter}\\ + Peter Moraliyski & \textit{Port: GP32}\\ + Jeremy Newman & \textit{Former webmaster}\\ + Ludvig Strigeus & \textit{Original ScummVM and SimonVM author}\\ + Lionel Ulmer & \textit{Port: X11}\\ + \end{tabular} +\end{list} +\end{list} +\item \textbf{\LARGE Other contributions} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \textbf{\large Packages} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \textbf{ AmigaOS 4} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Hans-J\"org Frieden & \textit{}\\ + Juha Niemim\"aki & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ BeOS} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Stefan Parviainen & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ Debian GNU/Linux} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + David Weinehall & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ Fedora / RedHat} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Willem Jan Palenstijn & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ Mac OS X} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Max Horn & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ OS/2} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Paul Smedley & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ PocketPC 2002} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Kostas Nakos & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ SlackWare} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Robert Kelsen & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ Win32} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Travis Howell & \textit{}\\ + \end{tabular} +\end{list} +\item \textbf{ Win64} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Chris Gray & \textit{}\\ + \end{tabular} +\end{list} +\end{list} +\item \textbf{\large Website (design)} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Dob\'o Bal\'azs & \textit{Website design}\\ + Yaroslav Fedevych & \textit{HTML/CSS for the website}\\ + David Jensen & \textit{SVG logo conversion}\\ + Jean Marc & \textit{ScummVM logo}\\ + \end{tabular} +\end{list} +\item \textbf{\large Code contributions} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Stuart Caie & \textit{Decoders for Simon 1 Amiga data files}\\ + Paolo Costabel & \textit{PSP port contributions}\\ + Janne Huttunen & \textit{V3 actor mask support, Dig/FT SMUSH audio}\\ + Kov\'acs Endre J\'anos & \textit{Several fixes for Simon1}\\ + Jeroen Janssen & \textit{Numerous readability and bugfix patches}\\ + Andreas Karlsson & \textit{Initial port for EPOC/SymbianOS}\\ + Claudio Matsuoka & \textit{Daily Linux builds}\\ + Thomas Mayer & \textit{PSP port contributions}\\ + Mikesch Nepomuk & \textit{MI1 VGA floppy patches}\\ + Nicolas Noble & \textit{Config file and ALSA support}\\ + Quietust & \textit{Sound support for Amiga SCUMM V2/V3 games, MM NES support}\\ + Andreas R\"over & \textit{Broken Sword 1/2 MPEG2 cutscene support}\\ + Edward Rudd & \textit{Fixes for playing MP3 versions of MI1/Loom audio}\\ + Daniel Schepler & \textit{Final MI1 CD music support, initial Ogg Vorbis support}\\ + Andr\'e Souza & \textit{SDL-based OpenGL renderer}\\ + Tim ??? & \textit{Initial MI1 CD music support}\\ + \end{tabular} +\end{list} +\item +And to all the contributors, users, and beta testers we've missed. Thanks! +\end{list} +\item \textbf{\LARGE Special thanks to} +\begin{list}{}{\setlength{\leftmargin}{0.2cm}} +\item \begin{tabular}[h]{p{0.3\linewidth}p{0.6\linewidth}} + Sander Buskens & \textit{For his work on the initial reversing of Monkey2}\\ + Canadacow & \textit{For the original MT-32 emulator}\\ + Kevin Carnes & \textit{For Scumm16, the basis of ScummVM's older gfx codecs}\\ + Ivan Dubrov & \textit{For contributing the initial version of the Gobliiins engine}\\ + Joachim Eberhard & \textit{For numerous contributions to documentation}\\ + Jezar & \textit{For his freeverb filter implementation}\\ + Jim Leiterman & \textit{Various info on his FM-TOWNS/Marty SCUMM ports}\\ + lloyd & \textit{For deep tech details about C64 Zak \& MM}\\ + Jimmi Th{\o}gersen & \textit{For ScummRev, and much obscure code/documentation}\\ + Tristan & \textit{For additional work on the original MT-32 emulator}\\ + \end{tabular} +\item +Tony Warriner and everyone at Revolution Software Ltd. for sharing with us the source of some of their brilliant games, allowing us to release Beneath a Steel Sky as freeware... and generally being supportive above and beyond the call of duty. +\item +John Passfield and Steve Stamatiadis for sharing the source of their classic title, Flight of the Amazon Queen and also being incredibly supportive. +\item +Joe Pearce from The Wyrmkeep Entertainment Co. for sharing the source of their famous title Inherit the Earth and always prompt replies to our questions. +\item +Aric Wilmunder, Ron Gilbert, David Fox, Vince Lee, and all those at LucasFilm/LucasArts who made SCUMM the insane mess to reimplement that it is today. Feel free to drop us a line and tell us what you think, guys! +\end{list} +\end{trivlist} + diff --git a/doc/games.tex b/doc/games.tex new file mode 100644 index 0000000000..987b75d115 --- /dev/null +++ b/doc/games.tex @@ -0,0 +1,119 @@ + +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "readme" +%%% End: + + +\section{Supported Games} + +At the moment the following games have been reported to work, and should +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]\\ + Loom& [loom]\\ + The Secret of Monkey Island& [monkey]\\ + Monkey Island 2: LeChuck's Revenge& [monkey2]\\ + Indiana Jones and the Fate of Atlantis& [atlantis]\\ + Day of the Tentacle& [tentacle]\\ + Sam \& Max Hit the Road& [samnmax]\\ + Full Throttle& [ft]\\ + 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]\\ + Broken Sword 1: The Shadow of the Templars& [sword1]\\ + Broken Sword 2: The Smoking Mirror& [sword2]\\ + Flight of the Amazon Queen& [queen]\\ + Gobliiins& [gob1]\\ + Inherit the Earth: Quest for the Orb& [ite]\\ + The Legend of Kyrandia& [kyra1]\\ + Simon the Sorcerer 1& [simon1]\\ + Simon the Sorcerer 2& [simon2]\\ + \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 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} + + 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 +encounter such a bug in a 'supported' game. +\end{itemize} +%% next section +\input {03_01.tex} +%% next section +\input {03_02.tex} +%% next section +\input {03_03.tex} +%% next section +\input {03_04.tex} +%% next section +\input {03_05.tex} +%next section +\input {03_06.tex} +%% next section +\input {03_07.tex} +%next section +\input {03_08.tex} +%next section +\input {03_09.tex} +%next section +\input {03_10.tex} +%next section +\input {03_11.tex} diff --git a/doc/platforms.tex b/doc/platforms.tex new file mode 100644 index 0000000000..462bb53a78 --- /dev/null +++ b/doc/platforms.tex @@ -0,0 +1,56 @@ + +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "readme" +%%% End: + +\section{Supported Platforms} +ScummVM has been ported to run on many platforms and operating systems. +Links to these ports can be found either on the ScummVM web page or by a +Google search. Many thanks to the effort of porters. If you have a port of +ScummVM and wish to commit it into the main CVS, feel free to contact us! + +Supported platforms include (but are not limited to): + +\begin{tabular}{ll} +UNIX &(Linux, Solaris, IRIX, *BSD)\\ +Windows \\ +Windows Mobile &(iPAQ and other handheld devices)\\ +Mac OS X \\ +AmigaOS \\ +BeOS \\ +Dreamcast \\ +PalmOS \\ +Playstation 2 \\ +Playstation Portable\\ +RISC OS \\ +Symbian \\ +\end{tabular} + +The Dreamcast port does not support Curse of Monkey Island, nor The Dig. +The PalmOS port does not support Curse of Monkey Island, Beneath a Steel +Sky, nor either Simon the Sorcerer 1 or 2. The Dig will only work on some +Palm devices (those with a large dynamic heap). + +In the Macintosh port, the right mouse button is emulated via Cmd-Click (that +is, you click the mouse button while holding the Command/Apple/Propeller key). + +For the following platforms, custom backends were supported at one point +but currently are not being maintained (usually due to lack of a qualified +maintainer). In some cases (e.g. Linux), the standard SDL support works +instead. + +\begin{tabular}{ll} +MorphOS\\ +GP32 \\ +Linux \\ +\end{tabular} + +We have reports about unofficial ports to the following platforms. Please +note that this are not made by us, so we neither endorse nor support them. +Use at your own risk! + +\begin{tabular}{ll} +Nintendo DS\\ +Xbox \\ +\end{tabular} diff --git a/doc/readme.tex b/doc/readme.tex index 75ef77186c..c3e3ca7087 100644 --- a/doc/readme.tex +++ b/doc/readme.tex @@ -51,15 +51,15 @@ % \newpage \pagestyle{fancy} -\input{01.tex} -\input{02.tex} -\input{03.tex} -\input{04.tex} -\input{05.tex} -\input{06.tex} -\input{07.tex} -\input{08.tex} -\input{09.tex} -\input{10.tex} +\input{about.tex} +\input{contact.tex} +\input{games.tex} +\input{platforms.tex} +\input{running.tex} +\input{saves.tex} +\input{audio.tex} +\input{config.tex} +\input{compiling.tex} +\input{credits.tex} \end{document} diff --git a/doc/running.tex b/doc/running.tex new file mode 100644 index 0000000000..d68e763790 --- /dev/null +++ b/doc/running.tex @@ -0,0 +1,39 @@ + +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "readme" +%%% End: + + +\section{Running ScummVM} + +Before you run the engine, you need to put the game's datafiles in a +directory. The filenames must not be in mixed case on *nix systems +(for example, these are valid names: ``monkey2.000'', ``MONKEY2.000'', while +this is a bad one: "Monkey2.000"). If you use a game with speech, the file +monster.sou must reside in the same directory as the datafiles. + +Please note that by default, ScummVM will save games in the directory +it is executed from, so you should refrain from running it from more than +one location. Further information, including how to specify a specific save +directory to avoid this issue, are in section 6.0. + +ScummVM can be launched directly by running the executable. In this case, +the in-built launcher will activate. From this, you can add games (click +'Add Game'), or launch games which have already been configured. + +ScummVM can also be launched into a game directly using Command Line +arguments -- see the next section. + +%next section +\input {05_01.tex} +%next section +\input {05_02.tex} +%next section +\input {05_03.tex} +%next section +\input {05_04.tex} +%next section +\input {05_05.tex} +%next section +\input {05_06.tex} diff --git a/doc/saves.tex b/doc/saves.tex new file mode 100644 index 0000000000..3cfb466109 --- /dev/null +++ b/doc/saves.tex @@ -0,0 +1,32 @@ +\section {Savegames} +Savegames are by default put in the current directory on some platforms and +preset directories on others. You can specify the save in the config file by +setting the savepath parameter. See the example config file later in this +readme. + +The platforms that currently have a different default directory are: +% +\begin{itemize} +\item Mac OS X: \verb#$HOME/Documents/ScummVM Savegames/# +\item Other unices: \verb#$HOME/.scummvm/# +\end{itemize} +% +You can also use the environment variable SCUMMVM\_SAVEPATH to specify where to +put save games. Don't forget the trailing directory separator. Also be aware +that saved games may break between ScummVM releases. + +Bash (Unix) example: +\begin{verbatim} + export SCUMMVM_SAVEPATH=/tmp/scummvm_savegames/ +\end{verbatim} +Windows example: +\begin{verbatim} + set SCUMMVM_SAVEPATH=C:\saved_games\ +\end{verbatim} + +%%next section +\input {06_01.tex} +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "readme" +%%% End: -- cgit v1.2.3