Difference between revisions of "User Manual"
m (Use the last stable version for the compatibility page link) |
(Add notice while I am moving pages and content around) |
||
| Line 1: | Line 1: | ||
{{Edit-first-section}}__NOEDITSECTION__ __NOTOC__ | <span style="color:red">'''The structure of the User Manual is being changed. Until it is completed some links might be temporarily dead and the content of the pages might seems strange. Hopefully the manual should be back to normal by Saturday August 1, 12:00 GMT'''</span>{{Edit-first-section}}__NOEDITSECTION__ __NOTOC__ | ||
{{HelpWithManual}} | {{HelpWithManual}} | ||
{{ManualSection|location=User_Manual/Introduction|name=Introduction|desc=A description of what ScummVM does, what to do if you find a bug, and how to contact the authors}} | {{ManualSection|location=User_Manual/Introduction|name=Introduction|desc=A description of what ScummVM does, what to do if you find a bug, and how to contact the authors}} | ||
Revision as of 09:32, 1 August 2009
The structure of the User Manual is being changed. Until it is completed some links might be temporarily dead and the content of the pages might seems strange. Hopefully the manual should be back to normal by Saturday August 1, 12:00 GMT[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 does, what to do if you find a bug, and how to contact the authors
Getting started
What you need to be able to use ScummVM, where to get it from, and how to install it
Running and using ScummVM
How to use ScummVM, including both graphical and command line usage
Game Specific Instructions
Instructions for installation and in-game hotkeys for some specific games.
Configuration
Changing the options of ScummVM so that it runs games exactly the way you want it to
Appendix: Supported games
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.
Appendix: Tools
A list of the tools available for use with ScummVM (e.g. for compressing audio), along with a description of their usage