Skip to content

Commit

Permalink
patches / scripts
Browse files Browse the repository at this point in the history 
started global hotspot registry

cleanup, hot files

walkpath support

binary hotspot file

patchr works now

lots of fixes

jess' fixes

new patchr files, README

cleanup

reorganized patches
  • Loading branch information
verticalduck authored and Tobias Pfaff committed Jun 30, 2014
1 parent b698716 commit 885548e
Show file tree
Hide file tree
Showing 227 changed files with 1,658 additions and 1,225 deletions.
7 changes: 7 additions & 0 deletions .gitignore
View file
Expand Up @@ -145,3 +145,10 @@ TAGS

residualvm.kdev4
hs/.kdev4/

patchr
diffr
lua.tgz
mklab
run
config_mac
331 changes: 70 additions & 261 deletions README
View file
@@ -1,264 +1,73 @@
ResidualVM: A 3D game interpreter

Contents:
1. What is ResidualVM?
2. Current state of ResidualVM
3. Running ResidualVM
4. Keys
5. Configuration
6. Troubleshooting
7. Bug Reports
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
------------------------------
At this point ResidualVM is fit for normal use, when playing supported
games, it is however worth noting that you should still save early, and
save often, as problems or dead-ends might still exist. (Grim Fandango
itself originally had a few unintentional ways to get the game stuck).

2.1 - Which games does ResidualVM support?
------------------------------------------
Currently ResidualVM supports the GrimE-engine, but only Grim Fandango,
and has partial support for Myst 3.

2.1.1 . GrimE-games support
-----------------------------------
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
-----------------------------------
Myst 3 - Partially playable

Specifics can be found at
http://www.residualvm.org/compatibility/

For more information, see the page on ResidualVM at the wiki page:
http://wiki.residualvm.org/


---------------------
3. Running ResidualVM
---------------------

3.1 - Required files
-----------------------------------
You will need the data files for Grim Fandango, as well as the official
patch (gfupd101.exe).

Specifically you need these files from your Grim CDs:
*.LAB

3.2 - Running Grim Fandango
---------------------------
1. Copy the necessary files to a folder on your Hard Drive
2. Copy the patch to this game folder
3. Open ResidualVM
4. Choose "Add Game"
5. Select the folder you created in step 1
6. Click Start

The patch can be downloaded from:
http://demos.residualvm.org/patches/gfupd101.exe
Simply download it and put gfupd101.exe in the same folder as the .LAB-files,
and you are good to go.

If you want to play with software-rendering, see the configuration-section below.
(or use the ingame settings to disable 3D Acceleration)

When launching the game for the first time, ResidualVM will perform a full integrity
check of your game data files. This can take a bit of time, but it will
not happen again on successive runs.

-----------------------------
4 - Default Keyboard-settings
-----------------------------
e,u,p,i : Examine, Use, Pickup, Inventory
Arrow keys : Movement
Shift : Hold to run
Enter : Selects items in inventory, conversation, etc
Escape : Skips cutscenes, exits certain screens
. : Skips dialogue
q : Exit Dialog Menu
Ctrl + c : Force Quit (from command-line)
Alt + x : Quit (ingame)
Alt + enter: Switch between windowed-mode and fullscreen
F1 : Menu


-----------------
5 - Configuration
-----------------
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.

5.1 - Location of configuration file
------------------------------------
By default, the configuration file is saved in, and loaded from:

Windows Vista/7:
\Users\username\AppData\Roaming\ResidualVM\residualvm.ini

Windows 2000/XP:
\Documents and Settings\username\Application Data\ResidualVM\residualvm.ini

Windows NT4:
<windir>\Profiles\username\Application Data\ResidualVM\residualvm.ini

Windows 95/98/ME:
<windir>\residualvm.ini

Unix:
~/.residualvmrc

Mac OS X:
~/Library/Preferences/ResidualVM Preferences

Others:
residualvm.ini in the current directory

5.2 - Interesting settings
------------------------------------
The following settings are currently available in the config-file,
however some of them might not work with your current build. And
some of them might make ResidualVM crash, or behave in weird ways.

|---------------|-------------|-----------------------------------------------------|
|Setting | Values | Effect |
|---------------|-------------|-----------------------------------------------------|
|show_fps |[true/false] | If true, then ResidualVM will show the current |
| | | FPS-rate, while you play |
|---------------|-------------|-----------------------------------------------------|
|last_set |[set-name] | The set you were last on, ResidualVM will try to |
| | | continue from there |
|---------------|-------------|-----------------------------------------------------|
|last_save |[save-number]| The save you last saved, ResidualVM will have that |
| | | selected the next time you try to load a game. |
|---------------|-------------|-----------------------------------------------------|
|use_arb_shaders|[true/false] | If true, and if you are using the OpenGL renderer |
| | | ResidualVM will use ARB shaders. While fast they |
| | | may be incompatible with some graphics drivers. |
|---------------|-------------|-----------------------------------------------------|


---------------------------------------
6. Troubleshooting / Known Bugs, Issues
---------------------------------------
Grim Fandango had a few issues when it came out, and a few new and exciting
issues when you try to run it on newer hardware. Some of these have been
fixed in ResidualVM, but ResidualVM itself also has a few new issues that we know about:
http://github.com/residualvm/residualvm/blob/master/KNOWN_BUGS
Look below 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!
--------------------------------
Some gfx cards do not have a fast glDrawPixels access to zbuffer
implementation in their 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 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 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
---------------------------------------
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.

Grim Mouse
A point-and-click interface for Grim Fandango
Version 0.1

--------------
7. Bug Reports
What is this ?
--------------
ResidualVM is currently rather young, and therefore still has a few bugs, many might
already have been reported, but should you find a new one, don't hesitate to report it.

7.1 - How, and where do I report bugs?
-------------------------------------------------
You can report bugs at our github-issue-tracker:
http://www.github.com/residualvm/residualvm/issues

Please read the Wiki regarding how to report bugs properly first though:
http://wiki.residualvm.org/index.php?title=Reporting_Bugs

Remember to always have the following information in your bug reports:
* Bug details, including instructions on reproducing it
* Language of game (English, German, ...)
* Platform and Compiler (Win32, Linux, MacOS, ...)
* Preferably also a link to a save game right before the bug happened.


----------
8. Contact
----------
Homepage: http://www.residualvm.org/
Wiki: http://wiki.residualvm.org/
Forums: http://forums.residualvm.org/
IRC: #residualvm on freenode


------------
9. Debugging
------------
WARNING: This section contains information about the various tools that
are included for debugging ResidualVM, this should not be necessary for
normal play at all. But the curious might like to know how. Use at your
own risk.

9.1 How do I enable debug-keys/debug-mode?
-------------------------------------------------
To enable debug-keys, and debug-mode you will have to add the following
to your configuration file under your Grim Fandango-entry:

game_devel_mode=true

9.2 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 + n : Next viewpoint
Apt + 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

Note that these are only available after enabling debug-mode.
Grim Mouse allows to play 'Grim Fandango' like a point-and-click adventure,
instead of the original tank-style keyboard controls.
The mod is based on the ResidualVM game engine, which means it will also run on
Mac and Linux, not only on Windows as the original game.

* Important note *
Please note that as the game was never meant to be played using the mouse,
Grim Mouse heavily modifies both the game source code and the surrounding
VM-- Neither LucasArts nor the ResidualVM team will provide support for this
mod. See below for information on how to report bugs.

-------------
Current state
-------------
This mod is a very early alpha, and has not been well tested yet. You are
very likely to run into bugs, which may prevent you from finishing the game --
so save often and play at your own risk.

------------------
Running Grim Mouse
------------------
Please read the original documentation of ResidualVM (README.ResidualVM or
http://residualvm.org) on how to install the VM and set up Grim Fandango.
In addition, you must copy the file mouse.lab from dists/engine-data
into your game data folder (where data000.lab etc. are located).

Most of the keyboard controls still work in the original manner;
while the game should be playable 100% using the mouse only, if there are
some puzzles which you prefer to solve using the old interface, you can do so.

* New controls *
Left-click : Walk and use
If you left-click on an object, it is used. If Manny
is holding an inventory object, it is used on the scene object.
Double-click : Run and use
Same as single-click, except Manny will run to the object.
Right-click : Look at / Use inventory object on its own
Same as left-click, except Manny will look at an object instead
of using it. If Manny is holding an inventory object, right-click
will use it on its own (e.g. deck of cards, or fire extinguisher
in Beaver Dam)
Middle-click : Open Inventory
(or I key) If Manny is holding an object, he will put it away.
Left-click within the inventory selects an object, right-click
will make Manny look at it.
Space key : Show all hotspots in the scene

* Useful old controls *
Alt+Enter : Toggle fullscreen mode
Arrow keys : Control Manny the old fashioned way
E,U,P,I : Examine, Use, Pickup, Inventory
F1 : Menu (use arrow keys to navigate)
Escape : Skip some cutscenes
. : Skip dialogue lines

---------------
Troubleshooting
---------------
Bugs are to be expected. Please report your bugs in the github issue tracker
https://github.com/tobiaspfaff/grim_mouse/issues (preferred)
or by email (verticalduck (at) gmail.com) if you don't have a github account.

If you are stuck due to a bug and want to continue playing the game, you can try
using the old controls to manouver out of broken boxes, or activating the
developer mode with Shift+Z and teleport into an adjacent scene etc. (Check
README.ResidualVM for the developer mode shortcuts)

0 comments on commit 885548e

Please sign in to comment.