Ticket #8913: readme.diff

File readme.diff, 5.4 KB (added by SF/clemty, 16 years ago)

Residual README changes

  • README

    old new  
    66What is Residual?
    77-----------------
    88Residual is a ScummVM (http://www.scummvm.org/) sub-project to play LucasArts'
    9 LUA-based 3D adventures, such as Grim Fandango. Residual use OpenGL for 3d
    10 graphics hardware acceleration.
     9LUA-based 3D adventures, such as Grim Fandango. Residual utilizes OpenGL for
     103d graphics hardware acceleration.
    1111
    1212A software renderer is also included for machines without hardware OpenGL.
    1313
     
    1616games. It is also a word pun, as the engine used in these LUA-based adventure
    1717is called GrimE (as opposed to SCUMM). Grime is a type of residue.
    1818
    19 What games does it support?
    20 ---------------------------
    21 Residual is a fairly new project and slow developing project, and is still very
    22 much considered alpha. Currently it contains initial support for Grim Fandango.
     19Which games does it support?
     20----------------------------
     21Residual is a fairly slow developing project and is still very much considered
     22alpha. Currently it contains initial support for Grim Fandango.
    2323
    24 It is possible, but far from promised, that we can support the other LucasArts
    25 LUA-based title 'Escape from Monkey Island' in the distant future.
     24It is possible, but far from promised, that the other LucasArts LUA-based
     25title 'Escape from Monkey Island' may be supported in the distant future.
    2626
    2727How do I run Residual?
    2828----------------------
    29 As Residual is still under heavy development, it is not yet stable, easy
    30 to use, nor complete. Some technical ability is required.
     29As Residual is still under heavy development it is not yet stable, easy
     30to use, or complete. Some technical ability is required.
    3131
    32 See the Configuation File section, to see how to create the configulatun file.
     32See the Configuration File section to see how to create the configuration
     33file.
    3334
    34 Residual understands command-line options:
    35 '-fps' display fps information.
    36 '-fullscreen' switch to full screen
    37 '-soft' switch to software 3d renderering.
    38 '-zbuffer' enables masking for hardware 3d rendering.
     35To see a list of supported command-line parameters, run Residual with the
     36argument --help
    3937
    4038Configuration file:
    41 ---- -------------------
     39-------------------
    4240By default, the configuration file is saved in, and loaded from:
    4341
    4442        Windows Vista:
    45         \Users\username\AppData\Roaming\Residual\residual.ini,
     43        \Users\username\AppData\Roaming\Residual\residual.ini
    4644
    4745        Windows 2000/XP:
    48         \Documents and Settings\username\Application Data\Residual\residual.ini,
     46        \Documents and Settings\username\Application Data\Residual\residual.ini
    4947
    5048        Windows NT4:
    51         <windir>\Profiles\username\Application Data\Residual\residual.ini,
     49        <windir>\Profiles\username\Application Data\Residual\residual.ini
    5250
    5351        Windows 95/98/ME:
    54        <windir>\residual.ini,
     52       <windir>\residual.ini
    5553
    5654        Unix:
    5755        ~/.residualrc
     
    7169
    7270It runs really slow when using -zbuffer!
    7371----------------------------------------
    74 A large portion of cards do not have a fast glDrawPixels access to zbuffer
     72A large portion of gfx cards do not have a fast glDrawPixels access to zbuffer
    7573implementation in the driver.
    7674
    7775Unix users may be able to achieve playable framerates by using Mesa 5.0 or
    7876above, but people unable to upgrade or Windows users must use software
    79 renderer (-soft). Software renderer is generaly faster on modern platform.
     77renderer (-soft). Software renderer is generally faster on modern platform.
    8078
    8179Black screen while menu dialogs on Radeon with Windows!
    8280-------------------------------------------------------
    83 Turn off force fullscene antialiasing in OpenGL gfx driver options.
     81Turn off "force fullscene antialiasing" in the OpenGL gfx driver options.
    8482
    8583What is the state of Residual?
    86 -------------------------------
    87 Basic gameplay works, including cutscenes. Some of the game is playable,
    88 but many features are either missing or unstable. There is no abilitity
    89 to save/load, etc. Crashes are likely.
     84------------------------------
     85Basic gameplay works, including cutscenes. Parts of the game are playable,
     86but many features are either missing or unstable. There is no ability
     87to reliably save/load games, etc. Crashes are likely.
    9088
    9189Game currently playable to:
    9290        Meche leaves Manny again (Rubacava, Year 2)
     
    101993) Sometimes the Demon Beavers get stuck on obstacles - open the
    102100   menu for a moment and they will correct themselves
    103101
     102For more information, see the page on Residual at the ScummVM wiki:
     103http://wiki.scummvm.org/index.php/Residual
     104
     105Which datafiles are needed?
     106---------------------------
     107*.LAB
     108GRIM.TAB
     109
    104110What are the default keys?
    105111--------------------------
    106112e,u,p,i    : Examine, Use, Pickup, Inventory
     
    110116Escape     : Skips cutscenes, exits certain screens
    111117q          : Exit Dialog Menu
    112118Ctrl + c   : Force Quit (from command-line)
     119Alt + x    : Quit (ingame)
     120F1         : Menu
    113121
    114122Development/debug keys from the original game
    115123---------------------------------------------
     
    122130Ctrl + p   : Execute patch file
    123131Ctrl + s   : Turn on cursor
    124132Ctrl + u   : Create a new object
    125 Ctrl + v   : print the value of a variable
     133Ctrl + v   : Print the value of a variable
    126134Alt + n    : Next viewpoint
    127135Apt + p    : Prev viewpoint
    128136Alt + s    : Run lua script