Difference between revisions of "User Manual"

From ScummVM :: Wiki
Jump to navigation Jump to search
(→‎Running and using ScummVM: Split section out to User_Manual/Running_and_Using_ScummVM)
(removing 3.5 as it's no longer used)
(34 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Edit-first-section}}  
{{Edit-first-section}}__NOEDITSECTION__ __NOTOC__
{{HelpWithManual}}


{| border="0" cellpadding="2" cellspacing="1" align="left" style="margin:1em; background:#FF0000; width:40%"
{{ManualSection|location=User Manual/Introduction|name=1. Introduction|desc=A description of ScummVM.}}
|- align="center"
# [[User Manual/Introduction|What is ScummVM?]]
| '''WORK IN PROGRESS, HELP NEEDED'''
|- style="margin-left:1em; 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).
|}
{{-}}


{| align="right"
{{ManualSection|location=User Manual/Quick Start|name=2. Quick Start|desc=A short guide on how to use ScummVM.}}
  | __TOC__
# [[User Manual/Quick Start#2.1 Why should I use ScummVM?|Why should I use ScummVM?]]
  |}
# [[User Manual/Quick Start#2.2 Installing ScummVM|Installing ScummVM]]
# [[User Manual/Quick Start#2.3 Setting up a game|Setting up a game]]
# [[User Manual/Quick Start#2.4 Adding a game to ScummVM|Adding a game to ScummVM]]
# [[User Manual/Quick Start#2.5 Configuring a game|Configuring a game]]
# [[User Manual/Quick Start#2.6 Starting a game in ScummVM|Starting a game in ScummVM]]
# [[User Manual/Quick Start#2.7 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)]]
}}


= Introduction =
{{ManualSectionNoLink|name=Using ScummVM|desc=A detailed description on how to use ScummVM.
== What is ScummVM? ==
# [[User Manual/Installing ScummVM|Installing ScummVM]]
ScummVM is a program which allows you to run certain classic graphical
# [[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
point-and-click adventure games, provided you already have their data
# [[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
files. The clever part about this: ScummVM just replaces the
# [[User Manual/Adding a game to ScummVM|Adding a game to ScummVM]]
executables shipped with the game, allowing you to play them on
# [[User Manual/Configuring a game in ScummVM|Configuring a game in ScummVM]], describes how to adjust per-game settings
systems for which they were never designed!
# [[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]]
}}


Some of the adventures ScummVM supports include Adventure Soft's Simon
{{ManualSectionNoLink|name=Getting Help|desc=
the Sorcerer 1 and 2; Revolution's Beneath A Steel Sky, Broken Sword 1
# [[User Manual/FAQ|FAQ]]
and Broken Sword 2; Flight of the Amazon Queen; Wyrmkeep's Inherit the
# [http://github.com/scummvm/scummvm/raw/v{{StableVersion}}/README ReadMe file for version {{StableVersion}}]
Earth; Coktel Vision's Gobliiins; Westwood Studios' The Legend of
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/cz/PrectiMe Czech translation]
Kyrandia and games based on LucasArts' SCUMM (Script Creation Utility
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/de/Liesmich German translation]
for Maniac Mansion) system such as Monkey Island, Day of the Tentacle,
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/se/LasMig Swedish translation]
Sam and Max and more. You can find a thorough list with details on
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/da/HurtigStart Danish QuickStart translation]
which games are supported and how well on the compatibility
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/fr/DemarrageRapide French QuickStart translation]
page. ScummVM is continually improving, so check back often.
## [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]
# [[User Manual/Contacts|Contacts]], lists places where you can get help
# [[User Manual/Reporting bugs|Reporting bugs]], to help us improve ScummVM
}}


Among the systems on which you can play those games are Windows,
{{ManualSectionNoLink|name=Appendix|desc=Contains comprehensive technical information on various topics.
Linux, Mac OS X, Dreamcast, PocketPC, PalmOS, AmigaOS, BeOS, OS/2,
# [[User Manual/Appendix: Controls|Control Mapping for supported devices]]
PSP, PS2, SymbianOS/EPOC and many more.
# [[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: 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
}}


At this time ScummVM should be considered beta software, and is still
{{ManualSectionNoLink|name=Links|desc=
under heavy development. Be aware that whilst we attempt to make sure
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.
that many games can be completed with few major bugs, crashes can happen.
* HOW-TOs:
 
** [http://forums.scummvm.org/viewtopic.php?t=8440 How to catch ScummVM errors <nowiki>[forum]</nowiki>]
If you enjoy ScummVM feel free to
** [http://forums.scummvm.org/viewtopic.php?t=8012 How to play multi-disc games with ScummVM <nowiki>[forum]</nowiki>]
[http://sourceforge.net/donate/index.php?group_id=37116 donate some money]
** [http://forums.scummvm.org/viewtopic.php?t=6303 Enhanced ScummVM MIDI music on Windows <nowiki>[forum]</nowiki>]
to help us. This will help us buy utilities needed to develop ScummVM
** [http://forums.scummvm.org/viewtopic.php?t=4639 Using Timidity with ScummVM on Windows XP <nowiki>[forum]</nowiki>]
easier and quicker. If you cannot donate, help and contribute a patch!
** [[HOWTO-Mac_Games|How to extract/copy Mac Games to use with ScummVM <nowiki>[wiki]</nowiki>]]
 
** [[HOWTO-LoomTG16|How to extract the Loom PC-Engine/TG16 data track to use with ScummVM <nowiki>[wiki]</nowiki>]]
== Reporting bugs ==
* Supported games:
To report a bug, please create a [http://sourceforge.net SourceForge account],
** [[Datafiles|List of games data files needed by ScummVM to play each supported Game <nowiki>[wiki]</nowiki>]]
then use our [http://sourceforge.net/tracker/?group_id=37116&amp;atid=418820 bug tracker]
** [http://www.scummvm.org/compatibility.php?version={{StableVersion}} Compatibility table for the latest ScummVM release <nowiki>[website]</nowiki>].
to file a report (you can also reach it via the "Bug Tracking" link from
** [http://www.scummvm.org/compatibility.php Compatibility table for the development version of ScummVM <nowiki>[website]</nowiki>].
[http://www.scummvm.org our homepage].
** [[Engines | List of games that are supported by ScummVM or for which there is a work in progress <nowiki>[wiki]</nowiki>]]
Please make sure the bug is reproducible, and still occurs in the latest
** [http://scummvm-misc.sourceforge.net/ List of unsupported games for which a ScummVM engine exists (either incomplete or outside of ScummVM scope) <nowiki>[external]</nowiki>]
daily build/current SVN version. Also check the bug doesn't already exist on the bug tracker, and have a look at the [http://www.scummvm.org/compatibility.php compatibility list on our website]
}}
for that game, to ensure the issue is not already known.
 
Also, please do not report bugs on games that are not listed as being completable in [[#Appendix: Supported games | Appendix: Supported games]], or in the online [http://www.scummvm.org/compatibility.php compatibility list].
We already '''''know''''' those games have bugs.
 
Please include the following information:
 
*ScummVM version (PLEASE test the latest SVN/Daily build)
*Bug details, including instructions on reproducing
*Language of game (English, German, ...)
*Version of game (talkie, floppy, ...)
*Platform and Compiler (Win32, Linux, FreeBSD, ...)
*Attach a save game if possible
*If this bug only occurred recently, please note the last version without the bug, and the first version including
the bug. That way we can fix it quicker by looking at the changes made.
 
This should only take you a little time but will make it much easier for us to process your bug report in a way that satisfies both you and us.
 
== Contacting the developers ==
The easiest way to contact the ScummVM team is by submitting bug reports (see reporting-bugs) or by using our
[http://forums.scummvm.org forums]. You can also join and email the scummvm-devel mailing list (see
[http://lists.sourceforge.net/lists/listinfo/scummvm-devel]). Or chat with us on IRC (channel #scummvm on irc.freenode.net).
 
Please do not ask us to support an unsupported game -- read
[http://www.scummvm.org/faq.php our FAQ] for an explanation.
 
= Getting started =
 
== Requirements ==
TODO: List Requirements (in terms of required/optional libraries, CPU power, memory, ... In particular it would be nice if we could e.g. say what PalmOS devices support ScummVM; not necessarily a list of all supported Palm models, but more a list of what OS you need how much memory, colors, etc.)
 
ScummVM is known to run on the following systems:
*Unix-like (Linux, *BSD, Solaris, etc.)
*Windows
*Mac OS X
*Windows Mobile (WinCE / PocketPC / Smartphone)
*PalmOS
*Dreamcast
*MorphOS
*GP32
*GP2X
*Symbian based smartphones
*PlayStation 2
*PlayStation Portable
*Nintendo DS
*BeOS
*AmigaOS 4
*Atari/FreeMiNT
*Solaris
*OS/2
*Opie
 
Besides these, there have been many more unofficial ports in the past. Since they were not done by us, we can not say anything about their reliability, legality, or availability, nor can we provide support for them. Use them at your own risk!
 
Among those officially unsupported systems are:
 
*XBox
*RISC OS
 
If you plan to compile ScummVM yourself, you will need certain additional libraries. More on that in [[#Compiling from sources | Compiling from sources]].
 
== How to obtain ScummVM ==
Basically you have two choices on how to get ScummVM: either you download one of the binaries we built for you (probably the most convenient way); or you can compile it yourself from source. For beginners, we strongly recommend using our prebuilt binaries.
 
=== Binaries ===
You can download official binaries of ScummVM from our [http://www.scummvm.org/downloads.php downloads page]. Go there with your favorite web browser and download the binary for your platform. If none is available, you may have to build ScummVM yourself, refer to the next section for instructions on how to do that. Alternatively, some third parties are providing unofficial ScummVM binaries for further platforms, but naturally, we can not make any statements about the quality of such unofficial builds - use them at your own risk!
 
We always ship pre-built binaries of ScummVM for the following platforms (note that it can take some time after a release for all binaries to be available):
*Linux (Fedora Core)
*Linux (Debian)
*Windows
*Mac OS X
*Windows Mobile (WinCE / PocketPC / Smartphone)
*Symbian
*Dreamcast
*PlayStation 2
*PlayStation Portable
*Nintendo DS
*GP2X
 
In addition to these, we try to provide more binaries, but which depends mostly on how many volunteers we can find to help us out. In the past we have shipped binaries for these systems:
*Linux (Mandrake)
*Linux (Slackware)
*Solaris
*BeOS
*AmigaOS 4
*MorphOS
*OS/2
 
=== Compiling from sources ===
TODO:
* Point to the [[Compiling ScummVM]] page, resp. integrate that here.
* List all required libs; where to get them; how to install them
* List all optional libs etc.
* We could separate this by OS, or by compiler/dev system. I think the current split in the README (section 9.0) isn't too bad.
 
 
== Installation ==
After you have obtained ScummVM as described in the previous section, you will probably want to install it on your system. The steps required for that differ between the various operating systems. In the following we try to cover all the systems we officially support.
 
=== Debian ===
From the downloads page, download the Debian .deb package. To install it, you need to be root and type ''dpkg -i packagename.deb'' into a virtual terminal near you.
 
=== Fedora Core / Redhat ===
TODO
 
=== Slackware ===
TODO
 
=== Amiga OS4 ===
From the downloads page, get the AmigaOS4 package. You will download a packed archive (.lha). To open it, double click on it and UnArc will unpack right away or ask for the installation path. Once it is unpacked, you can move the whole drawer where ever you wish to store it.
 
=== Windows ===
From the downloads page, download either the Win32 .zip file or the Win32 .exe file. If you download the .zip file, you will need a program such as WinZip to open it. After opening the archive, copy it to the folder where you want to put it. If you download the .exe installer, you will get options where you want to install it. Choose the location to where you want to install it. Also, the installer places a shortcut in the Start Menu.
 
=== Mac OS X ===
From the downloads page, download the "Mac OS X Universal Binary" file. You will download a disk image (.dmg). To open it, double click on it and Disk Copy will mount the image. Once it is mounted, copy the files inside to a folder where you wish to store it.
 
=== Windows Mobile (WinCE / PocketPC / Smartphone) ===
Create a folder on your device to put ScummVM into, e.g. "\My Device\SD-MMcard\ScummVM". From the downloads page, download the "Windows CE ARM package" zip file. Extract everything from this file, and place it all in the folder that you created on your device (using ActiveSync or similar: note that if your chosen location is short of space, the only absolutely ''required'' file is "scummvm.exe"). To run ScummVM just tap on "scummvm.exe" in File Explorer: you may wish to copy a shortcut of "scummvm.exe" to your Start Menu to allow for easier access.
 
=== PalmOS ===
From the downloads page, download the "PalmOS 5 binary" or the "PalmOS Tapwave Zodiac binary" and unzip the files to your computer. Using your hotsync tool, install the scummvm-frontend.prc and skin.pdb files to your device. Launch ScummVM to create the /PALM/Programs/ScummVM/ folders and subfolders on your memory card. Using a card reader, copy the engines you require to play your games to the /ScummVM/Mods/ folder on your card (scumm.engine for scumm games, queen.engine for FOTAQ, etc.)
 
=== Symbian / EPOC ===
TODO
 
=== Nintendo DS ===
TODO
 
=== Dreamcast ===
From the downloads page, download either the Dreamcast .zip file or the Nero image file. If you download the .zip file, you will need a program such as WinZip to open it. After opening the archive, copy it to the folder where you want to put it. The Nero image can be burned automatically to a CD using Nero Burning ROM or any other program that accepts NRG formatted disc images.
 
=== GP2X ===
TODO
 
=== GP32 ===
TODO
 
=== PlayStation 2 ===
TODO
 
=== PlayStation Portable ===
TODO
 
== First steps ==
 
{{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}}
 
= Appendix: Supported games =
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].  
The [[Engines|Engines page]] in the wiki also lists these things, along with the engines that are still work-in-progress.
 
{{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}}

Revision as of 11:53, 4 October 2016

[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.

1. Introduction

A description of ScummVM.

  1. What is ScummVM?

2. Quick Start

A short guide on how to use ScummVM.

  1. Why should I use ScummVM?
  2. Installing ScummVM
  3. Setting up a game
  4. Adding a game to ScummVM
  5. Configuring a game
  6. Starting a game in ScummVM
  7. Where to get help

3. 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)

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 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
  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. Control Mapping for supported devices
  2. Graphic filters
  3. Render modes
  4. Music and sound
  5. Command line options a list and descriptions of all the command line options you can use with ScummVM
  6. Config file description, describes the ScummVM configuration file
  7. 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=23396"