libretro/scummvm
1
0
Fork 0
mirror of https://github.com/libretro/scummvm.git synced 2025-02-21 19:51:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Sync. updates and section numbers.

Browse Source 
svn-id: r20104
This commit is contained in:
Travis Howell 2006-01-20 00:19:56 +00:00
parent 89ecf72e51
commit bb9a3814dc
3 changed files with 254 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

113
doc/03.tex
View File

@ -16,62 +16,63 @@ this is not always true.
\begin{itemize}
\item SCUMM Games by LucasArts:\\
\begin {tabular} [h] {ll}
Maniac Mansion& [Game: maniac]\\
Zak McKracken and the Alien Mindbenders& [Game: zak]\\
Indiana Jones \& the Last Crusade& [Game: indy3]\\
Loom& [Game: loom]\\
The Secret of Monkey Island& [Game: monkey]\\
Monkey Island 2: LeChuck's Revenge& [Game: monkey2]\\
Indiana Jones and the Fate of Atlantis& [Game: atlantis]\\
Day of the Tentacle& [Game: tentacle]\\
Sam \& Max Hit the Road& [Game: samnmax]\\
Full Throttle& [Game: ft]\\
The Dig& [Game: dig]\\
The Curse of Monkey Island& [Game: comi]\\
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& [Game: football]\\
Big Thinkers Kindergarten& [Game: thinkerk]\\
Fatty Bear's Birthday Surprise& [Game: fbear]\\
Fatty Bear's Fun Pack& [Game: fbpack]\\
Freddi Fish 1: The Case of the Missing Kelp Seeds& [Game: freddi]\\
Freddi Fish 2: The Case of the Haunted Schoolhouse& [Game: fredd2]\\
Freddi Fish 3: The Case of the Stolen Conch Shell& [Game: freddi3]\\
Freddi Fish 4: The Case of the Hogfish Rustlers of Briny Gulch&[Game: freddi4]\\
Freddi Fish and Luther's Maze Madness& [Game: maze]\\
Freddi Fish and Luther's Water Worries& [Game: water]\\
Let's Explore the Airport with Buzzy& [Game: airport]\\
Let's Explore the Farm with Buzzy& [Game: farm]\\
Let's Explore the Jungle with Buzzy& [Game: jungle]\\
Pajama Sam 1: No Need to Hide When It's Dark Outside& [Game: pajama]\\
Pajama Sam 2: Thunder and Lightning Aren't so Frightening& [Game: pajama2]\\
Pajama Sam's Sock Works& [Game: socks]\\
Putt-Putt Goes To The Moon& [Game: puttmoon]\\
Putt-Putt Enters the Race& [Game: puttrace]\\
Putt-Putt Joins the Circus& [Game: puttcircus]\\
Putt-Putt Joins the Parade& [Game: puttputt]\\
Putt-Putt Saves the Zoo& [Game: puttzoo]\\
Putt-Putt Travels Through Time& [Game: putttime]\\
Putt-Putt and Pep's Balloon-O-Rama& [Game: balloon]\\
Putt-Putt and Pep's Dog on a Stick& [Game: dog]\\
Putt-Putt \& Fatty Bear's Activity Pack& [Game: activity]\\
Putt-Putt's Fun Pack& [Game: funpack]\\
Spy Fox 1: Dry Cereal& [Game: spyfox]\\
Spy Fox 2: Some Assembly Required& [Game: spyfox2]\\
Spy Fox in Cheese Chase& [Game: chase]\\
Spy Fox in Hold the Mustard& [Game: mustard]\\
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's Sock Works& [socks]\\
Putt-Putt Goes To The Moon& [puttmoon]\\
Putt-Putt Enters the Race& [puttrace]\\
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& [Game: sky]\\
Broken Sword 1: The Shadow of the Templars& [Game: sword1]\\
Broken Sword 2: The Smoking Mirror& [Game: sword2]\\
Flight of the Amazon Queen& [Game: queen]\\
Gobliiins& [Game: gob1]\\
Inherit the Earth: Quest for the Orb& [Game: ite]\\
Simon the Sorcerer 1& [Game: simon1]\\
Simon the Sorcerer 2& [Game: simon2]\\
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
@ -79,12 +80,12 @@ the latest updates on game compatibility, visit our web site and view the
compatibility chart.
\begin{tabular}{ll}
Backyard Baseball& [Game: baseball]\\
Backyard Soccer& [Game: soccer]\\
Big Thinkers First Grade& [Game: thinker1]\\
Pajama Sam 3: You Are What You Eat From Your Head to Your Feet&[Game: pajama3]\\
Pajama Sam's Lost \& Found& [Game: lost]\\
Spy Fox 3: Operation Ozone& [Game: spyozon]\\
Backyard Baseball& [baseball]\\
Backyard Soccer& [soccer]\\
Big Thinkers First Grade& [thinker1]\\
Pajama Sam 3: You Are What You Eat From Your Head to Your Feet&[pajama3]\\
Pajama Sam's Lost \& Found& [lost]\\
Spy Fox 3: Operation Ozone& [spyozon]\\
\end{tabular}
The following games are SCUMM engine, but NOT supported by ScummVM (yet).

165
doc/07_07.tex Normal file
View File

@ -0,0 +1,165 @@
%%% Local Variables:
%%% mode: latex
%%% TeX-master: "readme"
%%% End:
\subsection{Using compressed audiofiles (MP3, Ogg Vorbis, Flac)}
\label{sect-compressing-audiofiles}
\subsubsection{Using MP3 files for CD audio}
Use LAME or some other MP3 encoder to rip the CD audio tracks to files. Name
the files track1.mp3 track2.mp3 etc. ScummVM must be compiled with MAD support
to use this option. You'll need to rip the file from the CD as a WAV file,
then encode the MP3 files in constant bit rate. This can be done with the
following LAME command line:
\begin{verbatim}
lame -t -q 0 -b 96 track1.wav track1.mp3
\end{verbatim}
\subsubsection{Using Ogg Vorbis files for CD audio}
Use oggenc or some other vorbis encoder to encode the audio tracks to files.
Name the files track1.ogg track2.ogg etc. ScummVM must be compiled with vorbis
support to use this option. You'll need to rip the files from the CD as a WAV
file, then encode the vorbis files. This can be done with the following oggenc
command line with the value after q specifying the desired quality from 0 to 10:
\begin{verbatim}
oggenc -q 5 track1.wav
\end{verbatim}
\subsubsection{Using Flac files for CD audio}
Use flac or some other flac encoder to encode the audio tracks to files.
Name the files track1.flac track2.flac etc. In your filesystem only allows
three letter extensions, name the files track1.fla track2.fla etc.
ScummVM must be compiled with flac support to use this option. You'll need to
rip the files from the CD as a WAV file, then encode the flac files. This can
be done with the following flac command line:
\begin{verbatim}
flac --best track1.wav
\end{verbatim}
%
Remember that the quality is always the same, varying encoder options will only
affect the encoding time and resulting filesize.
\subsubsection{Compressing MONSTER.SOU with MP3}
You need LAME, and our extract util from the scummvm-tools package to perform
this task, and ScummVM must be compiled with MAD support.
\begin{verbatim}
extract monster.sou
\end{verbatim}
%
Eventually you will have a much smaller monster.so3 file, copy this file
to your game directory. You can safely remove the monster.sou file.
\subsubsection{Compressing MONSTER.SOU with Ogg Vorbis}
As above, but ScummVM must be compiled with OGG support. Run:
\begin{verbatim}
extract --vorbis monster.sou
\end{verbatim}
%
This should produce a smaller monster.sog file, which you should copy to your
game directory. Ogg encoding may take a considerable longer amount of time
than MP3, so have a good book handy.
\subsubsection{Compressing MONSTER.SOU with Flac}
As above, but ScummVM must be compiled with Flac support. Run:
\begin{verbatim}
extract --flac --best -b 1152 monster.sou
\end{verbatim}
%
This should produce a smaller monster.sof file, which you should copy to your
game directory. Remember that the quality is always the same, varying encoder
options will only affect the encoding time and resulting filesize. Playing
with the blocksize (-b <value>), has the biggest impact on the resulting
filesize -- 1152 seems to be a good value for those kind of soundfiles. Be sure
to read the encoder documentation before you use other values.
\subsubsection{Compressing sfx/speech in Simon the Sorcerer 1 and 2}
Use our simon2mp3 util from the scummvm-tools package to perform this task.
You can choose between multiple target formats, but note that you can only use
each if ScummVM was compiled with the respective decoder support enabled.
\begin{tabular}[h]{ll}
simon2mp3 effects &(For Acorn CD version of Simon 1)\\
simon2mp3 simon &(For Acorn CD version of Simon 1)\\
simon2mp3 effects.voc&(For DOS CD version of Simon 1)\\
simon2mp3 simon.voc &(For DOS CD version of Simon 1)\\
simon2mp3 simon.wav &(For Windows CD version of Simon 1)\\
simon2mp3 simon2.voc &(For DOS CD version of Simon 2)\\
simon2mp3 simon2.wav &(For Windows CD version of Simon 2)\\
simon2mp3 mac &(For Macintosh version of Simon 2)\\
\end{tabular}
For Ogg Vorbis add --vorbis to the options, i.e.
\begin{verbatim}
simon2mp3 --vorbis
\end{verbatim}
%
For Flac add --flac and optional parameters, i.e.
\begin{verbatim}
simon2mp3 --flac --best -b 1152
\end{verbatim}
%
Eventually you will have a much smaller *.mp3, *.ogg or *.fla file, copy this
file to your game dir. You can safely remove the old file.
\subsubsection{Compressing speech/music in Broken Sword 1}
The sword1mp3 tool from the scummvm-tools package can encode music and speech
to MP3 as well as Ogg Vorbis.
Easiest way to encode the files is simply copying the executable into your
BS1 directory (together with the lame encoder) and run it from there.
This way, it'll automatically encode everything to MP3.
Afterwards, you can manually remove the SPEECH?.CLU files and the wave music files.
Running
\begin{verbatim}
sword1mp3 --vorbis
\end{verbatim}
%
will compress the files using Ogg Vorbis instead of MP3.
Use
\begin{verbatim}
sword1mp3 --help
\end{verbatim}
%
to get a full list of the options.
\subsubsection{Compressing speech/music in Broken Sword 2}
Use our sword2mp3 util rom the scummvm-tools package to perform this task.
You can choose between multiple target formats, but note that you can only use
each if ScummVM was compiled with the respective decoder support enabled.
\begin{verbatim}
sword2mp3 speech1.clu
sword2mp3 music1.clu
\end{verbatim}
%
For Ogg Vorbis add --vorbis to the options, i.e.
\begin{verbatim}
sword2mp3 --vorbis
\end{verbatim}
%
Eventually you will have a much smaller *.cl3 or *.clg file, copy this file to
your game dir. You can safely remove the old file.
It is possible to use Flac compression by adding the --flac option. However,
the resulting *.clf file will actually be larger than the original.
Please note that sword2mp3 will only work with the four speech/music files in
Broken Sword 2. It will not work with any of the other *.clu files, nor will it
work with the speech files from Broken Sword 1.

32
doc/07_08.tex Normal file
View File

@ -0,0 +1,32 @@
%%% Local Variables:
%%% mode: latex
%%% TeX-master: "readme"
%%% End:
\subsection{Output sample rate}
The output sample rate tells ScummVM how many sound samples to play per channel
per second. There is much that could be said on this subject, but most of it
would be irrelevant here. The short version is that for most games 22050 Hz is
fine, but in some cases 44100 Hz is preferable. On extremely low-end systems
you may want to use 11025 Hz, but it's unlikely that you have to worry about
that.
To elaborate, most of the sounds ScummVM has to play were sampled at either
22050 Hz or 11025 Hz. Using a higher sample rate will not magically improve the
quality of these sounds. Hence, 22050 Hz is fine.
Some games use CD audio. If you use compressed files for this, they are
probably sampled at 44100 Hz, so for these games that may be a better choice of
sample rate.
When using the Adlib, FM Towns, PC Speaker or IBM PCjr music drivers, ScummVM
is responsible for generating the samples. Usually 22050 Hz will be plenty for
these, but there is at least one piece of Adlib music in Beneath a Steel Sky
that will sound a lot better at 44100 Hz.
Using frequencies in between is not recommended. For one thing, your sound card
may not support it. In theory, ScummVM should fall back on a sensible frequency
in that case, but don't count on it. More importantly, ScummVM has to resample
all sounds to its output frequency. This is much easier to do well if the
output frequency is a multiple of the original frequency.