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.

Introduction

A description of what ScummVM is.

Quick Start

A short guide on how to use ScummVM.

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. Contacts, lists places where you can get help
3. Reporting bugs, to help us improve ScummVM

Appendix

Contains comprehensive technical information on various topics.

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

The list of games supported by the most recent stable version of ScummVM can be found on the Compatibility page, or the games supported by the current unstable version can be found on the SVN Compatibility page. The Engines page in the wiki also lists these things, along with the engines that are still work-in-progress.

Finally the Datafiles page is worth a look as it lists all the files needed for each game to play the game with ScummVM (i.e. the files you need to copy on your hard disk).