diff --git a/README b/README index ba8d43dc034..fdc83e1467e 100644 --- a/README +++ b/README @@ -11,29 +11,31 @@ Contents: 8. Contact 9. Debugging --------------------- +---------------------- 1. What is ResidualVM? --------------------- +---------------------- ResidualVM is a game engine reimplementation that allows you to play 3D adventure games such as Grim Fandango and Myst3. ResidualVM utilizes OpenGL for 3D graphics hardware acceleration. A software renderer is also included for machines without hardware OpenGL. ----------------------------- + +------------------------------ 2. Current state of ResidualVM ----------------------------- +------------------------------ 2.1 - Which games does ResidualVM support? ----------------------------------------- -Currently ResidualVM supports the GrimE-engine, but only Grim Fandango, and has partial support for Myst 3. +------------------------------------------ +Currently ResidualVM supports the GrimE-engine, but only Grim Fandango, +and has partial support for Myst 3. 2.1.1 . GrimE-games support ----------------------------------- -Escape From Monkey Island - Not supported* -Escape From Monkey Island (demo) - Not supported* Grim Fandango - Completable with glitches Grim Fandango (demo) - Completable with glitches +Escape From Monkey Island - Not supported, play only intro +Escape From Monkey Island (demo) - Not supported, play only intro 2.1.2 . Other games support ----------------------------------- @@ -42,20 +44,16 @@ Myst 3 - Partially playable Specifics can be found at http://www.residualvm.org/compatibility/ -* It is possible, but far from promised, that 'Escape from Monkey Island' - may be supported in the distant future. - For more information, see the page on ResidualVM at the wiki page: http://wiki.residualvm.org/ + --------------------- 3. Running ResidualVM --------------------- -As ResidualVM is not yet stable, easy to use, or complete. -Some technical ability might be required. 3.1 - Required files ------------------------------------- +-------------------- You will need the data files for Grim Fandango, as well as the patch, if your game is an older release. @@ -64,7 +62,7 @@ Specifically you need these files from your Grim CDs: GRIM.TAB 3.2 - Running Grim Fandango ------------------------------------- +--------------------------- 1. Copy the neccessary files to a folder on your Hard Drive. 2. Apply the patch, if you don't have it* 2. Open ResidualVM @@ -83,6 +81,7 @@ and you are good to go. If you want to play with software-rendering, see the configuration-section below. + ----------------------------- 4 - Default Keyboard-settings ----------------------------- @@ -91,7 +90,7 @@ Arrow keys : Movement Shift : Hold to run Enter : Selects items in inventory, conversation, etc Escape : Skips cutscenes, exits certain screens -. : Skips dialogue +. : Skips dialogue q : Exit Dialog Menu Ctrl + c : Force Quit (from command-line) Alt + x : Quit (ingame) @@ -105,7 +104,7 @@ F1 : Menu Currently, not all the settings for ResidualVM are available through the GUI, if you have problems with getting anything to work, first try to pass the settings from the command line, then, if that doesn't work, try to change your configuration file -manually +manually. 5.1 - Location of configuration file ------------------------------------ @@ -141,12 +140,6 @@ some of them might make ResidualVM crash, or behave in weird ways. |-------------------|-------------|-----------------------------------------------------| |Setting | Values | Effect | |-------------------|-------------|-----------------------------------------------------| -|soft_renderer |[true/false] | If true, then the software renderer will be used | -| | | otherwise, ResidualVM will try to use HW-rendering. | -|-------------------|-------------|-----------------------------------------------------| -|fullscreen |[true/false] | If true, then ResidualVM will attempt to run in | -| | | fullscreen-mode, otherwise it will use a window. | -|-------------------|-------------|-----------------------------------------------------| |show_fps |[true/false] | If true, then ResidualVM will show the current | | | | FPS-rate, while you play | |-------------------|-------------|-----------------------------------------------------| @@ -166,8 +159,8 @@ issues when you try to run it on newer hardware. ResidualVM also has a few issue that we know about, look here for help with them, and if you can't find help here try either the forums at our homepage, or IRC: #residualvm at freenode -6.1 - The game runs really slow ! ----------------------------------------- +6.1 - The game runs really slow! +-------------------------------- Some gfx cards do not have a fast glDrawPixels access to zbuffer implementation in their system driver. @@ -176,9 +169,9 @@ above, but people unable to upgrade or Windows users must use software renderer. Software renderer is generally faster on modern platforms. 6.2 - I played a bit, but can't start a new game! -------------------------------------------- +------------------------------------------------- This is because the last save and visited scene is stored in your configuration -file, either delete grim-fandango from the ResidualVM-menu, and readd it, or +file, either delete grim-fandango from the ResidualVM-menu, and re-add it, or go to your configuration file, and clean out the last-save and last-set entries. 6.3 - My Save Games don't work any more @@ -187,6 +180,10 @@ Did you recently update to a newer build of ResidualVM? Grim engine is still a work in progress, which means that it might change between builds. +6.4 - In fullscreen mode picture is stretched! +---------------------------------------------- +This is know issue, in future versions it will be resolved. + -------------- 7. Bug Reports @@ -256,4 +253,3 @@ Home : Go to default position in current set j : Enter jump number Note that these are only available after enabling debug-mode. -