Difference between revisions of "User Manual"

From ScummVM :: Wiki
Jump to navigation Jump to search
(Removes links to deleted pages. Adds a banner to direct users to new user docs. Changes page title to reflect deprecated status.)
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"
|'''Check out our new user documentation!'''
|- style="margin-left:1em; background:#ffffff;"
|- 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.
|}__NOEDITSECTION__ __NOTOC__{{ManualSection|location=User Manual/Introduction|name=1. Introduction|desc=A description of ScummVM.}}
#[[User Manual/Introduction|What is ScummVM?]]


{{ManualSection|location=User Manual/Introduction|name=1. Introduction|desc=A description of ScummVM.}}
{{ManualSectionNoLink|name=Using ScummVM|desc=# [[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/Introduction|What is ScummVM?]]
 
{{ManualSection|location=User Manual/Quick Start|name=2. Quick Start|desc=A short guide on how to use ScummVM.}}
# [[User Manual/Quick Start#2.1 Installing ScummVM|Installing ScummVM]]
# [[User Manual/Quick Start#2.2 Setting up a game|Setting up a game]]
# [[User Manual/Quick Start#2.3 Adding a game to ScummVM|Adding a game to ScummVM]]
# [[User Manual/Quick Start#2.4 Configuring a game|Configuring a game]]
# [[User Manual/Quick Start#2.5 Starting a game in ScummVM|Starting a game in ScummVM]]
# [[User Manual/Quick Start#2.6 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/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/Playing a game with ScummVM|Playing a game with ScummVM]]
# [[User Manual/Removing a game from ScummVM|Removing a game from ScummVM]]
# [[User Manual/Using Cloud and LAN features|Using Cloud and LAN features]]
# [[User Manual/Using Cloud and LAN features|Using Cloud and LAN features]]
# [[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}}]
# [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/cz/PrectiMe Czech translation]
Line 43: Line 25:
## [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/no-nb/HurtigStart Norwegian (bokmaal) QuickStart translation]
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/es/InicioRapido Spanish 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.
{{ManualSectionNoLink|name=Appendix|desc=# [[User Manual/Appendix: Controls|Control Mapping for supported devices]]
# [[User Manual/Appendix: Controls|Control Mapping for supported devices]]
# [[User Manual/Appendix: Graphic filters|Graphic filters]]
# [[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: 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
# [[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]]
# [[User Manual/Appendix: Integrations|Integrations]]

Revision as of 04:02, 16 January 2021

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.

==1. Introduction==

A description of ScummVM.

  1. What is ScummVM?

Using ScummVM

  1. Installing a game for use with ScummVM, covers multi-CD games, additional files like kyra.dat, and extracting/converting audio tracks
  2. Configuring a game in ScummVM, describes how to adjust per-game settings
  3. Playing a game with ScummVM
  4. Using Cloud and LAN features

Getting Help

  1. ReadMe file for version 2.2.0
    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. Music and sound
  4. Tools, a list of the tools available for use with ScummVM (e.g. for compressing audio), along with a description of their usage
  5. 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.