Difference between revisions of "User Manual"

From ScummVM :: Wiki
Jump to navigation Jump to search
(Remove link to deleted page)
 
(26 intermediate revisions by 10 users not shown)
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%"
 
|- align="center"
{{ManualSection|location=User Manual/Introduction|name=Introduction|desc=A description of what ScummVM is.}}
|'''Check out our new user documentation!'''
 
|- style="margin-left:1em; background:#ffffff;"
{{ManualSection|location=User Manual/Quick Start|name=Quick Start|desc=A short guide on how to use ScummVM.}}
|- style="background:#ffffff"
 
|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.
{{ManualSection|location=User Manual/ScummVM Interface|name=ScummVM Interface|desc=A description of the ScummVM interface, in case you ever wondered what a specific button does.
|}__NOEDITSECTION__ __NOTOC__
# [[User Manual/ScummVM Interface#Main Window|Main Window]]
# [[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)]]
# [[User Manual/ScummVM Interface#In-game menu|In-game menu]]
}}
 
{{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=
{{ManualSectionNoLink|name=Getting Help|desc=
# [[User Manual/FAQ|FAQ]]
# [https://github.com/scummvm/scummvm/blob/v{{StableVersion}}/README.md ReadMe file for version {{StableVersion}}]
# [[User Manual/Contacts|Contacts]], lists places where you can get help
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/cz/PrectiMe Czech translation]
# [[User Manual/Reporting bugs|Reporting bugs]], to help us improve ScummVM
## [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]]
{{ManualSectionNoLink|name=Appendix|desc=Contains comprehensive technical information on various topics.
# [[User Manual/Appendix: Graphic filters|Graphic filters]]
# [[User Manual/Appendix: Graphic filters]]
# [[User Manual/Appendix: Render modes]]
# [[User Manual/Appendix: 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
# [[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
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={{StableVersion}} 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: Integrations|Integrations]]
The [[Engines|Engines page]] in the wiki also lists these things, along with the engines that are still work-in-progress.
}}


Finally the [[Datafiles]] page is worth a look as it lists all the files needed for each game to play the game with ScummVM (i.e. the files you need to copy on your hard disk).
{{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>]]
}}
}}

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

  1. ReadMe file for version 2.8.1
    1. Czech translation
    2. German translation
    3. Swedish translation
    4. Danish QuickStart translation
    5. French QuickStart translation
    6. Italian QuickStart translation
    7. Norwegian (bokmaal) QuickStart translation
    8. Spanish QuickStart translation

Appendix

  1. Control Mapping for supported devices
  2. Graphic filters
  3. Tools, a list of the tools available for use with ScummVM (e.g. for compressing audio), along with a description of their usage
  4. 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.

Retrieved from "https://wiki.scummvm.org/index.php?title=User_Manual&oldid=37687"