Difference between revisions of "ResidualVM"

From ScummVM :: Wiki
Jump to navigation Jump to search
(expanding upon Residual page a bit to make it more obvious that the program is unstable and with a little more information for users)
Line 1: Line 1:
=== About Residual ===
+
{| border="0" cellpadding="2" cellspacing="1" align="right" style="margin-left:1em; background:#CADCFB;"
Residual is a [http://www.scummvm.org ScummVM] sub-project to play [[LucasArts]]' [http://www.lua.org LUA]-based 3D adventures, such as [[Grim Fandango]].
+
!colspan="3" | Residual
 +
|- border="0" cellpadding="2" cellspacing="1" align="center" style="margin-left:1em; background:#ffffff;"
 +
|- style="background:#ffffff"
 +
|Supported engines || GrimE
 +
|- style="background:#ffffff"
 +
|Engine developer || [[User:aquadran|aquadran]], [[User:Ender|Ender]]
 +
|- style="background:#ffffff"
 +
|Companies that used it || [[LucasArts]]
 +
|- style="background:#ffffff"
 +
|Games that use it || [[Grim Fandango]],<br/>[[Escape from Monkey Island]]
 +
|- style="background:#ffffff"
 +
|Status || Alpha, Unstable
 +
|}
  
The main ScummVM program can run LucasArts 2D [[SCUMM]] adventures (among others).
+
=== About ===
Residual is named such as it aims to do the same for the residual (remaining) games. It is also a word pun, as the engine used in these LUA-based adventure is called GrimE (as opposed to SCUMM). Grime is a type of residue.
+
Residual is a [[About|ScummVM]] sub-project to play [[LucasArts]]' [http://www.lua.org LUA]-based 3D adventures.  [[Grim Fandango]] support is in progress, but gameplay is still incomplete and unstable.  There is no support for [[Escape from Monkey Island]]. Support for this game may be added in the distant future, but this is far from promised.
  
=== What is the state of Residual? ===
+
The main ScummVM program can run LucasArts 2D [[SCUMM]] adventures (among others).  Residual is named such as it aims to do the same for the residual (remaining) games. It is also a word pun, as the engine used in these LUA-based adventures is called GrimE (as opposed to SCUMM). Grime is a type of residue.
Basic gameplay works, including cutscenes, but many features are either missing or unstable. Save/load support is incomplete.
+
 
 +
=== Current State ===
 +
Basic gameplay works, including cutscenes, but many features are either missing or unstable. Save/load support is incomplete.  Crashes can and will occur.  Don't report bugs. Residual is very alpha and we KNOW it doesn't work right.
  
 
Grim is now playable (with some glitches) to:
 
Grim is now playable (with some glitches) to:
Line 12: Line 26:
  
 
For more detailed information on the current status please read the [[Residual/TODO|TODO]] page.
 
For more detailed information on the current status please read the [[Residual/TODO|TODO]] page.
 +
 +
=== Running Residual ===
 +
=== What do I need to run Residual? ===
 +
You need the data files from the original Grim Fandango CDs and a build of Residual for the operating system you are using, which can be found in our [http://scummvm.org/subprojects.php Subprojects] page, or [[Residual#Compiling Residual|compiled from sourcecode]] from our SVN repository.
  
 
=== Linux Requirements ===
 
=== Linux Requirements ===
Line 19: Line 37:
 
* libGLU
 
* libGLU
  
The following components are required if you are compiling from source (in addition to the above):
+
=== Residual 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
 +
 
 +
An example config file looks as follows:
 +
      [residual]<br/><br/>
 +
      [grim]
 +
      path=[path to all the .lab files]
 +
      game_devel_mode=TRUE
 +
 
 +
=== Compiling Residual from Sourcecode ===
 +
 
 +
Residual resides in the subtree 'residual' in our SVN repository.
 +
 
 +
The following components are required if you are compiling from source:
 
* SDL Development Files
 
* SDL Development Files
 
* libGL Development Files
 
* libGL Development Files

Revision as of 07:27, 8 March 2009

Residual
Supported engines GrimE
Engine developer aquadran, Ender
Companies that used it LucasArts
Games that use it Grim Fandango,
Escape from Monkey Island
Status Alpha, Unstable

About

Residual is a ScummVM sub-project to play LucasArts' LUA-based 3D adventures. Grim Fandango support is in progress, but gameplay is still incomplete and unstable. There is no support for Escape from Monkey Island. Support for this game may be added in the distant future, but this is far from promised.

The main ScummVM program can run LucasArts 2D SCUMM adventures (among others). Residual is named such as it aims to do the same for the residual (remaining) games. It is also a word pun, as the engine used in these LUA-based adventures is called GrimE (as opposed to SCUMM). Grime is a type of residue.

Current State

Basic gameplay works, including cutscenes, but many features are either missing or unstable. Save/load support is incomplete. Crashes can and will occur. Don't report bugs. Residual is very alpha and we KNOW it doesn't work right.

Grim is now playable (with some glitches) to:

     Meche leaves Manny again (Rubacava, Year 2)

For more detailed information on the current status please read the TODO page.

Running Residual

What do I need to run Residual?

You need the data files from the original Grim Fandango CDs and a build of Residual for the operating system you are using, which can be found in our Subprojects page, or compiled from sourcecode from our SVN repository.

Linux Requirements

Residual requires a couple system components to be installed in order to run correctly, if you are using a precompiled binary you need to have installed the following packages:

  • SDL
  • libGL
  • libGLU

Residual 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

An example config file looks as follows:

     [residual]

[grim] path=[path to all the .lab files] game_devel_mode=TRUE

Compiling Residual from Sourcecode

Residual resides in the subtree 'residual' in our SVN repository.

The following components are required if you are compiling from source:

  • SDL Development Files
  • libGL Development Files
  • libGLU Development Files

Development/debug keys from the original game

  • Ctrl + e : Enter lua string to execute
  • Ctrl + g : Jump to set
  • Ctrl + i : Toggle walk boxes
  • Ctrl + l : Toggle lighting
  • Ctrl + n : Display background name
  • Ctrl + o : Create a door
  • Ctrl + p : Execute patch file
  • Ctrl + s : Turn on cursor
  • Ctrl + u : Create a new object
  • Ctrl + v : print the value of a variable
  • Alt + l : Display light manager
  • Alt + n : Next viewpoint
  • Alt + p : Prev viewpoint
  • Alt + s : Run lua script
  • Shift + n : Next set
  • Shift + p : Prev set
  • Shift + o : Toggle object names
  • F3 : Toggle sector editor
  • Home : Go to default position in current set
  • j : Enter jump number

Development/debug Sets

For more detailed information on the sets page.