Difference between revisions of "ResidualVM"

From ScummVM :: Wiki
Jump to navigation Jump to search
(remove trailing of)
(12 intermediate revisions by 5 users not shown)
Line 1: Line 1:
=== About Residual ===
[http://residualvm.org/ ResidualVM] started as a sub-project of ScummVM for the "residual" [[LucasArts]] games that could not be added to ScummVM because they are 3D games, namely [[Grim Fandango]] and [[Escape from Monkey Island]], using the [http://www.lua.org Lua]-based Grim Engine (GrimE).
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]].
Residual is an [http://www.opengl.org OpenGL] program, and requires a 3D card with working OpenGL support for the best experience.  


A software renderer is also available, but is less tested.
It has gained its independence since then as a project similar to ScummVM but for 3D adventure games with several engines from other game companies being developed.


The main ScummVM program can run LucasArts 2D [[SCUMM]] adventures (among others).
For more detailed information on the current status please read the [http://wiki.residualvm.org/ ResidualVM Wiki].
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.
 
=== What is the state of Residual? ===
Basic gameplay works, including cutscenes, but many features are either missing or unstable. Save/load support is incomplete.
 
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 [[Residual_TODO|TODO]] 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 follow packages:
* SDL
* libGL
* libGLU
 
The following components are required if you are compiling from source (in addition to the above):
* 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 [[Residual_Sets|Sets]] page.

Revision as of 06:20, 7 July 2020

ResidualVM started as a sub-project of ScummVM for the "residual" LucasArts games that could not be added to ScummVM because they are 3D games, namely Grim Fandango and Escape from Monkey Island, using the Lua-based Grim Engine (GrimE).

It has gained its independence since then as a project similar to ScummVM but for 3D adventure games with several engines from other game companies being developed.

For more detailed information on the current status please read the ResidualVM Wiki.