home *** CD-ROM | disk | FTP | other *** search
/ Level 2003 September (DVD) / Level_2003-09_104_DVD_Shadowman.iso / Extra / SCUMMVM / README.TXT < prev    next >
Encoding:
Text File  |  2003-01-01  |  38.7 KB  |  899 lines

  1. ScummVM README
  2. Last updated:    2003-08-02
  3. Release version: 0.5.0
  4. ------------------------------------------------------------------------
  5.  
  6. For more information, compatibility lists, details on donating, the latest
  7. release, progress reports and more, please visit the ScummVM home page
  8. at: http://www.scummvm.org/
  9.  
  10.  
  11. About:
  12. ------ 
  13. ScummVM is a collection of interpreters, capable of emulating several
  14. adventure game engines. ScummVM mainly supports engines created using 
  15. SCUMM (Script Creation Utility for Maniac Mansion), used in various
  16. LucasArts games such as Monkey Island, Day of the Tentacle, and others.
  17. ScummVM also contains interpreters for several non-SCUMM games, currently
  18. these are Simon the Sorcerer (1 & 2), and Beneath a Steel Sky.
  19.  
  20. At this time ScummVM should be considered beta software, and is still
  21. under heavy development. Be aware that whilst we attempt to make sure
  22. that many games can be completed with few major bugs, crashes can happen. 
  23.  
  24. If you enjoy ScummVM feel free to donate using the PayPal button on the
  25. ScummVM homepage. This will help us buy utilities needed to develop ScummVM
  26. easier and quicker. If you cannot donate, help and contribute a patch!
  27.  
  28.  
  29. Contacting:
  30. -----------
  31. The easiest way to contact the ScummVM team is by submitting bug reports or
  32. commenting in our forums. You can also join and e-mail the scummvm-devel
  33. mailing list, or chat with us on irc (#scummvm, irc.freenode.net)
  34.  
  35.  
  36. Supported Games:
  37. ----------------
  38. At the moment the following games have been reported to work, and should
  39. be playable to the end. However, this list generally applies to PC versions.
  40. Mac versions should work after being "ReSCUMM'ed" (see later in this document),
  41. and Amiga versions of games may work with the 'Amiga' flag turned on - but
  42. this is not always true.
  43.  
  44. SCUMM Games:
  45.      Maniac Mansion (Enhanced Version)               [Game: maniac]
  46.      Zak McKracken (Enhanced Version)                [Game: zak]
  47.      Indiana Jones & the Last Crusade (EGA)          [Game: indy3ega]
  48.      Indiana Jones & the Last Crusade (256)          [Game: indy3]
  49.      Indiana Jones & the Last Crusade (256 FM Towns) [Game: indy3towns]
  50.      Loom (16 color floppy version)                  [Game: loom]
  51.      Loom (256 color CD version)                     [Game: loomcd]
  52.      Zak McKracken (256 FM Towns)                    [Game: zak256]
  53.      Monkey Island 1 (EGA version)                   [Game: monkeyega]
  54.      Monkey Island 1 (VGA version)                   [Game: monkeyvga]
  55.      Monkey Island 1 (CD version)                    [Game: monkey/monkey1]
  56.      Monkey Island 2                                 [Game: monkey2]
  57.      Indiana Jones and the Fate of Atlantis          [Game: atlantis]
  58.      Day of the Tentacle                             [Game: tentacle]
  59.      Sam & Max                                       [Game: samnmax]
  60.      The Dig                                         [Game: dig]
  61.      Curse of Monkey Island                          [Game: comi]
  62.  
  63. Other Games:
  64.      Beneath a Steel Sky                             [Game: sky]
  65.      Simon the Sorcerer 1                            [Game: simon1dos/
  66.                                                        simon1talkie/simon1win]
  67.      Simon the Sorcerer 2                            [Game: simon2dos/simon2talkie
  68.                                                           /simon2win/simon2mac]
  69.  
  70. The following games should be finishable, but have some criticial problems that
  71. prevent them from being fully supported at this time. Please do not file bug
  72. reports about them.
  73.         
  74.      Full Throttle                                 [Game: ft]
  75.      Zak McKracken (256 color, Towns Kanji ver)    [Game: zak256]
  76.  
  77. The following games should load, but are not yet fully playable. Play these at
  78. your own risk, and please do not file bug reports about them. If you want
  79. the latest updates on game compatibility, visit our web site and view the
  80. compatibility chart.
  81.  
  82.      Maniac Mansion (Original)                     [Game: maniac]
  83.      Zak McKracken (Original)                      [Game: zak]
  84.      Putt-Putt Goes To The Moon                    [Game: puttmoon]
  85.      Putt-Putt's Fun Pack                          [Game: funpack]
  86.      Fatty Bear's Birthday Surprise                [Game: fbear]
  87.      Fatty Bear's Fun Pack                         [Game: fbpack]
  88.  
  89. The following games are SCUMM engine, but NOT supported by ScummVM (yet).
  90.  
  91.      Putt-Putt Joins the Parade
  92.      Most other Humongous Entertainment titles
  93.  
  94. Please be aware that the engine may contain bugs and unimplemented features
  95. that sometimes make it impossible to finish the game. Save often, and please
  96. file a bug report (instructions on submitting bug reports are below) if you
  97. encounter such a bug in a 'supported' game.
  98.  
  99.  
  100. Supported Platforms:
  101. -------------------
  102. ScummVM has been ported to run on many platforms and operating systems.
  103. Links to these ports can be found either on the ScummVM web page or by a
  104. Google search. Many thanks to the effort of porters. If you have a port of
  105. ScummVM and wish to commit it into the main CVS, feel free to contact us!
  106.  
  107.         Windows         - SDL
  108.         Windows CE      - SDL           (iPaq and other handheld devices)
  109.         Linux           - X11 & OSS audio (includes iPaqs running Linux)
  110.         Mac OS X        - SDL
  111.         AmigaOS         - SDL/AGA
  112.         MorphOS         - custom backend
  113.         BeOS            - SDL
  114.         Acorn (RiscOS)  - ???
  115.         Dreamcast       - custom backend 
  116.         GP32            - custom backend
  117.         PalmOS          - custom backend
  118.         UNIX            - SDL           (Linux, Solaris, IRIX, *BSD)
  119.  
  120. Neither the Dreamcast nor Palm ports support Curse of Monkey Island or
  121. either Simon the Sorcerer game. The Dig is also currently unsupported
  122. on the Dreamcast port, and will only work on some Palm devices (those
  123. with a large dynamic heap). The PalmOS port also lacks support for
  124. Beneath a Steel Sky.
  125.  
  126. Copy Protection:
  127. ----------------
  128. The ScummVM team does not condone piracy. However, there are cases when
  129. LucasArts themselves bundled cracked interpreters with their own games --
  130. the data files still contain the copy protection scripts, but the interpreter
  131. bypasses them. There is no way for us to tell the difference between legitimate
  132. and pirated data files, so for the games where we know the original interpreter
  133. may have been cracked ScummVM will always have to bypass the copy protection.
  134.  
  135. At the time of writing, that includes the following games:
  136.  
  137. Indiana Jones & the Last Crusade (EGA)
  138. Indiana Jones & the Last Crusade (256 color FM Towns version)
  139. Loom (16 color floppy version)
  140. Maniac Mansion
  141. Monkey Island 1 (EGA version)
  142. Monkey Island 1 (VGA version)
  143. Monkey Island 2
  144. Zak McKracken (256 color FM Towns version)
  145.  
  146. Beneath a Steel Sky (bypassed with permission from Revolution)
  147.  
  148. In most cases ScummVM will still show the copy protection screen. Try entering
  149. any answer. Chances are that it will work.
  150.  
  151.  
  152. Known Problems in ScummVM 0.5.0:
  153. --------------------------------
  154. This release has the following known problems. There is no need to report them,
  155. although patches to fix them are welcome. If you discover a bug that is not
  156. listed here, nor in the compatibility table on the web site, please see
  157. the section on Reporting Bugs.
  158.  
  159.        Beneath a Steel Sky:
  160.                 - Floppy demo does not work at all
  161.                 - Amiga versions aren't supported and probably never will be
  162.                 - Not a bug: CD version is missing speech for some dialog
  163.  
  164.        Indiana Jones & the Last Crusade (EGA):
  165.                 - In some rooms Indy may be able to walk to odd places
  166.                 - There are some minor graphical glitches
  167.  
  168.        Indiana Jones & the Last Crusade (256):
  169.                 - No sound effects
  170.                 - In some rooms Indy may be able to walk to odd places
  171.                 - There are some minor graphical glitches
  172.  
  173.        Monkey Island (EGA & VGA versions):
  174.                 - No sound effects
  175.  
  176.        Indiana Jones and the Fate of Atlantis:
  177.                 - Keyboard fighting does not work. ScummVM now defaults to
  178.                   using mouse fighting.
  179.  
  180.        Sam and Max:
  181.                 - Highway subgame does not behave correctly.
  182.  
  183.        Simon the Sorcerer 1:
  184.                 - No inventory scrolling arrows shown in simon1dos and
  185.                   simon1talkie, can still move around inventory though.
  186.                 - simon1dos freezes briefly after Swampling leaves his house and
  187.                   when talking to demons in Sordid's Tower
  188.  
  189.        Simon the Sorcerer 2:
  190.                 - Text in copy protection screen of simon2dos is only shown for
  191.                   a short time
  192.                 - simon2dos and simon2talkie (With subtitles enabled) freeze 
  193.                   briefly when Pirate Captain is talking to Mate, when Simon
  194.                   tries to escape
  195.                 - Only default language in data files is supported in simon2mac
  196.                 - F10 key animation in simon2mac is different compared to
  197.                   original game
  198.  
  199.        Curse of Monkey Island
  200.                 - The "Pirate Song" scene does not play correctly
  201.                 - Some minor graphical glitches remain
  202.  
  203.        Zak McKracken (Enhanced)
  204.                 - Pushing the feet on the Mars Sarcophagous may not open the
  205.                   hidden door. A workaround is to use 'Push' on the floor just
  206.                   before the feet.
  207.  
  208.        FM Towns versions:
  209.                 - No support for Kanji versions
  210.                 - All the FM Towns versions of games are extremely rare,
  211.                   And as the ScummVM team does not encourage piracy in any
  212.                   way, we don't know where to buy or download a copy of these
  213.                   games. Petition LucasArts to re-release them :)
  214.  
  215.        All CD games:
  216.                - If you are experiencing random crashes, and your game
  217.                  plays music from CD, you have encountered a Windows bug.
  218.                  Try copying the data files from CD to your hard disk, and
  219.                  running them from there.
  220.  
  221.  
  222. Simon the Sorcerer 1 and 2 games note
  223. --------------------------------------
  224. The Simon the Sorcerer 1 & 2 games were split into several targets to make 
  225. coding easier and to make it more clear which target should be used:
  226.        simon1dos    - Use for Simon the Sorcerer 1 for DOS (Disk)
  227.        simon2dos    - Use for Simon the Sorcerer 2 for DOS (Disk)
  228.        simon1talkie - Use for Simon the Sorcerer 1 Talkie for DOS (CD)
  229.        simon2talkie - Use for Simon the Sorcerer 2 Talkie for DOS (CD)
  230.        simon1win    - Use for Simon the Sorcerer 1 Talkie for Windows (CD)
  231.        simon2win    - Use for Simon the Sorcerer 2 Talkie for Windows (CD)
  232.        simon2mac    - Use for Simon the Sorcerer 2 Talkie for Amiga or Mac (CD)
  233.  
  234. If you have the dual version of Simon the Sorcerer 1 or 2 on CD,
  235. then you will find the Windows version in the main directory of CD
  236. and the DOS Talkie version in the DOS directory of the CD.
  237.  
  238. Filenames of saved games for Simon the Sorcerer 1 & 2 were changed in 0.3.0 too:
  239.   Simon the Sorcerer 1 uses simon1.00x (Where x is the slot number) 
  240.   Simon the Sorcerer 2 uses simon2.00x (Where x is the slot number) 
  241. So if you have any pre 0.3.0 save games you will need to change their filenames
  242. to use them.
  243.  
  244.  
  245. Reporting Bugs:
  246. ---------------
  247. To report a bug, please create a SourceForge account and follow the bugs
  248. link from our homepage. Please make sure the bug is reproducible, and
  249. still occurs in the latest daily build/current CVS version. Also check
  250. the existing bug list, and compatibility listing for that game, to
  251. ensure the issue is not already known.
  252.  
  253. Do NOT report bugs on games that are not listed as being completable
  254. above. We -know- those games have bugs.
  255.  
  256. Please include the following information:
  257.         - ScummVM version (PLEASE test the latest CVS/Daily build)
  258.         - Bug details, including instructions on reproducing
  259.         - Language of game (English, German, ...)
  260.         - Version of game (Talkie, Floppy, ...)
  261.         - Platform and Compiler (Win32, Linux, FreeBSD, ...)
  262.         - Attach a save game if possible
  263.         - If this bug only occurred recently, please note the last
  264.           version without the bug, and the first version including
  265.           the bug. That way we can fix it quicker by looking at the
  266.           changes made.
  267.  
  268.  
  269. Compiling:
  270. ----------
  271. You need SDL-1.2.2 or newer (older versions may work, but are unsupported), and
  272. a supported compiler. Several compilers, including GCC, mingw and Microsoft
  273. Visual C++ are supported. If you wish to use MP3-compressed CD tracks or
  274. .SOU files, you will need to install the MAD library and define
  275. USE_MAD. Tools for compressing .SOU files to .SO3 files can be
  276. found in the 'tools' CVS module, or in the 'scummvm-tools' package.
  277.  
  278. You can also comment/uncomment appropriate lines in the build.rules file to
  279. use sdl_gl.cpp instead of sdl.cpp. This allows hardware accelerated bilinear
  280. filtering by using OpenGL textures.
  281.  
  282. On Win9x/NT/XP you can define USE_WINDBG and attach WinDbg to browse debug 
  283. messages (see http://www.sysinternals.com/ntw2k/freeware/debugview.shtml).
  284.  
  285.     GCC:
  286.         * Type make (or gmake if that's what GNU make is called on your
  287.           system) and hopefully ScummVM will compile for you.
  288.  
  289.     Mingw:
  290.         * Open Makefile.mingw, alter SDL paths and choose compiling options.
  291.         * Type make -f Makefile.mingw,  hopefully ScummVM will compile for you.
  292.  
  293.     Microsoft Visual C++:
  294.         * Open the workspace, scummwm.dsw
  295.         * Enter the path to the SDL include files in Tools|Options|Directories
  296.         * Now it should compile successfully.
  297.  
  298.     PocketPC - Windows CE:
  299.         * Download the SDLAudio library:
  300.           http://arisme.free.fr/PocketScumm/sources/SDLAudio-1.2.3-src.zip
  301.         * Open and compile the SDLAudio WCEBuild/WCEBuild workspace in EVC++
  302.         * Open the ScummVM wince/PocketScumm workspace
  303.         * Enter the SDLAudio directory to your includes path
  304.         * Enter the compiled SDLAudio.lib to your link libraries list
  305.         * Now it should compile successfully
  306.  
  307.     Debian GNU/Linux:
  308.         * Install the packages 'build-essential', 'fakeroot', 'debhelper',
  309.           'libsdl1.2-dev', and 'libmad0-dev' on your system.
  310.         * Optional: Install the 'libvorbis-dev' and/or the 'libasound2-dev'
  311.           packages, and edit the Makefile to turn on support for Ogg Vorbis
  312.           and/or the ALSA sequencer.
  313.         * Run 'make deb'.
  314.         * Finally run 'dpkg -i ../scummvm-cvs*deb', and you're done.
  315.         
  316.     Mac OS X:
  317.         * Make sure you have the developer tools installed.
  318.         * Edit backends/sdl/build.rules, and enable the Mac OS X specific 
  319.           line(s).
  320.         * Depending on where you have installed SDL, you have to add the
  321.           location of its headers to the INCLUDES variables. For example if you
  322.           installed SDL via Fink, you can add this at the end of build.rules:
  323.           INCLUDES+= -I/sw/include
  324.         * You can now 'make' to create a command line binary.
  325.         * To get a version you can run from Finder, type 'make bundle' which
  326.           will create ScummVM.app.
  327.  
  328.  
  329. Running:
  330. --------
  331. Before you run the engine, you need to put the game's datafiles in a
  332. directory. The filenames must not be in mixed case on *nix systems
  333. (for example, these are valid names: "monkey2.000", "MONKEY2.000", while
  334. this is a bad one: "Monkey2.000"). If you use a game with speech, the file
  335. monster.sou must reside in the same directory as the datafiles.
  336.  
  337. For example, to run a copy of Monkey Island installed in C:\Games\LucasArts
  338. under Windows, you would make a shortcut calling this command:
  339.  
  340.   C:\Games\LucasArts\scummvm.exe -f -pC:\Games\LucasArts\monkey\ monkey
  341.  
  342. Under Unix, the commandline would be:
  343.  
  344.   /path/to/scummvm -f -p/games/LucasArts/monkey/ monkey
  345.  
  346. Or, if you have, for example, Full Throttle on CD, and your CD drive is D:,
  347. and you wish to disable subtitles and run in fullscreen:
  348.  
  349.   C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ ft
  350.   /path/to/scummvm -f -n -p/mnt/cdrom/resource/ ft
  351.  
  352. Note that if you run the game once this way, and specify the -w commandline
  353. parameter (or edit the config file manually), ScummVM will remember the
  354. path, and other settings for this game. Documentation on the configuration
  355. file can be found near the end of this readme.
  356.  
  357. The short game name ('game target') you see at the end of the command
  358. line is very important. A short list is contained at the top of this
  359. file. You can also get the current list of games and game names at:
  360.  
  361.         http://www.scummvm.org/compatibility.php
  362.  
  363. For the adventurous, who like to live on the edge... you can download
  364. daily builds of Win32 from the Download page of the main ScummVM homepage.
  365.  
  366.  
  367. Command Line Options:
  368. ---------------------
  369.  
  370.         scummvm [OPTIONS] [GAME]
  371.  
  372.         [GAME]         - Short name of game to load. For example, 'monkey' for
  373.                          Monkey Island.
  374.  
  375.         -p<path>       - Path to where the game is installed. Default is Cwd.
  376.         -x[<num>]      - Save game slot to load (default: autosave)
  377.         -f             - Full-screen mode.
  378.         -g<mode>       - Select graphics scaler. See below.
  379.         -e<mode>       - Select sound engine. See below.
  380.         -a             - Enable amiga pal conversion, for playing Amiga
  381.                          versions
  382.         -q<lang>       - Select language. See below.
  383.         -c<num>        - Drive to play cd audio from.  E.g., 0 is first drive.
  384.         -m<num>        - Set the music volume, 0-255.  Default is '192'
  385.         -o<num>        - Set the master volume, 0-255. Default is '192'
  386.         -s<num>        - Set the sfx volume, 0-255.    Default is '192'
  387.         -t<num>        - Set music tempo. 50-200. Default is '100' (percent)
  388.         -n             - Disable subtitles. Use with games that have voice.
  389.         -y             - Set talk speed ('yak option'). Default is '60'
  390.         -l<file>       - Load alternate configuration file
  391.         -w[<file>]     - Write configuration file
  392.         -v             - Show version information and exit
  393.         -z             - Display list of games
  394.         -b<num>        - Start in room <num>.
  395.         -d[<num>]      - Set debug verbosity to <num>
  396.         -u             - Dump scripts if a directory called 'dumps' exists in
  397.                          current directory
  398.         --multi-midi   - enable combination Adlib and native MIDI
  399.         --native-mt32  - true Roland MT-32 (disable GM emulation)
  400.         --aspect-ratio - enable aspect ratio correction
  401.         --floppy-intro - Use floppy version intro for Beneath a Steel Sky CD
  402.  
  403. The meaning of long options can be inversed by prefixing them with "no-", e.g.
  404. --no-aspect-ratio. This is useful if you want to override a setting in the
  405. configuration file.
  406.  
  407.  
  408.  
  409. Hot Keys:
  410. ---------
  411. ScummVM supports various in game hotkeys. They differ between the scumm and
  412. simon games.
  413.  
  414.     Common:
  415.         Ctrl-z OR Alt-x        - quit
  416.         Keyboard Arrow Keys    - simulate mouse movement
  417.         Ctrl-f                 - runs in fast mode.
  418.         Ctrl-Alt 0-9           - Switch between graphics filters
  419.         Ctrl-Alt b             - Switch beetwen bilinear and non-linear
  420.                                  filtering [OpenGL backend]
  421.         Ctrl-Alt a             - Toggle aspect-ratio correction on/off.
  422.                                  Most of the games use a 320x200 pixel
  423.                                  resolution, which may look squashed on
  424.                                  modern monitors. Aspect-ratio correction
  425.                                  stretches the image to use 320x240 pixels
  426.                                  instead, or a multiple thereof.
  427.  
  428.     Scumm:
  429.         Ctrl 0-9 and Alt 0-9   - load and save game state
  430.         Ctrl-g                 - runs in really REALLY fast mode.
  431.         Ctrl-d                 - starts the debugger.
  432.         Tilde (~)              - Show/hide the debugging console
  433.         Ctrl-s                 - shows memory consumption.
  434.         [ and ]                - music volume, down/up
  435.         - and +                - text speed, slower/faster
  436.         F5                     - displays a save/load box.
  437.         Space                  - pauses
  438.         Period (.)             - skips current line of text in some games
  439.         Alt-Enter              - toggles full screen/windowed
  440.         Enter                  - simulate left mouse button press
  441.         Tab                    - simulate right mouse button press
  442.  
  443.     Simon:
  444.         F1 - F3                - text speed, faster - slower
  445.         - and +                - music volume, down/up
  446.         m                      - music on/off
  447.         s                      - sound effects on/off
  448.         b                      - background sounds on/off
  449.  
  450. Note that using ctrl-f and ctrl-g are not recommended: Games can crash when
  451. being ran faster than their normal speed, as scripts will loose synchronisation
  452.  
  453.  
  454. Language options:
  455. -----------------
  456. ScummVM includes a language option for Maniac Mansion, Zak KcKracken, The Dig,
  457. Curse of Monkey Island, Beneath a Steel Sky.and Simon the Sorcerer 1 & 2.
  458.  
  459. Maniac Mansion and Zak McKracken
  460.  
  461.         en  - English (default)
  462.         de  - German
  463.         fr  - French
  464.         it  - Italian
  465.         es  - Spanish
  466.  
  467. The Dig
  468.  
  469.         jp  - Japanese
  470.         zh  - Chinese
  471.         kr  - Korean
  472.  
  473. Curse of Monkey Island
  474.  
  475.         en  - English (default)
  476.         de  - German
  477.         fr  - French
  478.         it  - Italian
  479.         pt  - Portuguese
  480.         es  - Spanish
  481.         jp  - Japanese
  482.         zh  - Chinese
  483.         kr  - Korean
  484.  
  485. Beneath a Steel Sky:
  486.         gb  - English (Great Britain) (default)
  487.     en  - English USA
  488.         de  - German
  489.         fr  - French
  490.         it  - Italian
  491.         pt  - Portuguese
  492.         es  - Spanish
  493.         se  - Swedish
  494.  
  495. Simon the Sorcerer: 1 & 2
  496.  
  497.         en  - English (default)
  498.         de  - German
  499.         fr  - French
  500.         it  - Italian
  501.         es  - Spanish
  502.         hb  - Hebrew
  503.  
  504.  
  505. Graphics filters:
  506. -----------------
  507. ScummVM offers several anti-aliasing filters to attempt to improve visual
  508. quality. These are the same filters used in many other emulators, such as
  509. MAME. 
  510. Note: the resolutions listed assume the game was originally 320x200
  511.  
  512. They are:
  513.         normal     - No filtering, original 320x200 resolution. Fastest.
  514.         2x         - No filtering, double screen/window size to 640x400 
  515.                      (default)
  516.         3x         - No filtering, triple screen/window size to 960x600
  517.         2xsai      - 2xsai filtering, double screen/window size to 640x400
  518.         super2xsai - Enhanced 2xsai filtering. 640x400 screen/window size
  519.         supereagle - Less blurry than 2xsai, but slower. Also 640x400
  520.         advmame2x  - 640x400 scaling. Doesn't rely on blurring like 2xSAI.
  521.         advmame3x  - 960x600 scaling. Doesn't rely on blurring like 2xSAI.
  522.         tv2x       - 640x400 scaling. Horizontal scanlines.
  523.         dotmatrix  - 640x400 scaling. Dot matrix effect.
  524.         opengl     - OpenGL with bilinear filtering [Unsupported]
  525.  
  526. To select a graphics filter, pass its name via the '-g' option to scummvm,
  527. for example:
  528.  
  529.     scummvm -g advmame2x monkey2
  530.  
  531. Note #1: Not all backends support all or any filters. The ones listed above
  532. are for the default SDL backend.
  533.  
  534. Note #2: Filters can be very slow when ScummVM is compiled in a debug
  535. configuration without optimizations. And there is always a speed impact when
  536. using any form of anti-aliasing/linear filtering.
  537.  
  538. Note #3: The FmTowns version of Zak (zak256 target) uses an original resolution
  539. of 320x240 - hence for this game scalers will scale to 640x480 or 960x720.
  540.  
  541. Note #4: The OpenGL filter is included as a curiosity only. It's use is
  542. unsupported, and unrecommended. The only benefit is hardware accelerated
  543. scaling, but any machine with an OpenGL card should be fast enough to use
  544. the software scalers (see above).
  545.  
  546. Autosaves:
  547. ----------
  548. Because ScummVM is still a beta product, it -can- crash and/or hang
  549. occasionally. As such, every five minutes it will save a game in Slot 0. This
  550. game can be loaded via Ctrl-0, or the F5 menu. This autosaving does not, however,
  551. occur with Simon the Sorcerer.
  552.  
  553.  
  554. Savegames:
  555. ----------
  556. Savegames are by default put in the current directory. You can specify the save
  557. in the config file by setting the savepath parameter. See the example config
  558. file later in this readme.
  559.  
  560. You can also use the environment variable SCUMMVM_SAVEPATH to specify where to
  561. put save games. Don't forget the trailing directory separator. Also be aware
  562. that saved games may break between ScummVM releases.
  563.  
  564. Bash (Unix) Example:
  565.         export SCUMMVM_SAVEPATH=/tmp/scummvm_savegames/
  566.  
  567. Windows example:
  568.         set SCUMMVM_SAVEPATH=C:\saved_games\
  569.  
  570.  
  571. Music and Sound: 
  572. ----------------
  573. By default, on most operating systems, ScummVM will automatically use Adlib
  574. emulation. MIDI may not be available on all operating systems or may need
  575. manual configuration. If you ARE using MIDI, you have several different
  576. choices of output, depending on your operating system and configuration.
  577.         
  578.         adlib     - Uses internal Adlib Emulation (default) 
  579.         windows   - Windows MIDI. Uses built-in sequencer, for Windows users
  580.         seq       - Uses /dev/sequencer for MIDI, *nix users. See below.
  581.         qt        - Quicktime sound, for Macintosh users.
  582.         core      - CoreAudio sound, for MacOS X users.
  583.         amidi     - Uses the MorphOS MIDI system, for MorphOS users
  584.         alsa      - Output using ALSA sequencer device. See below.
  585.         null      - Null output. Don't play any music.
  586.  
  587. To select a sound driver, pass its name via the '-e' option to scummvm,
  588. for example:
  589.  
  590.     scummvm -e adlib monkey2
  591.  
  592.  
  593. Playing sound with Adlib emulation:
  594. -----------------------------------
  595. By default an Adlib card will be emulated and ScummVM will output the music
  596. as sampled waves. This is the default mode for most games, and offers the
  597. best compatibility between machines and games.
  598.  
  599.  
  600. Playing sound with MIDI emulation:
  601. ----------------------------------
  602. Until recently, some games (particularly Sam and Max) were only able to run
  603. in MIDI mode. This prevented music for these games from working on platforms
  604. that do not support MIDI, or soundcards that do not provide MIDI drivers (e.g.,
  605. many soundcards will not play MIDI under Linux). ScummVM can now emulate MIDI
  606. mode using sampled waves and Adlib emulation using the -eadlib option.
  607. However, if you are capable of using native MIDI, we recommend using one of
  608. the MIDI modes below for best sound.
  609.  
  610.  
  611. Playing sound with Native MIDI:
  612. -------------------------------
  613. Use the appropriate -e<mode> command line option from the list above to
  614. select your preferred MIDI device. For example, if you wish to use the
  615. Windows MIDI driver, use the -ewindows option.
  616.  
  617.  
  618. Playing sound with Sequencer MIDI:              [UNIX ONLY]
  619. ----------------------------------
  620. If your soundcard driver supports a sequencer, you may set the environment
  621. variable "SCUMMVM_MIDI" to your sequencer device - e.g., /dev/sequencer
  622.  
  623. If you have problems with not hearing audio in this configuration, it is
  624. possible you will need to set the "SCUMMVM_MIDIPORT" variable to 1 or 2. This
  625. selects the port on the selected sequencer to use. Then start scummvm with the
  626. -eseq parameter. This should work on several cards, and may offer better
  627. performance and quality than Adlib emulation. However, for those systems where
  628. sequencer support does not work, you can always fall back on Adlib emulation.
  629.  
  630.  
  631. Playing sound with ALSA sequencer:              [UNIX ONLY]
  632. ----------------------------------
  633. If you have installed the ALSA driver with the sequencer support, then
  634. set the environment variable "SCUMMVM_PORT" to your sequencer port - e.g. 65:0
  635.  
  636. Here is a little howto on how to use the ALSA sequencer with your soundcard.
  637. In all cases, to have a list of all the sequencer ports you have, try the
  638. command "aconnect -o -l". This should give output similar to:
  639. client 64: 'External MIDI 0' [type=kernel]
  640.     0 'MIDI 0-0        '
  641. client 65: 'Emu10k1 WaveTable' [type=kernel]
  642.     0 'Emu10k1 Port 0  '
  643.     1 'Emu10k1 Port 1  '
  644.     2 'Emu10k1 Port 2  '
  645.     3 'Emu10k1 Port 3  '
  646. client 128: 'Client-128' [type=user]
  647.     0 'TiMidity port 0 '
  648.     1 'TiMidity port 1 '
  649.  
  650. This means the external MIDI output of the sound card is located on the
  651. port 64:0, four WaveTable MIDI outputs in 65:0, 65:1, 65:2
  652. and 65:3, and two TiMidity ports, located at 128:0 and 128:1.
  653.  
  654. If you have a FM-chip on your card, like the SB16, then you have to load
  655. the soundfonts using the sbiload software. Example:
  656.   sbiload -p 65:0 /etc/std.o3 /etc/drums.o3
  657.  
  658. If you have a WaveTable capable sound card, you have to load a sbk or sf2
  659. soundfont using the sfxload software. Example:
  660.   sfxload /path/to/8mbgmsfx.sf2
  661.  
  662. If you don't have a MIDI capable soundcard, or if you want to take advantage of
  663. your TiMidity samples, then you can ask TiMidity to become an ALSA sequencer
  664. output. Here is a quick way to do so:
  665.   timidity -iAqqq -B2,8 -Os1S -s 44100 &
  666. If you get distorted output with this setting try dropping the -B2,8 or
  667. changing the value.
  668.  
  669. Then the TiMidity port will be visible from the 'aconnect -o -l' list. You
  670. should launch it as root, since it will try to set up some real time
  671. priority.
  672.  
  673.  
  674. Using MP3 files for CD audio:
  675. -----------------------------
  676. Use LAME or some other mp3 encoder to rip the cd audio tracks to files. Name
  677. the files track1.mp3 track2.mp3 etc. ScummVM must be compiled with MAD support
  678. to use this option. You'll need to rip the file from the CD as a WAV file,
  679. then encode the MP3 files in Constant Bit Rate sampled at 22 kHz. This can
  680. be done with the following LAME command line:
  681.  
  682.   lame -t -q 0 -b 96 --resample 22.05 track1.wav track1.mp3
  683.  
  684.  
  685. Using Ogg Vorbis files for CD audio:
  686. ------------------------------------
  687. Use oggenc or some other vorbis encoder to encode the audio tracks to files.
  688. Name the files track1.ogg track2.ogg etc. ScummVM must be compiled with vorbis
  689. support to use this option. You'll need to rip the files from the CD as a WAV
  690. file, then encode the vorbis files to be sampled at 22 kHz. This can be done
  691. with the following oggenc command line with the value after q specifying 
  692. the desired quality from 0 to 10:
  693.  
  694.   oggenc -q 5 --resample 22050 track1.wav
  695.  
  696.  
  697. Compressing MONSTER.SOU with MP3:
  698. ---------------------------------
  699. You need LAME, and our extract util from the scummvm-tools package to perform
  700. this task, and ScummVM must be compiled with MAD support.
  701.  
  702. Make a backup file of your MONSTER.SOU before attempting this. Copy your
  703. MONSTER.SOU file to a temporary folder. Then run:
  704.  
  705.   extract monster.sou
  706.  
  707. In about 30 minutes or so, you will have a much smaller monster.so3 file,
  708. copy this file to your game dir. You can safely remove the monster.sou file.
  709.  
  710.  
  711. Compressing MONSTER.SOU with Ogg Vorbis:
  712. ----------------------------------------
  713. As above but run:
  714.  
  715.   extract --vorbis monster.sou
  716.  
  717. This should produce a smaller monster.sog file, which you should copy to your
  718. game dir.
  719.  
  720.  
  721. Using data files from Macintosh game versions:
  722. ----------------------------------------------
  723. All LucasArts Scumm based adventures except CMI also exist in versions for the
  724. Macintosh. ScummVM can use most (all?) of them, however, in some case some
  725. additional work is required. First off, if you are not using a Macintoh for
  726. this, accessing the CD/floppy data might be tricky. There are various tools on
  727. the net for this, though.
  728.  
  729. Secondly, most of the newer games shipped only with a  single data file on the
  730. Macintosh. You first have to run the 'rescumm' tool from the scummvm-tools
  731. package to extract the data files ScummVM excpects. You invoke rescumm like
  732. this (where DATAFILE is the path to the single big data file):
  733.  
  734.    rescumm DATAFILE
  735.  
  736. It will extract the data into the current directory, so make sure to run it from
  737. a writable directory.
  738.  
  739.  
  740. Configuration file:
  741. -------------------
  742. By default, the configuration file is saved in, and loaded from:
  743.  
  744.         Windows:  <windir>\scummvm.ini,
  745.         Unix:     ~/.scummvmrc
  746.         Mac OS X: ~/Library/Preferences/ScummVM Preferences
  747.         Others:   scummvm.ini in the current directory
  748.  
  749. An example config file looks as follows:
  750.  
  751.         [scummvm]
  752.         gfx_mode=supereagle
  753.         fullscreen=true
  754.         savepath=C:\saves\
  755.  
  756.         [germandott]
  757.         gameid=tentacle
  758.         path=C:\german\tentacle\
  759.         description=German version of DOTT
  760.  
  761.         [tentacle]
  762.         path=C:\tentacle\
  763.         nosubtitles=true
  764.         master_volume=98
  765.         music_volume=40
  766.         sfx_volume=255
  767.  
  768.         [loomcd]
  769.         cdrom=1
  770.         path=C:\loom\
  771.         talkspeed=55
  772.         
  773.         [monkey2]
  774.         path=C:\amiga_mi2\
  775.         music_driver=windows
  776.         amiga=true
  777.  
  778. The following keywords are recognized:
  779.  
  780.         amiga           bool     Tells ScummVM whether or not a game is the
  781.                                  Amiga version
  782.         basename        string
  783.         path            string   The path to where a game's data files are
  784.         read_only       bool     If true, ScummVM will never try to overwrite
  785.                                  the configuration file.
  786.         save_slot
  787.         savepath                 The path to where a game will store its
  788.                                  savegames.
  789.         versioninfo     string   The version of the ScummVM that created the
  790.                                  configuration file.
  791.  
  792.         gameid          string   The real id of a game. Useful if you have
  793.                                  several versions of the same game, and want
  794.                                  different aliases for them. See the example.
  795.         description     string   The description of the game as it will appear
  796.                                  in the launcher.
  797.  
  798.         language        string   Specify language (en, de, fr, it, pt, es, jp,
  799.                                  zh, kr, hb)
  800.         nosubtitles     bool     Set to true to suppress subtitles.
  801.         talkspeed       number   Text speed (default: 60)
  802.  
  803.         fullscreen      bool     Fullscreen mode
  804.         aspect_ratio    bool     Enable aspect ratio correction
  805.         gfx_mode        string   Graphics mode (normal, 2x, 3x, 2xsai,
  806.                                  super2xsai, supereagle, advmame2x, advmame3x,
  807.                                  tv2x, dotmatrix)
  808.  
  809.         cdrom           int      Number of CD-ROM unit to use for audio. If
  810.                                  negative, don't even try to access the CD-ROM.
  811.         master_volume   int      The master volume setting (0-255)
  812.         music_driver    string   The music engine to use.
  813.         music_volume    int      The music volume setting (0-255)
  814.         multi_midi      bool     If true, enable combination Adlib and native
  815.                                  MIDI.
  816.         native_mt32     bool     If true, disable GM emulation and assume that
  817.                                  there is a true Roland MT-32 available.
  818.         sfx_volume      int      The sfx volume setting (0-255)
  819.         tempo           int      The music tempo (50-200) (default: 100)
  820.  
  821.         floppy_intro    bool     Use floppy version of introduction in Beneath a 
  822.                                  Steel Sky (CD version)
  823.  
  824.         debuglevel      int      Enable debug output. The higher number, the
  825.                                  more verbose output.
  826.  
  827.  
  828. Credits:
  829. --------
  830.  The ScummVM team:
  831.         James Brown          - Lead Developer
  832.         Max Horn             - Lead Developer
  833.         Robert Goeffringmann - Engine: Beneath a Steel Sky (maintainer)
  834.         Jonathan Gray        - Engine: SCUMM
  835.         Oliver Kiehl         - Engine: Beneath a Steel Sky, Simon
  836.         Pawel Kolodziejski   - Engine: SCUMM (Codecs, iMUSE, Smush, etc.)
  837.         Joost Peters         - Engine: Beneath a Steel Sky
  838.         Chris Apers          - Port: PalmOS
  839.         Nicolas Bacca        - Port: PocketPC/WinCE port
  840.         Marcus Comstedt      - Port: Dreamcast
  841.         Ruediger Hanke       - Port: MorphOS
  842.         Travis Howell        - Port: Win32, Engine: Simon (maintainer)
  843.         Peter Moraliyski     - Port: GP32
  844.         Lionel Ulmer         - Port: X11
  845.         Torbjorn Andersson   - Generic Bugfixer and Patch Submitter
  846.         Jamieson Christian   - iMUSE, MIDI, all things musical.
  847.         Jochen Hoenicke      - Speaker & PCjr sound support, Adlib work
  848.         Jeremy Newman        - Webmaster
  849.  
  850.  Retired Team Members:
  851.         Ralph Brorsen        - Help with GUI Implementation
  852.         Vincent Hamm         - Co-Founder
  853.         Felix Jakschitsch    - Zak256 reverse engineering
  854.         Mutwin Kraus         - Original MacOS Porter
  855.         Ludvig Strigeus      - Original ScummVM and SimonVM Author
  856.  
  857.  Contributors:
  858.         Stuart Caie          - Decoders for Simon 1 Amiga data files
  859.         Janne Huttunen       - V3 actor mask support, Dig/FT SMUSH audio
  860.         Kovacs Endre Janos   - Several fixes for Simon1
  861.         Jeroen Janssen       - Numerous readability and bugfix patches
  862.         Claudio Matsuoka     - Daily Linux/BeOS builds 
  863.         Gregory Montoir      - AdvanceMAME Scale-2X, TV 2x and Dot Matrix
  864.                                implementation
  865.         Mikesch Nepomuk      - MI1 VGA Floppy patches.
  866.         Nicolas Noble        - Config file and ALSA support
  867.         Edward Rudd          - Fixes for playing MP3 versions of MI1/Loom Audio
  868.         Daniel Schepler      - Final MI1 CD music support/ 
  869.                                Initial Ogg Vorbis support
  870.         Andre Souza          - SDL-based OpenGL renderer
  871.         Tim 'realmz'         - Initial MI1 CD music support
  872.  
  873.         And to all the contributors, users, and beta testers we've missed.
  874.         Thanks!
  875.  
  876.  Special thanks to:
  877.         Sander Buskens  - For his work on the initial reversing of Monkey2
  878.         Kevin Carnes    - For Scumm16, the basis of ScummVM older gfx codec
  879.         Jim Leiterman   - Various info on his FmTowns/Marty SCUMM ports
  880.         Jimmi Thogersen - For ScummRev, and much obscure code/documentation
  881.  
  882.         Tony Warriner and everyone at Revolution Sofware Ltd. for sharing
  883.         with us the source of some of their brilliant games, allowing us to
  884.         release Beneath a Steel Sky as freeware... and generally being
  885.         supportive above and beyond the call of duty.
  886.  
  887.         Aric Wilmunder, Ron Gilbert, David Fox, Vince Lee, and all those at
  888.         LucasFilm/LucasArts who made SCUMM the insane mess to reimplement
  889.         that it is today. Feel free to drop us a line and tell us what you
  890.         think, guys!
  891.  
  892.  
  893.  
  894. ------------------------------------------------------------------------
  895. Good Luck and Happy Adventuring!
  896. The ScummVM team.
  897. http://www.scummvm.org/
  898. ------------------------------------------------------------------------
  899.