Welcome, Guest! Log In | Create Account

Main Page

From residual

Jump to: navigation, search

Contents

Welcome to the Residual wiki

Documents in this wiki are under the GNU Free Documentation License 1.2 (see Copyrights).

About Project

Residual is a cross-platform 3D game interpreter which allows to play LucasArts' LUA-based 3D adventures: Grim Fandango and Escape from Monkey Island. 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.

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 Downloads page.

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

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.