Difference between revisions of "User Manual"

Jump to navigation Jump to search
4,429 bytes added ,  11:53, 4 October 2016
removing 3.5 as it's no longer used
m (Clean up new-lines)
(removing 3.5 as it's no longer used)
(27 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Edit-first-section}}__NOEDITSECTION__ __NOTOC__
{{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/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/Introduction|name=1. Introduction|desc=A description of ScummVM.}}
{{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}}
# [[User Manual/Introduction|What is ScummVM?]]
{{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_stable.php 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].  
{{ManualSection|location=User Manual/Quick Start|name=2. Quick Start|desc=A short guide on how to use ScummVM.}}
The [[Engines|Engines page]] in the wiki also lists these things, along with the engines that are still work-in-progress.}}
# [[User Manual/Quick Start#2.1 Why should I use ScummVM?|Why should I use ScummVM?]]
{{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}}
# [[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=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]]
# [[User Manual/ScummVM Interface#Game settings|Game settings]]
# [[User Manual/ScummVM Interface#Global Main Menu (GMM)|Global Main Menu (GMM)]]
}}
 
{{ManualSectionNoLink|name=Using ScummVM|desc=A detailed description on how to use ScummVM.
# [[User Manual/Installing ScummVM|Installing ScummVM]]
# [[User Manual/Configuring 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
# [[User Manual/Installing a game for use with ScummVM|Installing a game for use with ScummVM]], covers multi-CD games, additional files like kyra.dat, and extracting/converting audio tracks
# [[User Manual/Adding a game to ScummVM|Adding a game to ScummVM]]
# [[User Manual/Configuring a game in ScummVM|Configuring a game in ScummVM]], describes how to adjust per-game settings
# [[User Manual/Playing a game with ScummVM|Playing a game with ScummVM]]
# [[User Manual/Removing a game from ScummVM|Removing a game from ScummVM]]
# [[User Manual/Uninstalling ScummVM|Uninstalling ScummVM]]
}}
 
{{ManualSectionNoLink|name=Getting Help|desc=
# [[User Manual/FAQ|FAQ]]
# [http://github.com/scummvm/scummvm/raw/v{{StableVersion}}/README ReadMe file for version {{StableVersion}}]
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/cz/PrectiMe Czech translation]
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/de/Liesmich German translation]
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/se/LasMig Swedish translation]
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/da/HurtigStart Danish QuickStart translation]
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/fr/DemarrageRapide French QuickStart translation]
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/it/GuidaRapida Italian QuickStart translation]
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/no-nb/HurtigStart Norwegian (bokmaal) 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
}}
 
{{ManualSectionNoLink|name=Appendix|desc=Contains comprehensive technical information on various topics.
# [[User Manual/Appendix: Controls|Control Mapping for supported devices]]
# [[User Manual/Appendix: Graphic filters|Graphic filters]]
# [[User Manual/Appendix: Render modes|Render modes]]
# [[User Manual/Appendix: Music and sound|Music and sound]]
# [[User Manual/Appendix: Command line options|Command line options]] a list and descriptions of all the command line options you can use with ScummVM
# [[User Manual/Appendix: Config file description|Config file description]], describes the ScummVM configuration file
# [[User Manual/Appendix: Tools|Tools]], a list of the tools available for use with ScummVM (e.g. for compressing audio), along with a description of their usage
}}
 
{{ManualSectionNoLink|name=Links|desc=
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.
* HOW-TOs:
** [http://forums.scummvm.org/viewtopic.php?t=8440 How to catch ScummVM errors <nowiki>[forum]</nowiki>]
** [http://forums.scummvm.org/viewtopic.php?t=8012 How to play multi-disc games with ScummVM <nowiki>[forum]</nowiki>]
** [http://forums.scummvm.org/viewtopic.php?t=6303 Enhanced ScummVM MIDI music on Windows <nowiki>[forum]</nowiki>]
** [http://forums.scummvm.org/viewtopic.php?t=4639 Using Timidity with ScummVM on Windows XP <nowiki>[forum]</nowiki>]
** [[HOWTO-Mac_Games|How to extract/copy Mac Games to use with ScummVM <nowiki>[wiki]</nowiki>]]
** [[HOWTO-LoomTG16|How to extract the Loom PC-Engine/TG16 data track to use with ScummVM <nowiki>[wiki]</nowiki>]]
* Supported games:
** [[Datafiles|List of games data files needed by ScummVM to play each supported Game <nowiki>[wiki]</nowiki>]]
** [http://www.scummvm.org/compatibility.php?version={{StableVersion}} Compatibility table for the latest ScummVM release <nowiki>[website]</nowiki>].
** [http://www.scummvm.org/compatibility.php Compatibility table for the development version of ScummVM <nowiki>[website]</nowiki>].
** [[Engines | List of games that are supported by ScummVM or for which there is a work in progress <nowiki>[wiki]</nowiki>]]
** [http://scummvm-misc.sourceforge.net/ List of unsupported games for which a ScummVM engine exists (either incomplete or outside of ScummVM scope) <nowiki>[external]</nowiki>]
}}
8,012

edits

Navigation menu