Difference between revisions of "User Manual"

From ScummVM :: Wiki
Jump to navigation Jump to search
(Fix link to The Launcher description)
(Add a link section and reorganize some of the information)
Line 27: Line 27:
{{ManualSectionNoLink|name=Getting Help|desc=
{{ManualSectionNoLink|name=Getting Help|desc=
# [[User Manual/FAQ|FAQ]]
# [[User Manual/FAQ|FAQ]]
# [http://scummvm.svn.sourceforge.net/viewvc/scummvm/scummvm/tags/release-1-0-0/README?view=markup ReadMe file for version 1.0.0]
# [[User Manual/Contacts|Contacts]], lists places where you can get help
# [[User Manual/Contacts|Contacts]], lists places where you can get help
# [[User Manual/Reporting bugs|Reporting bugs]], to help us improve ScummVM
# [[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=Contains comprehensive technical information on various topics.
Line 39: Line 39:
# [[User Manual/Appendix: Config file description|Config file description]], describes the ScummVM configuration file
# [[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].
}}
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:
** [http://forums.scummvm.org/viewtopic.php?t=8440 How to catch ScummVM errors]
** [http://forums.scummvm.org/viewtopic.php?t=8012 How to play multi-disc games with ScummVM]
** [http://forums.scummvm.org/viewtopic.php?t=6303 Enhanced ScummVM MIDI music on Windows]
** [http://forums.scummvm.org/viewtopic.php?t=4639 Using Timidity with ScummVM on Windows XP]
** [[HOWTO-Mac_Games|How to extract/copy Mac Games to use with ScummVM]]
** [[HOWTO-LoomTG16|How to extract the Loom PC-Engine/TG16 data track to use with ScummVM]]
* Supported games:
** [[Datafiles|List of games data files needed by ScummVM to play each supported Game]]
** [http://www.scummvm.org/compatibility.php?version={{StableVersion}} Compatibility table for the latest ScummVM release].
** [http://www.scummvm.org/compatibility.php Compatibility table for the development version of ScummVM].
** [[Engines | List of games that are supported by ScummVM or for which there is a work in progress]]
** [http://scummvm-misc.sourceforge.net/ List of unsupported games for which a ScummVM engine exists (either incomplete or outside of ScummVM scope)]
}}
}}

Revision as of 22:41, 3 February 2010

[edit]

WORK IN PROGRESS, HELP NEEDED
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, supplying us with HTML or TeX sources is fine, too (we will then translate them for the Wiki).

You can have a look at our TODO page for a list of tasks that need to be done.

Introduction

A description of what ScummVM is.

Quick Start

A short guide on how to use ScummVM.

ScummVM Interface

A description of the ScummVM interface, in case you ever wondered what a specific button does.

  1. The Launcher
  2. Options
  3. Game settings
  4. Global Main Menu (GMM)
  5. In-game menu

Using ScummVM

A detailed description on how to use ScummVM.

  1. Installing ScummVM
  2. 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
  3. Installing a game for use with ScummVM, covers multi-CD games, additional files like kyra.dat, and extracting/converting audio tracks
  4. Adding a game to ScummVM
  5. Configuring a game in ScummVM, describes how to adjust per-game settings
  6. Playing a game with ScummVM
  7. Removing a game from ScummVM
  8. Uninstalling ScummVM

Getting Help

  1. FAQ
  2. ReadMe file for version 1.0.0
  3. Contacts, lists places where you can get help
  4. Reporting bugs, to help us improve ScummVM

Appendix

Contains comprehensive technical information on various topics.

  1. Graphic filters
  2. Render modes
  3. Music and sound
  4. Command line options a list and descriptions of all the command line options you can use with ScummVM
  5. Config file description, describes the ScummVM configuration file
  6. Tools, a list of the tools available for use with ScummVM (e.g. for compressing audio), along with a description of their usage

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=12961"