thirdparty/scummvm
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

more README cleanup

Browse source 
svn-id: r5782
This commit is contained in:
Max Horn 2002-12-01 15:30:22 +00:00
parent 61f9082db0
commit db54db67ef
1 changed files with 36 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

44
README
View file

@ -10,7 +10,6 @@ at: http://www.scummvm.org/
About: About:
------ ------
ScummVM is an implementation of the SCUMM (Script Creation Utility for ScummVM is an implementation of the SCUMM (Script Creation Utility for
Maniac Mansion) engine used in various Lucas Arts games such as Monkey Maniac Mansion) engine used in various Lucas Arts games such as Monkey
Island and Day of the Tentacle. At this time ScummVM should be considered Island and Day of the Tentacle. At this time ScummVM should be considered
@ -25,15 +24,16 @@ 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 ScummVM homepage. This will help us buy utilities needed to develop ScummVM
easier and quicker. If you cannot donate, help and contribute a patch! easier and quicker. If you cannot donate, help and contribute a patch!
Contacting: Contacting:
----------- -----------
The easiest way to contact the ScummVM team is by submitting bug reports or 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 commenting in our forums. You can also join and e-mail the scummvm-devel
mailing list, or chat with us on irc (#scummvm, irc.freenode.net) mailing list, or chat with us on irc (#scummvm, irc.freenode.net)
Supported Games: Supported Games:
---------------- ----------------
At the moment the following games have been reported to work, and should At the moment the following games have been reported to work, and should
be playable to the end: be playable to the end:
@ -66,14 +66,14 @@ The following games are SCUMM engine, but NOT supported by ScummVM (yet).
Loom (16 color floppy version) Loom (16 color floppy version)
Curse of Monkey Island Curse of Monkey Island
Please be aware that the engine may contain bugs and unimplemented Please be aware that the engine may contain bugs and unimplemented features
features that sometimes make it impossible to finish the game. Save often, that sometimes make it impossible to finish the game. Save often, and please
and please file a bug report (instructions on submitting bug reports are below) file a bug report (instructions on submitting bug reports are below) if you
if you discover such a bug. encounter such a bug.
Supported Platforms: Supported Platforms:
------------------- -------------------
ScummVM has been ported to run on many platforms and operating systems. 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 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 Google search. Many thanks to the effort of porters. If you have a port of
@ -90,9 +90,9 @@ ScummVM and wish to commit it into the main CVS, feel free to contact us!
Dreamcast - ??? Dreamcast - ???
UNIX - SDL (SDL may work on Solaris, IRIX, *BSD) UNIX - SDL (SDL may work on Solaris, IRIX, *BSD)
Known Bugs: Known Bugs:
----------- -----------
This release has the following known bugs. There is no need to report them, This release has the following known bugs. There is no need to report them,
although patches to fix them are welcome. If you discover a bug that is not 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 listed here, nor in the compatibility table on the web site, please see
@ -144,7 +144,6 @@ the section on Reporting Bugs.
Simon the Sorcerer 1 and 2 games note Simon the Sorcerer 1 and 2 games note
-------------------------------------- --------------------------------------
The Simon the Sorcerer 1 & 2 games were split into six targets to make The Simon the Sorcerer 1 & 2 games were split into six targets to make
coding easier and to make it more clear which target should be used: coding easier and to make it more clear which target should be used:
simon1dos - Use for Simon the Sorcerer 1 for DOS (Disk) simon1dos - Use for Simon the Sorcerer 1 for DOS (Disk)
@ -166,7 +165,6 @@ So if you have any old save games you will need to change their filenames to use
Reporting Bugs: Reporting Bugs:
--------------- ---------------
To report a bug, please create a SourceForge account and follow the 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 link from our homepage. Please make sure the bug is reproducible, and
still occurs in the latest daily build/current CVS version. Also check still occurs in the latest daily build/current CVS version. Also check
@ -191,7 +189,6 @@ Please include the following information:
Compiling: Compiling:
---------- ----------
You need SDL-1.2.2 or newer (older versions may work, but are unsupported), and 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 a supported compiler. Several compilers, including GCC, mingw and Microsoft
Visual C++ are supported. If you wish to use MP3-compressed CD tracks or Visual C++ are supported. If you wish to use MP3-compressed CD tracks or
@ -239,7 +236,6 @@ messages (see http://www.sysinternals.com/ntw2k/freeware/debugview.shtml).
Running: Running:
-------- --------
Before you run the engine, you need to put the game's datafiles in a Before you run the engine, you need to put the game's datafiles in a
directory. The filenames must be in lowercase on *nix systems directory. The filenames must be in lowercase on *nix systems
(monkey2.000 and monkey2.001). If you use a game with speech, the file (monkey2.000 and monkey2.001). If you use a game with speech, the file
@ -302,18 +298,17 @@ Command Line Options:
Hot Keys: Hot Keys:
--------- ---------
ScummVM supports various in game hotkeys. They differ between the scumm and
ScummVM supports various in game hotkeys. They differ between the scumm and simon simon games.
games.
Common: Common:
Ctrl-z OR Alt-x - quit Ctrl-z OR Alt-x - quit
Keyboard Arrow Keys - simulate mouse movement
Ctrl-Alt 1-7 - Switch between graphics filters Ctrl-Alt 1-7 - Switch between graphics filters
Ctrl-Alt 1 - Switch beetwen bilinear and non-linear filtering [OpenGL backend] Ctrl-Alt 1 - Switch beetwen bilinear and non-linear filtering [OpenGL backend]
Ctrl-Alt 2 - Don't fit the game in the whole screen (black borders) [OpenGL backend] Ctrl-Alt 2 - Don't fit the game in the whole screen (black borders) [OpenGL backend]
Ctrl-Alt 3 - Fit the game in the whole screen (no black borders) [OpenGL backend] Ctrl-Alt 3 - Fit the game in the whole screen (no black borders) [OpenGL backend]
Ctrl-Alt 4-7 - Zoom [OpenGL backend] Ctrl-Alt 4-7 - Zoom [OpenGL backend]
Keyboard Arrow Keys - Mouse Movement [SDL backend]
Scumm: Scumm:
Ctrl 0-9 and Alt 0-9 - load and save game state Ctrl 0-9 and Alt 0-9 - load and save game state
@ -327,18 +322,19 @@ games.
Space - pauses Space - pauses
Period (.) - skips current line of text in some games Period (.) - skips current line of text in some games
Alt-Enter - toggles full screen/windowed Alt-Enter - toggles full screen/windowed
Enter - Left Mouse Button Press Enter - simulate left mouse button press
Tab - Right Mouse Button Press Tab - simulate right mouse button press
Simon: Simon:
- and + - (Simon) music volume, down/up - and + - music volume, down/up
m - (Simon) music on/off m - music on/off
s - (Simon) sound effects on/off s - sound effects on/off
b - (Simon) ambient sounds on/off b - ambient sounds on/off
Note that using ctrl-f and ctrl-g are not recommended: Games can crash when Note that using ctrl-f and ctrl-g are not recommended: Games can crash when
being ran faster than their normal speed, as scripts will loose synchronisation being ran faster than their normal speed, as scripts will loose synchronisation
Graphics filters: Graphics filters:
----------------- -----------------
ScummVM offers several anti-aliasing filters to attempt to improve visual ScummVM offers several anti-aliasing filters to attempt to improve visual
@ -371,7 +367,6 @@ of 320x240 - hence for this game scalers will scale to 640x480 or 960x720.
Autosaves: Autosaves:
---------- ----------
Because ScummVM is still a beta product, it -can- crash and/or hang Because ScummVM is still a beta product, it -can- crash and/or hang
occasionally. As such, every five minutes it will save a game in Slot 0. This occasionally. As such, every five minutes it will save a game in Slot 0. This
game can be loaded via Ctrl-0, or the F5 menu. This autosaving only applies to game can be loaded via Ctrl-0, or the F5 menu. This autosaving only applies to
@ -380,7 +375,6 @@ Scumm games, not other games (such as Simon the Sorcerer)
Savegames: Savegames:
---------- ----------
Savegames are by default put in the current directory. You can specify the save Savegames are by default put in the current directory. You can specify the save
in the config file by setting the savepath parameter. See the example config in the config file by setting the savepath parameter. See the example config
file later in this readme. file later in this readme.
@ -416,6 +410,7 @@ To select a sound driver, pass its name via the '-e' option to scummvm, for exam
scummvm -e adlib monkey2 scummvm -e adlib monkey2
Playing sound with Adlib emulation: Playing sound with Adlib emulation:
----------------------------------- -----------------------------------
By default an Adlib card will be emulated and ScummVM will output the music By default an Adlib card will be emulated and ScummVM will output the music
@ -625,7 +620,6 @@ Credits:
------------------------------------------------------------------------ ------------------------------------------------------------------------
Good Luck and Happy Adventuring! Good Luck and Happy Adventuring!
The ScummVM team. The ScummVM team.