Difference between revisions of "User Manual"
Spookypeanut (talk | contribs) m (Update to most recent version (is there a "most recent version" url? will check...)) |
(Add link to Game Specific Instructions page) |
||
| Line 4: | Line 4: | ||
{{ManualSection|location=User_Manual/Getting_started|name=Getting started|desc=What you need to be able to use ScummVM, where to get it from, and how to install it}} | {{ManualSection|location=User_Manual/Getting_started|name=Getting started|desc=What you need to be able to use ScummVM, where to get it from, and how to install it}} | ||
{{ManualSection|location=User_Manual/Running_and_Using_ScummVM|name=Running and using ScummVM|desc=How to use ScummVM, including both graphical and command line usage}} | {{ManualSection|location=User_Manual/Running_and_Using_ScummVM|name=Running and using ScummVM|desc=How to use ScummVM, including both graphical and command line usage}} | ||
{{ManualSection|location=User Manual/Game Specific Instructions|name=Game Specific Instructions|desc=Instructions for installation and in-game hotkeys for some specific games.}} | |||
{{ManualSection|location=User_Manual/Configuration|name=Configuration|desc=Changing the options of ScummVM so that it runs games exactly the way you want it to}} | {{ManualSection|location=User_Manual/Configuration|name=Configuration|desc=Changing the options of ScummVM so that it runs games exactly the way you want it to}} | ||
{{ManualSectionNoLink|name=Appendix: Supported games|desc=The list of games supported by the most recent stable version of ScummVM can be found on the [http://www.scummvm.org/compatibility.php?version=0.13.0 Compatibility page], or the games supported by the current unstable version can be found on the [http://www.scummvm.org/compatibility.php SVN Compatibility page]. | {{ManualSectionNoLink|name=Appendix: Supported games|desc=The list of games supported by the most recent stable version of ScummVM can be found on the [http://www.scummvm.org/compatibility.php?version=0.13.0 Compatibility page], or the games supported by the current unstable version can be found on the [http://www.scummvm.org/compatibility.php SVN Compatibility page]. | ||
The [[Engines|Engines page]] in the wiki also lists these things, along with the engines that are still work-in-progress.}} | The [[Engines|Engines page]] in the wiki also lists these things, along with the engines that are still work-in-progress.}} | ||
{{ManualSection|name=Appendix: Tools|location=User_Manual/Appendix:_Tools|desc=A list of the tools available for use with ScummVM (e.g. for compressing audio), along with a description of their usage}} | {{ManualSection|name=Appendix: Tools|location=User_Manual/Appendix:_Tools|desc=A list of the tools available for use with ScummVM (e.g. for compressing audio), along with a description of their usage}} | ||
Revision as of 18:29, 7 March 2009
[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