update README

This commit is contained in:
Pawel Kolodziejski 2011-04-15 12:46:44 +02:00
parent 015b4dacb9
commit 8dfdf5df14

89
README
View File

@ -1,8 +1,5 @@
Residual: A 3D game interpreter
Last updated: $Date$
------------------------------------------------------------------------------
What is Residual?
-----------------
Residual allow to play 3D games such as Grim Fandango.
@ -13,78 +10,31 @@ A software renderer is also included for machines without hardware OpenGL.
Which games does it support?
----------------------------
Residual is a fairly slow developing project and is still very much considered
alpha. Currently it contains initial support for Grim Fandango.
alpha. Currently it contains limited support for Grim Fandango.
It is possible, but far from promised, that the other LucasArts LUA-based
title 'Escape from Monkey Island' may be supported in the distant future.
How do I run Residual?
----------------------
As Residual is still under heavy development it is not yet stable, easy
to use, or complete. Some technical ability is required.
See the Configuration File section to see how to create the configuration
file.
To see a list of supported command-line parameters, run Residual with the
argument --help
Configuration file:
-------------------
By default, the configuration file is saved in, and loaded from:
Windows Vista:
\Users\username\AppData\Roaming\Residual\residual.ini
Windows 2000/XP:
\Documents and Settings\username\Application Data\Residual\residual.ini
Windows NT4:
<windir>\Profiles\username\Application Data\Residual\residual.ini
Windows 95/98/ME:
<windir>\residual.ini
Unix:
~/.residualrc
Mac OS X:
~/Library/Preferences/Residual Preferences
Others:
residual.ini in the current directory
As Residual is not yet stable, easy to use, or complete.
Some technical ability is required.
It runs really slow !
----------------------------------------
A large portion of gfx cards do not have a fast glDrawPixels access to zbuffer
implementation in the driver.
Some gfx cards do not have a fast glDrawPixels access to zbuffer
implementation in the system driver.
Unix users may be able to achieve playable framerates by using Mesa 5.0 or
above, but people unable to upgrade or Windows users must use software
renderer. Software renderer is generally faster on modern platform.
Black screen while menu dialogs on Radeon with Windows!
-------------------------------------------------------
Turn off "force fullscene antialiasing" in the OpenGL gfx driver options.
What is the state of Residual?
------------------------------
Basic gameplay works, including cutscenes. Parts of the game are playable,
but many features are either missing or unstable. There is no ability
to reliably save/load games, etc. Crashes are likely.
but many features are either missing or unstable. Crashes are likely.
Game currently playable to:
Meche leaves Manny again (Rubacava, Year 2)
Caveats (in order of appearance):
1) Sound track destruction doesn't do quite a good enough job when
entering the spider web area (sp.set) in the Petrified Forest
2) Video of Copal's death (among other movies) plays at *almost* 2x
the correct speed, this causes buffer overflows in the audio.
While hardcoding the speed to the correct value used by the other
movies works, it is not a good fix and so it is not implemented
3) Sometimes the Demon Beavers get stuck on obstacles - open the
menu for a moment and they will correct themselves
Game currently playable to around Year 2.
For more information, see the page on Residual at the wiki page:
https://apps.sourceforge.net/mediawiki/residual
@ -128,6 +78,31 @@ F3 : Toggle sector editor
Home : Go to default position in current set
j : Enter jump number
Configuration file:
-------------------
By default, the configuration file is saved in, and loaded from:
Windows Vista/7:
\Users\username\AppData\Roaming\Residual\residual.ini
Windows 2000/XP:
\Documents and Settings\username\Application Data\Residual\residual.ini
Windows NT4:
<windir>\Profiles\username\Application Data\Residual\residual.ini
Windows 95/98/ME:
<windir>\residual.ini
Unix:
~/.residualrc
Mac OS X:
~/Library/Preferences/Residual Preferences
Others:
residual.ini in the current directory
How do I report bugs?
---------------------
Don't. Residual is very alpha and we KNOW it doesn't work right.