Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 270 lines (216 sloc) 10.19 kb
6cee13a @aquadran update
aquadran authored
1 Residual: A 3D game interpreter
49d6e32 @aquadran added version framework based on scummvm
aquadran authored
2
7d0bb99 @somaen First draft of new and fancier README
somaen authored
3 Contents:
4 1. What is Residual?
6f6234a @somaen README: Restructured README
somaen authored
5 2. Current state of Residual
7d0bb99 @somaen First draft of new and fancier README
somaen authored
6 3. Running Residual
7 4. Keys
8 5. Configuration
9 6. Troubleshooting
10 7. Bug Reports
6f6234a @somaen README: Restructured README
somaen authored
11 8. Contact
12 9. Debugging
7d0bb99 @somaen First draft of new and fancier README
somaen authored
13
6f6234a @somaen README: Restructured README
somaen authored
14 --------------------
7d0bb99 @somaen First draft of new and fancier README
somaen authored
15 1. What is Residual?
16 --------------------
17 Residual is a game engine reimplementation that allows you
18 to play 3D adventure games such as Grim Fandango.
85b948a @Enderboi Mention software renderer
Enderboi authored
19
16fe03b @somaen A few adjustments to the readme
somaen authored
20 Residual utilizes OpenGL for 3D graphics hardware acceleration.
0917677 @Enderboi Update README a little.
Enderboi authored
21 A software renderer is also included for machines without hardware OpenGL.
9e85d30 @Enderboi Update residual docs
Enderboi authored
22
6f6234a @somaen README: Restructured README
somaen authored
23 ----------------------------
24 2. Current state of Residual
25 ----------------------------
14d9433 @aquadran applied patch #2060312
aquadran authored
26 Residual is a fairly slow developing project and is still very much considered
7d0bb99 @somaen First draft of new and fancier README
somaen authored
27 alpha.
9e85d30 @Enderboi Update residual docs
Enderboi authored
28
3de9bdd @somaen Added information about patching to README
somaen authored
29 2.1 - Which games does Residual support?
30 ----------------------------------------
31 Currently Residual supports the GrimE-engine, but only Grim Fandango.
6f6234a @somaen README: Restructured README
somaen authored
32
33 2.1.1 . GrimE-games support
34 -----------------------------------
1798aae @somaen README: Cleaned up tabs
somaen authored
35 Escape From Monkey Island - Not supported*
6f6234a @somaen README: Restructured README
somaen authored
36 Escape From Monkey Island (demo) - Not supported*
1798aae @somaen README: Cleaned up tabs
somaen authored
37 Grim Fandango - Completable with glitches
38 Grim Fandango (demo) - Completable with glitches
e714838 @Enderboi Add note regarding abismal FPS on the many cards without a speedy glD…
Enderboi authored
39
6f6234a @somaen README: Restructured README
somaen authored
40 Specifics can be found at
41 http://residual.sourceforge.net/compatibility/
42
43 * It is possible, but far from promised, that 'Escape from Monkey Island'
44 may be supported in the distant future.
e714838 @Enderboi Add note regarding abismal FPS on the many cards without a speedy glD…
Enderboi authored
45
7d0bb99 @somaen First draft of new and fancier README
somaen authored
46 2.2 - What is the state of Residual?
47 ------------------------------------
6f6234a @somaen README: Restructured README
somaen authored
48 Basic gameplay works, including cutscenes. Grim Fandango is completable
8dfdf5d @aquadran update README
aquadran authored
49 but many features are either missing or unstable. Crashes are likely.
50
16fe03b @somaen A few adjustments to the readme
somaen authored
51 Also beware that since Residual is currently in an alpha-state, there is
52 no guarantee that your saves will continue to work with newer builds.
32604f6 @Enderboi Rewrite LUA TextObject change parser gizmo.
Enderboi authored
53
8d8266b @aquadran updated from scummvm to residual
aquadran authored
54 For more information, see the page on Residual at the wiki page:
dac1d23 @aquadran do not use https for wiki, that is for logged users
aquadran authored
55 http://apps.sourceforge.net/mediawiki/residual
14d9433 @aquadran applied patch #2060312
aquadran authored
56
7d0bb99 @somaen First draft of new and fancier README
somaen authored
57
6f6234a @somaen README: Restructured README
somaen authored
58 -------------------
7d0bb99 @somaen First draft of new and fancier README
somaen authored
59 3. Running Residual
60 -------------------
61 As Residual is not yet stable, easy to use, or complete.
62 Some technical ability might be required.
63
6f6234a @somaen README: Restructured README
somaen authored
64 3.1 - Required files
65 ------------------------------------
7d0bb99 @somaen First draft of new and fancier README
somaen authored
66 You will need the data files for Grim Fandango, as well as the patch,
67 if your game is an older release.
68
69 Specifically you need these files from your Grim CDs:
14d9433 @aquadran applied patch #2060312
aquadran authored
70 *.LAB
71 GRIM.TAB
72
6f6234a @somaen README: Restructured README
somaen authored
73 3.2 - Running Grim Fandango
74 ------------------------------------
75 1. Copy the neccessary files to a folder on your Hard Drive.
3de9bdd @somaen Added information about patching to README
somaen authored
76 2. Apply the patch, if you don't have it*
6f6234a @somaen README: Restructured README
somaen authored
77 2. Open Residual
78 3. Choose "Add Game"
79 4. Select the folder you created in step 1
80 5. Click Start
7d0bb99 @somaen First draft of new and fancier README
somaen authored
81
3de9bdd @somaen Added information about patching to README
somaen authored
82 * Patched versions have subtitles in cutscenes, and can complete
83 the game, unpatched versions don't have subtitles in cutscenes,
84 and can't complete the game.
7d0bb99 @somaen First draft of new and fancier README
somaen authored
85
3de9bdd @somaen Added information about patching to README
somaen authored
86 The patch can be downloaded from:
87 ftp://ftp.lucasarts.com/patches/pc/Gfupd101.exe and obviously requires
88 Windows or something similar to unpack and apply it. (There does exist
89 tools to unpack it on any platform in the residual-tools git-repos).
35fe2b7 @somaen README: Mention patch-guide in wiki
somaen authored
90
91 Additional information on how to apply the patch, can be found in our
92 wiki at: http://sourceforge.net/apps/mediawiki/residual/index.php?title=Grim_Fandango_Patch
3de9bdd @somaen Added information about patching to README
somaen authored
93
94 If you want to try to play with fullscreen, or you want to play with
95 software-rendering, see the configuration-section below.
96
97 -----------------------------
6f6234a @somaen README: Restructured README
somaen authored
98 4 - Default Keyboard-settings
99 -----------------------------
32604f6 @Enderboi Rewrite LUA TextObject change parser gizmo.
Enderboi authored
100 e,u,p,i : Examine, Use, Pickup, Inventory
9e85d30 @Enderboi Update residual docs
Enderboi authored
101 Arrow keys : Movement
102 Shift : Hold to run
32604f6 @Enderboi Rewrite LUA TextObject change parser gizmo.
Enderboi authored
103 Enter : Selects items in inventory, conversation, etc
9e85d30 @Enderboi Update residual docs
Enderboi authored
104 Escape : Skips cutscenes, exits certain screens
6f6234a @somaen README: Restructured README
somaen authored
105 . : Skips dialogue
b537213 @compholio Font patch from Andrea Corna - improved keyframe support - SMUSH loop…
compholio authored
106 q : Exit Dialog Menu
107 Ctrl + c : Force Quit (from command-line)
14d9433 @aquadran applied patch #2060312
aquadran authored
108 Alt + x : Quit (ingame)
109 F1 : Menu
ae64d5d @Enderboi Initial revision
Enderboi authored
110
6f6234a @somaen README: Restructured README
somaen authored
111
112 -----------------
113 5 - Configuration
114 -----------------
7d0bb99 @somaen First draft of new and fancier README
somaen authored
115 Currently, not all the settings for residual are available through the GUI,
116 if you have problems with getting anything to work, first try to pass the settings
117 from the command line, then, if that doesn't work, try to change your configuration file
118 manually
f7b7325 list a bunch of the debug keys in the readme
Jonathan Gray authored
119
6f6234a @somaen README: Restructured README
somaen authored
120 5.1 - Location of configuration file
7d0bb99 @somaen First draft of new and fancier README
somaen authored
121 ------------------------------------
8dfdf5d @aquadran update README
aquadran authored
122 By default, the configuration file is saved in, and loaded from:
123
124 Windows Vista/7:
125 \Users\username\AppData\Roaming\Residual\residual.ini
126
127 Windows 2000/XP:
128 \Documents and Settings\username\Application Data\Residual\residual.ini
129
130 Windows NT4:
131 <windir>\Profiles\username\Application Data\Residual\residual.ini
132
133 Windows 95/98/ME:
134 <windir>\residual.ini
135
136 Unix:
137 ~/.residualrc
138
139 Mac OS X:
140 ~/Library/Preferences/Residual Preferences
141
142 Others:
143 residual.ini in the current directory
144
6f6234a @somaen README: Restructured README
somaen authored
145 5.2 - Interesting settings
146 ------------------------------------
147 The following settings are currently available in the config-file,
148 however some of them might not work with your current build. And
149 some of them might make residual crash, or behave in weird ways.
150
151 |-------------------|-------------|-----------------------------------------------------|
1798aae @somaen README: Cleaned up tabs
somaen authored
152 |Setting | Values | Effect |
6f6234a @somaen README: Restructured README
somaen authored
153 |-------------------|-------------|-----------------------------------------------------|
b879001 The setting for the software renderer is soft_renderer not soft_render.
Joel Teichroeb authored
154 |soft_renderer |[true/false] | If true, then the software renderer will be used |
1798aae @somaen README: Cleaned up tabs
somaen authored
155 | | | otherwise, Residual will try to use HW-rendering. |
6f6234a @somaen README: Restructured README
somaen authored
156 |-------------------|-------------|-----------------------------------------------------|
1798aae @somaen README: Cleaned up tabs
somaen authored
157 |fullscreen |[true/false] | If true, then Residual will attempt to run in |
158 | | | fullscreen-mode, otherwise it will use a window. |
6f6234a @somaen README: Restructured README
somaen authored
159 |-------------------|-------------|-----------------------------------------------------|
1798aae @somaen README: Cleaned up tabs
somaen authored
160 |show_fps |[true/false] | If true, then Residual will show the current |
161 | | | FPS-rate, while you play |
6f6234a @somaen README: Restructured README
somaen authored
162 |-------------------|-------------|-----------------------------------------------------|
1798aae @somaen README: Cleaned up tabs
somaen authored
163 |last_set |[set-name] | The set you were last on, Residual will try to |
164 | | | continue from there |
6f6234a @somaen README: Restructured README
somaen authored
165 |-------------------|-------------|-----------------------------------------------------|
1798aae @somaen README: Cleaned up tabs
somaen authored
166 |last_save |[save-number]| The save you last saved, Residual will have that |
167 | | | selected the next time you try to load a game. |
6f6234a @somaen README: Restructured README
somaen authored
168 |-------------------|-------------|-----------------------------------------------------|
169
170
171 ---------------------------------
172 6. Troubleshooting / Known Issues
173 ---------------------------------
174 Grim Fandango had a few issues when it came out, and a few new and exciting
175 issues when you try to run it on newer hardware. Residual also has a few issues
176 that we know about, look here for help with them, and if you can't find help here
177 try either the forums at our homepage, or IRC: #residual at freenode
178
179 6.1 - The game runs really slow !
7d0bb99 @somaen First draft of new and fancier README
somaen authored
180 ----------------------------------------
181 Some gfx cards do not have a fast glDrawPixels access to zbuffer
6f6234a @somaen README: Restructured README
somaen authored
182 implementation in their system driver.
7d0bb99 @somaen First draft of new and fancier README
somaen authored
183
184 Unix users may be able to achieve playable framerates by using Mesa 5.0 or
185 above, but people unable to upgrade or Windows users must use software
6f6234a @somaen README: Restructured README
somaen authored
186 renderer. Software renderer is generally faster on modern platforms.
7d0bb99 @somaen First draft of new and fancier README
somaen authored
187
6f6234a @somaen README: Restructured README
somaen authored
188 6.2 - I played a bit, but can't start a new game!
7d0bb99 @somaen First draft of new and fancier README
somaen authored
189 -------------------------------------------
190 This is because the last save and visited scene is stored in your configuration
191 file, either delete grim-fandango from the Residual-menu, and readd it, or
192 go to your configuration file, and clean out the last-save and last-set entries.
193
6f6234a @somaen README: Restructured README
somaen authored
194 6.3 - My Save Games don't work any more
195 ---------------------------------------
196 Did you recently update to a newer build of Residual? Residual is still alpha,
197 so the save game format still is a work in progress, which means that it might
198 change between builds.
199
7d0bb99 @somaen First draft of new and fancier README
somaen authored
200
6f6234a @somaen README: Restructured README
somaen authored
201 --------------
7d0bb99 @somaen First draft of new and fancier README
somaen authored
202 7. Bug Reports
203 --------------
6f6234a @somaen README: Restructured README
somaen authored
204 Residual is currently rather young, and therefore still has a few bugs, many might
205 already have been reported, but should you find a new one, don't hesitate to report it.
7d0bb99 @somaen First draft of new and fancier README
somaen authored
206
6f6234a @somaen README: Restructured README
somaen authored
207 7.1 - How, and where do I report bugs?
208 -------------------------------------------------
2150735 @somaen DOCS: Added information about bug reports to README
somaen authored
209 You can report bugs at our github-issue-tracker:
6f6234a @somaen README: Restructured README
somaen authored
210 http://www.github.com/residual/residual/issues
2150735 @somaen DOCS: Added information about bug reports to README
somaen authored
211
212 Please read the Wiki regarding how to report bugs properly first though:
28e6f06 @aquadran missed one https line
aquadran authored
213 http://sourceforge.net/apps/mediawiki/residual/index.php?title=Reporting_Bugs
2150735 @somaen DOCS: Added information about bug reports to README
somaen authored
214
215 Remember to always have the following information in your bug reports:
216 * Bug details, including instructions on reproducing it
217 * Language of game (English, German, ...)
218 * Platform and Compiler (Win32, Linux, MacOS, ...)
219 * Preferably also a link to a save game right before the bug happened.
7d0bb99 @somaen First draft of new and fancier README
somaen authored
220
6f6234a @somaen README: Restructured README
somaen authored
221
222 ----------
223 8. Contact
224 ----------
225 Homepage: http://residual.sourceforge.net/
226 Wiki: http://sourceforge.net/apps/mediawiki/residual/index.php?title=Main_Page
227 Forums: http://residual.scummvm.org/
228 IRC: #residual on freenode
229
230
231 ------------
232 9. Debugging
7d0bb99 @somaen First draft of new and fancier README
somaen authored
233 ------------
234 WARNING: This section contains information about the various tools that
235 are included for debugging residual, this should not be necessary for
6f6234a @somaen README: Restructured README
somaen authored
236 normal play at all. But the curious might like to know how. Use at your
237 own risk.
7d0bb99 @somaen First draft of new and fancier README
somaen authored
238
6f6234a @somaen README: Restructured README
somaen authored
239 9.1 How do I enable debug-keys/debug-mode?
240 -------------------------------------------------
241 To enable debug-keys, and debug-mode you will have to add the following
242 to your configuration file under your Grim Fandango-entry:
243
244 game_devel_mode=true
245
246 9.2 Development/debug keys from the original game
7d0bb99 @somaen First draft of new and fancier README
somaen authored
247 -------------------------------------------------
248 Ctrl + e : Enter lua string to execute
249 Ctrl + g : Jump to set
250 Ctrl + i : Toggle walk boxes
251 Ctrl + l : Toggle lighting
252 Ctrl + n : Display background name
253 Ctrl + o : Create a door
254 Ctrl + p : Execute patch file
255 Ctrl + s : Turn on cursor
256 Ctrl + u : Create a new object
257 Ctrl + v : Print the value of a variable
258 Alt + n : Next viewpoint
259 Apt + p : Prev viewpoint
260 Alt + s : Run lua script
261 Shift + n : Next set
262 Shift + p : Prev set
263 Shift + o : Toggle object names
264 F3 : Toggle sector editor
265 Home : Go to default position in current set
266 j : Enter jump number
267
268 Note that these are only available after enabling debug-mode.
269
Something went wrong with that request. Please try again.