Difference between revisions of "User Manual"

Revision as of 06:52, 27 September 2016

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.

What is ScummVM?

2. Quick Start

A short guide on how to use ScummVM.

3. ScummVM Interface

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

Using ScummVM

A detailed description on how to use ScummVM.

Installing ScummVM
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
Installing a game for use with ScummVM, covers multi-CD games, additional files like kyra.dat, and extracting/converting audio tracks
Adding a game to ScummVM
Configuring a game in ScummVM, describes how to adjust per-game settings
Playing a game with ScummVM
Removing a game from ScummVM
Uninstalling ScummVM

Getting Help

FAQ
ReadMe file for version 2.8.1
Contacts, lists places where you can get help
Reporting bugs, to help us improve ScummVM

Appendix

Contains comprehensive technical information on various topics.

Control Mapping for supported devices
Graphic filters
Render modes
Music and sound
Command line options a list and descriptions of all the command line options you can use with ScummVM
Config file description, describes the ScummVM configuration file
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.

@@ Line 2: / Line 2: @@
 {{HelpWithManual}}
-{{ManualSection|location=User Manual/Introduction|name=Introduction|desc=A description of what ScummVM is.}}
+{{ManualSection|location=User Manual/Introduction|name=1. Introduction|desc=A description of ScummVM.}}
+# [[User Manual/Introduction|What is ScummVM?]]
-{{ManualSection|location=User Manual/Quick Start|name=Quick Start|desc=A short guide on how to use ScummVM.}}
+{{ManualSection|location=User Manual/Quick Start|name=2. Quick Start|desc=A short guide on how to use ScummVM.}}
+# [[User Manual/Quick Start#2.1 Why should I use ScummVM?|Why should I use ScummVM?]]
+# [[User Manual/Quick Start#2.2 Installing ScummVM|Installing ScummVM]]
+# [[User Manual/Quick Start#2.3 Setting up a game|Setting up a game]]
+# [[User Manual/Quick Start#2.4 Adding a game to ScummVM|Adding a game to ScummVM]]
+# [[User Manual/Quick Start#2.5 Configuring a game|Configuring a game]]
+# [[User Manual/Quick Start#2.6 Starting a game in ScummVM|Starting a game in ScummVM]]
+# [[User Manual/Quick Start#2.7 Where to get help|Where to get help]]
-{{ManualSection|location=User Manual/ScummVM Interface|name=ScummVM Interface|desc=A description of the ScummVM interface, in case you ever wondered what a specific button does.
+{{ManualSection|location=User Manual/ScummVM Interface|name=3. ScummVM Interface|desc=A description of the ScummVM interface, in case you ever wondered what a specific button does.
 # [[User Manual/ScummVM Interface#The Launcher|The Launcher]]
 # [[User Manual/ScummVM Interface#Options|Options]]