Ticket #8718: readme.diff

File readme.diff, 6.6 KB (added by SF/clemty, 17 years ago)

some fixes for README

  • README

    old new  
    11ScummVM README
    2 Last updated:    $Date: 2007-07-25 22:12:41 +0200 (Wed, 25 Jul 2007) $
     2Last updated:    $Date$
    33------------------------------------------------------------------------
    44
    55TODO: Resolve all the TODOs scattered through this file before release.
     
    170170         - Swampy Adventures                     [swampy]
    171171     The Feeble Files                            [feeble]
    172172
    173 GOB Games by Cocktel Vision:
     173GOB Games by Coktel Vision:
    174174     Bargon Attack                               [bargon]
    175175     Gobliiins                                   [gob1]
    176176     Gobliins 2                                  [gob2]
     
    296296should be able to automatically detect the game if you point it at the
    297297right directory.
    298298
    299 Alternatively, you can use extract_mm_c64 from the tools package to
     299Alternatively, you can use 'extract_mm_c64' from the tools package to
    300300extract the data files. But then the game will not be properly
    301301autodetected by ScummVM, and you must make sure that the platform is
    302302set to Commodore64. We recommend using the much simpler approach
     
    346346simply point ScummVM at the directory containing it, and it should work (just like
    347347with every other supported game).
    348348
    349 We also provide a tool called 'rescumm' in the tools package to extract the
     349We also provide a tool called 'extract_scumm_mac' in the tools package to extract the
    350350data from these data files, but this is neither required nor recommended.
    351351
    352352For further information on copying Macintosh game files to your hard disk see:
     
    400400These cutscenes are provided in DXA format with FLAC audio. Their quality
    401401is equal to the original games due to the use of lossless compression.
    402402Viewing these cutscenes requires a version of ScummVM compiled with both
    403 FLAC and zLib support.
     403FLAC and zlib support.
    404404
    405405For systems that are too slow to handle the decoding of FLAC audio,
    406406the audio for these cutscenes is provided separately as OGG Vorbis audio
    407407too. Viewing these cutscenes with OGG Vorbis audio requires a version of
    408 ScummVM compiled with both libVorbis and zLib support.
     408ScummVM compiled with both libVorbis and zlib support.
    409409
    410410The cutscenes should be placed in the main game data directory. Note that
    411411currently this requires either copying the game to hard disk or burning
     
    790790                           Steel Sky and Flight of the Amazon Queen
    791791  --copy-protection        Enable copy protection in games, when
    792792                           ScummVM disables it by default.
     793  --talkspeed=NUM          Set talk speed for games (default: 60)
    793794  --demo-mode              Start demo mode of Maniac Mansion (Classic version)
    794795  --tempo=NUM              Set music tempo (in percent, 50-200) for SCUMM games
    795796                           (default: 100)
    796   --talkspeed=NUM          Set talk speed for games
    797797
    798798
    799799The meaning of most long options (that is, those options starting with a
     
    832832but rather is only used to select the appropriate font (e.g. for a German
    833833version of a game, one containing umlauts).
    834834
     835An exception are The Dig and The Curse of Monkey Island - non-English versions
     836can be set to 'English.' This however only affects subtitles; game speech will
     837remain the same.
     838
    835839Maniac Mansion and Zak McKracken
    836840        en  - English (default)
    837841        de  - German
     
    933937---- ---------
    934938TODO
    935939TODO: Rework this section to clearly state which hotkeys are implemented in *all*
    936 TODO  game (and for which backends).
     940TODO  games (and for which backends).
    937941TODO: It would also be nice to add information about control on devices w/o a keyboard;
    938942TODO  I.e. document how input on DC, DS, PSP, PS2, PalmOS, WinCE, ... works for each game
    939943TODO  Or at the very least give points as to were one can read up on these.
     
    10771081        t                      - Switch between 'Voice only',
    10781082                                 'Voice and Text' and 'Text only'
    10791083
    1080 Note that using ctrl-f or ctrl-g is not recommended: games can crash when
     1084Note that using Ctrl-f or Ctrl-g is not recommended: games can crash when
    10811085being run faster than their normal speed, as scripts will lose synchronisation.
    10821086
    10831087Note for WinCE users: Due to the limited keyboard input in most devices, a
     
    11891193---- ----------------------------------
    11901194Some games (such as Sam & Max) only contain MIDI music data.  This once
    11911195prevented music for these games from working on platforms that do not support
    1192 MIDI, or soundcards that do not provide MIDI drivers (e.g, many soundcards will
     1196MIDI, or soundcards that do not provide MIDI drivers (e.g. many soundcards will
    11931197not play MIDI under Linux). ScummVM can now emulate MIDI mode using sampled
    11941198waves and Adlib, FluidSynth MIDI emulation or MT-32 emulation using the
    11951199-eadlib, -efluidsynth or -emt32 options respectively.  However, if you are
     
    13391343
    134013447.7.3) Compressing MONSTER.SOU with MP3:
    13411345------ ---------------------------------
    1342 You need LAME, and our compress_scumm_sou utility from the scummvm-tools
     1346You need LAME, and our 'compress_scumm_sou' utility from the scummvm-tools
    13431347package to perform this task, and ScummVM must be compiled with MAD support.
    13441348
    13451349  compress_scumm_sou monster.sou
     
    13751379
    137613807.7.6) Compressing music/sfx/speech in AGOS games
    13771381------ -----------------------------------------------------------------
    1378 Use our compress_agos utility from the scummvm-tools package to perform this
     1382Use our 'compress_agos' utility from the scummvm-tools package to perform this
    13791383task. You can choose between multiple target formats, but note that you can
    13801384only use each if ScummVM was compiled with the respective decoder support
    13811385enabled.
     
    14101414
    141114157.7.7) Compressing speech/music in Broken Sword 1
    14121416------ ------------------------------------------
    1413 The compress_sword1 tool from the scummvm-tools package can encode music and
     1417The 'compress_sword1' tool from the scummvm-tools package can encode music and
    14141418speech to MP3 as well as Ogg Vorbis.
    14151419The easiest way to encode the files is simply copying the executable into your
    14161420BS1 directory (together with the lame encoder) and run it from there.
     
    14291433
    143014347.7.8) Compressing speech/music in Broken Sword 2
    14311435------ ------------------------------------------
    1432 Use our compress_sword2 utility from the scummvm-tools package to perform this
     1436Use our 'compress_sword2' utility from the scummvm-tools package to perform this
    14331437task. You can choose between multiple target formats, but note  that you can
    14341438only use each if ScummVM was compiled with the respective decoder support
    14351439enabled.