Difference between revisions of "User Manual"

Latest revision as of 19:03, 18 June 2023

Check out our new user documentation!

We have a user documentation portal at 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.

Getting Help

ReadMe file for version 2.8.1

Appendix

Control Mapping for supported devices
Graphic filters
Tools, a list of the tools available for use with ScummVM (e.g. for compressing audio), along with a description of their usage
Integrations

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 1: / Line 1: @@
-{{Edit-first-section}}__NOEDITSECTION__ __NOTOC__
+{{DISPLAYTITLE:[Deprecated] User Manual }}
-{{HelpWithManual}}
+{| border="0" cellpadding="1" cellspacing="2" style="margin-left:5em; background:#FF9999; width:80%"
-{{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}}
+|- align="center"
-{{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}}
+|'''Check out our new user documentation!'''
-{{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}}
+|- style="margin-left:1em; background:#ffffff;"
-{{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}}
+|- style="background:#ffffff"
-{{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].
+|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.
-The [[Engines|Engines page]] in the wiki also lists these things, along with the engines that are still work-in-progress.}}
+|}__NOEDITSECTION__ __NOTOC__
-{{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=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]
+}}
+{{ManualSectionNoLink|name=Appendix|desc=# [[User Manual/Appendix: Controls|Control Mapping for supported devices]]
+# [[User Manual/Appendix: Graphic filters|Graphic filters]]
+# [[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]]
+}}
+{{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>]]
+}}