FAQ
last updated: April 05, 2014
1. Introduction
1.1. Why is it called ResidualVM - what does this name mean?
1.2. What is GrimE ?
1.3. Is ResidualVM free?
1.4. On what platform does ResidualVM run?
2. Supported games
2.1. What games does ResidualVM support?
3. Running games
3.1. How do I install games to run in ResidualVM?
4. Troubleshooting
4.1. My game crashes at some point.
4.2. ResidualVM crashes, but the console window disappears too quickly to see the error message.
4.3. Reporting Bugs.
4.4. I get "WARNING: Unable to open configuration file C:\windows\residualvm.ini!"
4.5. I get "Failed to save game state to file: xxx"
4.6. ResidualVM starts, but all I get is a transparent window!
4.7. ResidualVM runs, but sound is stuttering and/or garbled!
4.8. ResidualVM runs in fullscreen mode, but graphics is stretched!
4.9. How do I set an environment variable?
4.10. ResidualVM starts somewhere in the middle of my two Xinerama monitors in fullscreen mode. Help!

### 1. Introduction

1.1. Why is it called ResidualVM - what does this name mean?
1.2. What is GrimE ?
1.3. Is ResidualVM free?
1.4. On what platform does ResidualVM run?
1.1. Why is it called ResidualVM - what does this name mean?

The ScummVM program can run LucasArts 2D SCUMM adventures (among others). ResidualVM 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 games is called GrimE (as opposed to SCUMM). Grime is a type of residue.

1.2. What is GrimE ?

GrimE (Grim Engine) is an adventure game engine, created by Bret Mogilefsky at LucasArts using scripting language Lua. It was first used for Grim Fandango.

1.3. Is ResidualVM free?

ResidualVM is released under the GPL (General Public License), so it's more than free. ResidualVM source code is freely available and you can do whatever you want with it. If you make modifications to it and redistribute your work you MUST make the source available. However, the ResidualVM team would be pleased if you choose to send them your modifications, so they can be merged into the main tree.

1.4. On what platform does ResidualVM run?

ResidualVM should be able to be compiled on any SDL platform, with modifications.

Currently tested platforms include Windows (Windows 95/98/ME/NT/2000/XP/Vista/7/8), Linux, Mac OS X, AmigaOS 4.

### 2. Supported games

2.1. What games does ResidualVM support?
2.1. What games does ResidualVM support?

We have a compatibility list on our website that contains an up-to-date list of which games work, and how well they work.

### 3. Running games

3.1. How do I install games to run in ResidualVM?
3.1. How do I install games to run in ResidualVM?

For most games you do not need to run the installer. Simply copy the files listed here from your CD to your hard drive.

### 4. Troubleshooting

4.1. My game crashes at some point.
4.2. ResidualVM crashes, but the console window disappears too quickly to see the error message.
4.3. Reporting Bugs.
4.4. I get "WARNING: Unable to open configuration file C:\windows\residualvm.ini!"
4.5. I get "Failed to save game state to file: xxx"
4.6. ResidualVM starts, but all I get is a transparent window!
4.7. ResidualVM runs, but sound is stuttering and/or garbled!
4.8. ResidualVM runs in fullscreen mode, but graphics is stretched!
4.9. How do I set an environment variable?
4.10. ResidualVM starts somewhere in the middle of my two Xinerama monitors in fullscreen mode. Help!
4.1. My game crashes at some point.

Check the Compatibility List to see if your game has any known issues. If you can reproduce this crash more than once, please report issue. See "Reporting Bugs.".

4.2. ResidualVM crashes, but the console window disappears too quickly to see the error message.

On Windows, to make it visible, you should run ResidualVM from the command line. To open a command prompt, open the Start Menu and select the 'Run' option. Under Windows NT/2000/XP/Vista/7, type 'cmd.exe' (no quotes) in the dialog box that shows up; under Windows 95/98/Me, type 'command.com' instead. If necessary, change to the proper drive first by typing 'D:' (where 'D' is the drive ResidualVM is located). Change to ResidualVM's directory by typing 'cd \your\path\to\residualvm' (substituting the appropriate path) and then type 'residualvm'.

On MacOS X, you can find the error messages by starting Console.app (in Utilities within the Applications folder). If you prefer, you can also run ResidualVM from the terminal. To do this, start Terminal.app (also in the Utilities folder), then drag&drop the Resdual.app application onto the Terminal window, remove the space at the end of the line and add 'Contents/MacOS/residualvm' (without the quotes). The line should look like this: '/Path/to/ResidualVM.app/Contents/MacOS/residualvm'. Then press return to start ResidualVM.

4.3. Reporting Bugs.

To report a bug, please create a GitHub account and follow the Bug Reports link from our homepage. Please make sure the bug is reproducible, and still exists in the latest daily build/current Git version. In your bugreport please provide the following information:

• 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 from just before the bug happened
For further details regarding Bug Reports, please see our Wiki

4.4. I get "WARNING: Unable to open configuration file C:\windows\residualvm.ini!"

Make sure you have enough permissions to write in c:\windows directory. Also note that this warning the first time you run ResidualVM, since the file does not exist yet then.

4.5. I get "Failed to save game state to file: xxx"

Check savepath in Options->Paths->Save Path. That should point to writable directory.

4.6. ResidualVM starts, but all I get is a transparent window!

This problem has been reported to happen under Windows in some cases. Check that you have the latest drivers for your graphics card. If that does not help, try setting the SDL_VIDEODRIVER environment variable to "windib" and try again.

Apparently other applications have had the same problem, because the release notes for SDL 1.2.10 (May 17, 2006) contained the following note:

The "windib" video driver is the default now, to prevent problems with certain laptops, 64-bit Windows, and Windows Vista/7. The DirectX driver is still available, and can be selected by setting the environment variable SDL_VIDEODRIVER to "directx".

4.7. ResidualVM runs, but sound is stuttering and/or garbled!

This problem has been reported to happen under Windows in some cases. Check that you have the latest drivers for your sound card. If that does not help, try setting the SDL_AUDIODRIVER environment variable to "waveout" and try again.

Note using the "waveout" SDL audio driver causes an increased delay in sound, especially under Windows Vista and later versions.
4.8. ResidualVM runs in fullscreen mode, but graphics is stretched!

It's know issue, it will be fixed in future versions of ResidualVM.

4.9. How do I set an environment variable?

That depends on what operating system and/or command shell you are using. Under Windows, you could try creating a file called residualvm.bat in the same folder as residualvm.exe. Open this file in your favorite text editor and put something like this in it:

@echo off
set SDL_VIDEODRIVER=windib
set SDL_AUDIODRIVER=waveout
residualvm.exe %1 %2 %3 %4 %5 %6 %7 %8 %9

You should now be able to run ResidualVM by double-clicking on this batch file, instead of the ResidualVM executable.

On more recent versions of Windows, you can also set an environment variable permanently, and for all applications, through the control panel.

4.10. ResidualVM starts somewhere in the middle of my two Xinerama monitors in fullscreen mode. Help!

In fact, this is SDL problem. SDL does by default has xinerama support enabled. Set the SDL_VIDEO_FULLSCREEN_HEAD environment variable to "1" to start ResidualVM (and other SDL applications) in fullscreen on only one monitor. If this does not work make sure your SDL library does have Xinerama support compiled in.