User Manual

[edit]

WORK IN PROGRESS, HELP NEEDED

If you want to contribute, send us a sample of text you'd write for the new manual, and we will consider adding you an account. You can work on the manual in the Wiki, but if you prefer, supplying us with HTML or TeX sources is fine, too (we will then translate them for the Wiki). You can have a look at our TODO page for a list of tasks that need to be done.

1. Introduction

A description of ScummVM.

1. What is ScummVM?

2. Quick Start

A short guide on how to use ScummVM.

1. Why should I use ScummVM?
2. Installing ScummVM
3. Setting up a game
4. Adding a game to ScummVM
5. Configuring a game
6. Starting a game in ScummVM
7. Where to get help

3. ScummVM Interface

A description of the ScummVM interface, in case you ever wondered what a specific button does.

1. The Launcher
2. Options
3. Game settings
4. Global Main Menu (GMM)
5. In-game menu

Using ScummVM

A detailed description on how to use ScummVM.

1. Installing ScummVM
2. Configuring ScummVM, describes the settings and command-line parameters that you can use so that it runs games exactly the way you want it to
3. Installing a game for use with ScummVM, covers multi-CD games, additional files like kyra.dat, and extracting/converting audio tracks
4. Adding a game to ScummVM
5. Configuring a game in ScummVM, describes how to adjust per-game settings
6. Playing a game with ScummVM
7. Removing a game from ScummVM
8. Uninstalling ScummVM

Getting Help

1. FAQ
2. ReadMe file for version 2.8.1
   1. Czech translation
   2. German translation
   3. Swedish translation
   4. Danish QuickStart translation
   5. French QuickStart translation
   6. Italian QuickStart translation
   7. Norwegian (bokmaal) QuickStart translation
   8. Spanish QuickStart translation
3. Contacts, lists places where you can get help
4. Reporting bugs, to help us improve ScummVM

Appendix

Contains comprehensive technical information on various topics.

1. Control Mapping for supported devices
2. Graphic filters
3. Render modes
4. Music and sound
5. Command line options a list and descriptions of all the command line options you can use with ScummVM
6. Config file description, describes the ScummVM configuration file
7. Tools, a list of the tools available for use with ScummVM (e.g. for compressing audio), along with a description of their usage

Links

You will find help on using ScummVM in other places on the web. Here are a few links to solve frequent issues or that my help you improve your experience with ScummVM.

• HOW-TOs:
  • How to catch ScummVM errors [forum]
  • How to play multi-disc games with ScummVM [forum]
  • Enhanced ScummVM MIDI music on Windows [forum]
  • Using Timidity with ScummVM on Windows XP [forum]
  • How to extract/copy Mac Games to use with ScummVM [wiki]
  • How to extract the Loom PC-Engine/TG16 data track to use with ScummVM [wiki]
• Supported games:
  • List of games data files needed by ScummVM to play each supported Game [wiki]
  • Compatibility table for the latest ScummVM release [website].
  • Compatibility table for the development version of ScummVM [website].
  • List of games that are supported by ScummVM or for which there is a work in progress [wiki]
  • List of unsupported games for which a ScummVM engine exists (either incomplete or outside of ScummVM scope) [external]