Open main menu

Difference between revisions of "User Manual"

1,172 bytes added ,  19:03, 18 June 2023
Remove link to deleted page
(→‎Introduction: Split out to User_Manual/Introduction)
(Remove link to deleted page)
 
(45 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{Edit-first-section}}  
{{DISPLAYTITLE:[Deprecated] User Manual }}
 
{| border="0" cellpadding="1" cellspacing="2" style="margin-left:5em; background:#FF9999; width:80%"
{| border="0" cellpadding="2" cellspacing="1" align="left" style="margin:1em; background:#FF0000; width:40%"
|- align="center"
|- align="center"
| '''WORK IN PROGRESS, HELP NEEDED'''
|'''Check out our new user documentation!'''
|- style="margin-left:1em; background:#ffffff;"
|- style="margin-left:1em; background:#ffffff;"
|- style="background:#ffffff"
|- style="background:#ffffff"
|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, working on the [http://scummvm.svn.sourceforge.net/viewvc/scummvm/docs/trunk/docbook/ DocBook version] or supplying us with HTML or TeX sources is fine, too (we will then translate them for the Wiki and into DocBook).
|We have a user documentation portal at [https://docs.scummvm.org docs.scummvm.org]. It covers all aspects of using ScummVM, including how to install ScummVM on a variety of platforms, how to add and play games, and how to tweak settings for optimal game play.
|}
|}__NOEDITSECTION__ __NOTOC__
{{-}}
 
{| align="right"
  | __TOC__
  |}
 
 
{{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/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/Configuration|name=Configuration|desc=Changing the options of ScummVM so that it runs games exactly the way you want it to}}
{{ManualSectionNoLink|name=Getting Help|desc=
# [https://github.com/scummvm/scummvm/blob/v{{StableVersion}}/README.md 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]
}}


= Appendix: Supported games =
{{ManualSectionNoLink|name=Appendix|desc=# [[User Manual/Appendix: Controls|Control Mapping for supported devices]]
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].
# [[User Manual/Appendix: Graphic filters|Graphic filters]]
The [[Engines|Engines page]] in the wiki also lists these things, along with the engines that are still work-in-progress.
# [[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
# [[User Manual/Appendix: Integrations|Integrations]]
}}


{{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}}
{{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:
** [https://forums.scummvm.org/viewtopic.php?t=8440 How to catch ScummVM errors <nowiki>[forum]</nowiki>]
** [https://forums.scummvm.org/viewtopic.php?t=8012 How to play multi-disc games with ScummVM <nowiki>[forum]</nowiki>]
** [https://forums.scummvm.org/viewtopic.php?t=6303 Enhanced ScummVM MIDI music on Windows <nowiki>[forum]</nowiki>]
** [https://forums.scummvm.org/viewtopic.php?t=4639 Using Timidity with ScummVM on Windows XP <nowiki>[forum]</nowiki>]
** [[HOWTO-LoomTG16|How to extract the Loom PC-Engine/TG16 data track to use with ScummVM <nowiki>[wiki]</nowiki>]]
* Supported games:
** [https://www.scummvm.org/compatibility/{{StableVersion}}/ Compatibility table for the latest ScummVM release <nowiki>[website]</nowiki>]
** [https://www.scummvm.org/compatibility/ 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>]]
}}
84

edits