Ticket #8608: readme.diff

File readme.diff, 7.4 KB (added by SF/clemty, 13 years ago)

some fixes for the README

  • README

    old new  
    11ScummVM README
    2 Last updated:    $Date: 2007-02-12 14:36:26 +0100 (Mon, 12 Feb 2007) $
     2Last updated:    $Date$
    33------------------------------------------------------------------------
    44
    55TODO: Resolve all the TODOs scattered through this file before release.
     
    87872.0) Contact:
    8888---- --------
    8989The easiest way to contact the ScummVM team is by submitting bug reports
    90 (see section 2.1) or by using our forums <http://forums.scummvm.org>.
     90(see section 2.1) or by using our forums at http://forums.scummvm.org .
    9191You can also join and e-mail the scummvm-devel mailing list, or chat with
    9292us on IRC (#scummvm on irc.freenode.net) Please do not ask us to support
    9393an unsupported game -- read the FAQ on our web site first.
     
    233233where the game companies (such as LucasArts) themselves bundled
    234234'cracked' executables with their games -- in these cases the data
    235235files still contain the copy protection scripts, but the interpreter
    236 bypasses them (similar to what an illegaly cracked version might do,
     236bypasses them (similar to what an illegally cracked version might do,
    237237only that here the producer of the game did it). There is no way for
    238238us to tell the difference between legitimate and pirated data files,
    239 so for the games where we know that a cracked version the original
     239so for the games where we know that a cracked version of the original
    240240interpreter was sold at some point, ScummVM will always have to bypass
    241241the copy protection.
    242242
     
    312312Most of the newer games on the Macintosh shipped with only a single data file
    313313(note that in some cases this data file was made invisible, so you may need
    314314extra tools in order to copy it). ScummVM is able to directly use such a data file;
    315 simpy point ScummVM at the directory containing it, and it should work (just like
     315simply point ScummVM at the directory containing it, and it should work (just like
    316316with every other supported game).
    317317
    318318We also provide a tool called 'rescumm' in the tools package to extract the
     
    375375TODO
    376376
    377377The cutscenes should be placed in the main game data directory. Note that
    378 currently this requires either copying the game to hard disk or reburning
     378currently this requires either copying the game to hard disk or burning
    379379customised versions of the game CDs.
    380380
    381381The instructions for the Broken Sword games are for the Sold-Out Software
     
    4544543.11) Inherit the Earth: Quest for the Orb notes:
    455455----- -------------------------------------------
    456456In order to run the Mac OS X Wyrmkeep re-release of the game you will need to
    457 copy over data from the CD to your hard drive. If you're on a PC then consult:
     457copy over data from the CD to your hard disk. If you're on a PC then consult:
    458458
    459459  http://wiki.scummvm.org/index.php/HOWTO-Mac_Games
    460460
     
    524524            users of Microsoft Windows 2000/XP may experience random crashes.
    525525            This is due to a long-standing Windows bug, resulting in corrupt
    526526            game files being read from the CD. Please copy the game data to
    527             your harddrive to avoid this.
     527            your hard disk to avoid this.
    528528
    529529     FM-TOWNS versions:
    530530          - The Kanji versions require the FM-TOWNS Font ROM
     
    722722
    723723The meaning of most long options (that is, those options starting with a
    724724double-dash) can be inverted by prefixing them with "no-". For example,
    725 --no-aspect-ratio will turn aspectio ratio correction off. This is useful
     725--no-aspect-ratio will turn aspect ratio correction off. This is useful
    726726if you want to override a setting in the configuration file.
    727727
    728728The short game name ('game target') you see at the end of the command
     
    750750The Curse of Monkey Island, Beneath a Steel Sky, Broken Sword 1 and
    751751Simon the Sorcerer 1 and 2.
    752752
    753 Note that with the exception of TODO, using this option does *not*
    754 change the languge of the game (which usually is hard coded), but
    755 rather is only used to select the appropriate font (e.g. for a German version
    756 of a game, one containing umlauts).
     753Note that with the exception of Beneath a Steel Sky, Broken Sword 1, TODO,
     754using this option does *not* change the language of the game (which usually
     755is hardcoded), but rather is only used to select the appropriate font (e.g.
     756for a German version of a game, one containing umlauts).
    757757
    758758Maniac Mansion and Zak McKracken
    759759        en  - English (default)
     
    982982For some games (namely "Beneath a Steel Sky", "Flight of the Amazon
    983983Queen" and all SCUMM games), ScummVM will by default automatically
    984984save the current state every five minutes (adjustable via the
    985 "autosave_period" config setting). For the SCUMM enbgine, it will save
     985"autosave_period" config setting). For the SCUMM engine, it will save
    986986in Slot 0. This savestate can then be loaded again via Ctrl-0, or the
    987987F5 menu.
    988988
     
    11541154and 65:3, and two TiMidity ports, located at 128:0 and 128:1.
    11551155
    11561156If you have a FM-chip on your card, like the SB16, then you have to load
    1157 the soundfonts using the sbiload software. Example:
     1157the SoundFonts using the sbiload software. Example:
    11581158  sbiload -p 65:0 /etc/std.o3 /etc/drums.o3
    11591159
    11601160If you have a WaveTable capable sound card, you have to load a sbk or sf2
    1161 soundfont using the sfxload software. Example:
     1161SoundFont using the sfxload software. Example:
    11621162  sfxload /path/to/8mbgmsfx.sf2
    11631163
    11641164If you don't have a MIDI capable soundcard, there are two options: FluidSynth
     
    12551255
    125612567.7.6) Compressing sfx/speech in Simon the Sorcerer and The Feeble Files
    12571257------ -----------------------------------------------------------------
    1258 Use our compress_simon util from the scummvm-tools package to perform this
     1258Use our compress_simon utility from the scummvm-tools package to perform this
    12591259task. You can choose between multiple target formats, but note that you can
    12601260only use each if ScummVM was compiled with the respective decoder support
    12611261enabled.
     
    13041304
    130513057.7.8) Compressing speech/music in Broken Sword 2
    13061306------ ------------------------------------------
    1307 Use our compress_sword2 util from the scummvm-tools package to perform this
     1307Use our compress_sword2 utility from the scummvm-tools package to perform this
    13081308task. You can choose between multiple target formats, but note  that you can
    13091309only use each if ScummVM was compiled with the respective decoder support
    13101310enabled.
     
    14531453        tempo           number   The music tempo (50-200) (default: 100)
    14541454        speech_volume   number   The speech volume setting (0-255)
    14551455        midi_gain       number   The MIDI gain (0-1000) (default: 100) (Only
    1456                                  suported by some MIDI drivers.)
     1456                                 supported by some MIDI drivers.)
    14571457
    14581458        copy_protection bool     Enable copy protection in SCUMM games, when
    14591459                                 ScummVM disables it by default.
     
    14951495GCC, mingw and recent versions of Microsoft Visual C++ are
    14961496supported. If you wish to use MP3-compressed CD tracks or .SOU files,
    14971497you will need to install the MAD library; likewise you will need the
    1498 appropriatelibraries for Ogg Vorbis and FLAC compressed sound. For
     1498appropriate libraries for Ogg Vorbis and FLAC compressed sound. For
    14991499MPEG2 support, libmpeg2 is required. For compressed save states, zlib is required.
    15001500
    15011501Some parts of ScummVM, particularly scalers, have highly optimized versions