Difference between revisions of "User Manual"

Revision as of 20:33, 31 October 2012

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.

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 27: / Line 27: @@
 {{ManualSectionNoLink|name=Getting Help|desc=
 # [[User Manual/FAQ|FAQ]]
-# [http://github.com/scummvm/scummvm/raw/v1.5.0/README ReadMe file for version 1.5.0]
+# [http://github.com/scummvm/scummvm/raw/v{{StableVersion}}/README ReadMe file for version {{StableVersion}}]
-## [https://github.com/scummvm/scummvm/blob/master/doc/cz/PrectiMe Czech translation]
+## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/cz/PrectiMe Czech translation]
-## [https://github.com/scummvm/scummvm/blob/master/doc/de/Liesmich German translation]
+## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/de/Liesmich German translation]
-## [https://github.com/scummvm/scummvm/blob/master/doc/da/HurtigStart Danish QuickStart translation]
+## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/da/HurtigStart Danish QuickStart translation]
-## [https://github.com/scummvm/scummvm/blob/master/doc/fr/DemarrageRapide French QuickStart translation]
+## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/fr/DemarrageRapide French QuickStart translation]
-## [https://github.com/scummvm/scummvm/blob/master/doc/it/GuidaRapida Italian QuickStart translation]
+## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/it/GuidaRapida Italian QuickStart translation]
-## [https://github.com/scummvm/scummvm/blob/master/doc/no-nb/HurtigStart Norwegian (bokmaal) QuickStart translation]
+## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/no-nb/HurtigStart Norwegian (bokmaal) QuickStart translation]
-## [https://github.com/scummvm/scummvm/blob/master/doc/es/InicioRapido Spanish QuickStart translation]
+## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/es/InicioRapido Spanish QuickStart translation]
 # [[User Manual/Contacts|Contacts]], lists places where you can get help
 # [[User Manual/Reporting bugs|Reporting bugs]], to help us improve ScummVM