Difference between revisions of "User Manual"

From ScummVM :: Wiki
Jump to navigation Jump to search
(Added 'work in progress' notice and some information on how to contribute)
(Remove link to deleted page)
 
(111 intermediate revisions by 15 users not shown)
Line 1: Line 1:
{| border="0" cellpadding="2" cellspacing="1" align="right" style="margin-left:1em; background:#CA1111; width:40%"
{{DISPLAYTITLE:[Deprecated] User Manual }}
| WORK IN PROGRESS, HELP NEEDED
{| border="0" cellpadding="1" cellspacing="2" style="margin-left:5em; background:#FF9999; width:80%"
|- border="0" cellpadding="2" cellspacing="1" align="center" style="margin-left:1em; background:#ffffff;"
|- align="center"
|'''Check out our new user documentation!'''
|- style="margin-left:1em; background:#ffffff;"
|- style="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).
|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__


{{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]
}}


= User's Guide =
{{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]]
}}


== Introduction ==
{{ManualSectionNoLink|name=Links|desc=
=== What is ScummVM ===
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.
ScummVM is a program which allows you to run certain classic graphical
* HOW-TOs:
point-and-click adventure games, provided you already have their data
** [https://forums.scummvm.org/viewtopic.php?t=8440 How to catch ScummVM errors <nowiki>[forum]</nowiki>]
files. The clever part about this: ScummVM just replaces the
** [https://forums.scummvm.org/viewtopic.php?t=8012 How to play multi-disc games with ScummVM <nowiki>[forum]</nowiki>]
executables shipped with the game, allowing you to play them on
** [https://forums.scummvm.org/viewtopic.php?t=6303 Enhanced ScummVM MIDI music on Windows <nowiki>[forum]</nowiki>]
systems for which they were never designed!
** [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>]]
Some of the adventures ScummVM supports include Adventure Soft's Simon
* Supported games:
the Sorcerer 1 and 2; Revolution's Beneath A Steel Sky, Broken Sword 1
** [https://www.scummvm.org/compatibility/{{StableVersion}}/ Compatibility table for the latest ScummVM release <nowiki>[website]</nowiki>]
and Broken Sword 2; Flight of the Amazon Queen; Wyrmkeep's Inherit the
** [https://www.scummvm.org/compatibility/ Compatibility table for the development version of ScummVM <nowiki>[website]</nowiki>]
Earth; Coktel Vision's Gobliiins; Westwood Studios' The Legend of
** [[Engines|List of games that are supported by ScummVM or for which there is a work in progress <nowiki>[wiki]</nowiki>]]
Kyrandia and games based on LucasArts' SCUMM (Script Creation Utility
}}
for Maniac Mansion) system such as Monkey Island, Day of the Tentacle,
Sam and Max and more. You can find a thorough list with details on
which games are supported and how well on the compatibility
page. ScummVM is continually improving, so check back often.
 
Among the systems on which you can play those games are Windows,
Linux, Mac OS X, Dreamcast, PocketPC, PalmOS, AmigaOS, BeOS, OS/2,
PSP, PS2, SymbianOS/EPOC and many more.
 
At this time ScummVM should be considered beta software, and is still
under heavy development. Be aware that whilst we attempt to make sure
that many games can be completed with few major bugs, crashes can happen.
 
If you enjoy ScummVM feel free to
[http://sourceforge.net/donate/index.php?group_id=37116 donate some money]
to help us. This will help us buy utilities needed to develop ScummVM
easier and quicker. If you cannot donate, help and contribute a patch!
 
=== Reporting bugs ===
To report a bug, please create a [http://sourceforge.net SourceForge account],
then use our [http://sourceforge.net/tracker/?group_id=37116&amp;atid=418820 bug tracker]
to file a report (you can also reach it via the "Bug Tracking" link from
[http://www.scummvm.org our homepage].
Please make sure the bug is reproducible, and still occurs in the latest
daily build/current CVS version. Also check the list of known bugs
(below) and 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 <emphasis>know</emphasis> those games have bugs.
 
Please include the following information:
 
*ScummVM version (PLEASE test the latest CVS/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 inofficial 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 compiler it yourself from source. We strongly recommend to beginners to use our prebuilt binaries.
==== Binaries ====
You can download ScummVM from our downloads page: [http://www.scummvm.org/downloads.php]. 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.
 
We always ship prebuilt binaries of ScummVM for the following platforms (note that it can sometimes take a few days 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: (with more detail than now); pointer to the to-be-written "Developer's Guide to ScummVM"
* 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.
=== Installion ===
After you have obtained ScummVM as described in the previous section, you probably will 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 ====
==== Fedora Core / Redhat ====
==== Slackware ====
==== 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) ====
==== 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 ====
==== Nintendo DS ====
==== 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 ====
==== GP32 ====
==== PlayStation 2 ====
==== PlayStation Portable ====
=== First steps ===
== Running and using ScummVM ==
=== The launcher ===
==== Managing your games (adding/removing a game) ====
==== Configuring a game ====
==== The (global) options dialog (this will point to the "Configuration" section) ====
=== Command line options ===
=== Hotkeys ===
=== Saving and loading ===
=== Macintosh games: Accesing HFS filesystems ===
=== Multi-CD games ===
== Configuration ==
=== Using the launcher to change the the options ===
=== All config file switches in detail ===
=== Graphic filters ===
=== Music and Sound ===
==== Music drivers ====
==== Using compressed audiofiles ====
==== Volumes settings ====
==== Output sample rate ====
== Appendix: Supported games ==
(well this already exists on the wiki, so just link to these pages, but also see the extra notes below)
== Appendix: Tools ==
(describe each ScummVM command line tool in detail. Game pages might link to this.)

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"