|
|
(46 intermediate revisions by 11 users not shown) |
Line 1: |
Line 1: |
| {{Edit-first-section}} | | {{DISPLAYTITLE:[Deprecated] User Manual }} |
| | | {| border="0" cellpadding="1" cellspacing="2" style="margin-left:5em; background:#FF9999; width:80%" |
| {| border="0" cellpadding="2" cellspacing="1" align="left" style="margin:1em; background:#FF0000; width:40%" | |
| |- align="center" | | |- align="center" |
| | '''WORK IN PROGRESS, HELP NEEDED''' | | |'''Check out our new user documentation!''' |
| |- style="margin-left:1em; background:#ffffff;" | | |- 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__ |
| {{-}}
| |
| | |
| {| align="right"
| |
| | __TOC__
| |
| |}
| |
| | |
| | |
| = Introduction =
| |
| == What is ScummVM? ==
| |
| ScummVM is a program which allows you to run certain classic graphical
| |
| point-and-click adventure games, provided you already have their data
| |
| files. The clever part about this: ScummVM just replaces the
| |
| executables shipped with the game, allowing you to play them on
| |
| systems for which they were never designed!
| |
| | |
| Some of the adventures ScummVM supports include Adventure Soft's Simon
| |
| the Sorcerer 1 and 2; Revolution's Beneath A Steel Sky, Broken Sword 1
| |
| and Broken Sword 2; Flight of the Amazon Queen; Wyrmkeep's Inherit the
| |
| Earth; Coktel Vision's Gobliiins; Westwood Studios' The Legend of
| |
| 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&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 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.
| |
| | |
| {{ManualSection|location=User_Manual/Getting_started|name=Getting started|desc=What you need to be able to use ScummVM, where to get it from, and how to install it}}
| |
| | |
| {{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}} | | {{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] |
| | }} |
|
| |
|
| = Appendix: Supported games = | | {{ManualSectionNoLink|name=Appendix|desc=# [[User Manual/Appendix: Controls|Control Mapping for supported devices]] |
| 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].
| | # [[User Manual/Appendix: Graphic filters|Graphic filters]] |
| The [[Engines|Engines page]] in the wiki also lists these things, along with the engines that are still work-in-progress.
| | # [[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]] |
| | }} |
|
| |
|
| {{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}} | | {{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>]] |
| | }} |