Difference between revisions of "User Manual"

From ScummVM :: Wiki
Jump to navigation Jump to search
(→‎Graphic filters: Add section, revamped from README)
(Remove link to deleted page)
 
(80 intermediate revisions by 15 users not shown)
Line 1: Line 1:
=== Graphic filters ===
{{DISPLAYTITLE:[Deprecated] User Manual }}
{| 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__


ScummVM offers several anti-aliasing filters to attempt to improve visual
{{ManualSectionNoLink|name=Getting Help|desc=
quality. These filters take the original game graphics, and scale it by a
# [https://github.com/scummvm/scummvm/blob/v{{StableVersion}}/README.md ReadMe file for version {{StableVersion}}]
certain fixed factor (usually 2x or 3x) before displaying them to you.
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/cz/PrectiMe Czech translation]
So for example, if the game originally ran at a resolution of 320x200
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/de/LIESMICH German translation]
(typical for most of the SCUMM games), then using a filter with a scale
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/se/LasMig Swedish translation]
factor of 2x will effectively yield 640x400 graphics. Likewise a
## [https://github.com/scummvm/scummvm/raw/v{{StableVersion}}/doc/da/HurtigStart Danish QuickStart translation]
3x filter will give 960x600.
## [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]
}}


ScummVM uses the following graphic filters:
{{ManualSectionNoLink|name=Appendix|desc=# [[User Manual/Appendix: Controls|Control Mapping for supported devices]]
{|class="wikitable"
# [[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
! Name
# [[User Manual/Appendix: Integrations|Integrations]]
! Factor
}}
! Description
|-
| 1x
| 1x
| No filtering, no scaling, fastest
|-
| 2x
| 2x
| No filtering, simple pixel duplication (default for non 640x480 games)
|-
| 3x
| 3x
| No filtering, simple pixel duplication
|-
| 2xsai
| 2x
| SAI filter
|-
| super2xsai
| 2x
| Enhanced 2xSAI filtering
|-
| supereagle
| 2x
| Less blurry than 2xSAI, but slower
|-
| advmame2x
| 2x
| Doesn't rely on blurring like 2xSAI, fast
|-
| advmame3x
| 3x
| Doesn't rely on blurring like 2xSAI, fast
|-
| hq2x
| 2x
| Very nice high quality filter but slow
|-
| hq3x
| 3x
| Very nice high quality filter but slow
|-
| tv2x
| 2x
| Interlace filter, tries to emulate a TV
|-
| dotmatrix
| 2x
| Dot matrix effect
|}


To select a graphics filter from the command line, use the '-g' [[Command_line_options|command line option]], e.g.:
{{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.
<pre>scummvm -gadvmame2x monkey2</pre>
* HOW-TOs:
 
** [https://forums.scummvm.org/viewtopic.php?t=8440 How to catch ScummVM errors <nowiki>[forum]</nowiki>]
There is always a speed impact when using any form of anti-aliasing/linear filtering. Filters can be especially slow when ScummVM is compiled in a debug
** [https://forums.scummvm.org/viewtopic.php?t=8012 How to play multi-disc games with ScummVM <nowiki>[forum]</nowiki>]
configuration without optimizations. For these reasons, not all backends support all (or even any) of the filters listed above;
** [https://forums.scummvm.org/viewtopic.php?t=6303 Enhanced ScummVM MIDI music on Windows <nowiki>[forum]</nowiki>]
some may support additional ones. The filters listed above are those supported by the default SDL backend.
** [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>]]
NB: The final resolution depends on the original resolution of the game you are playing. For example, the FM-TOWNS version of Zak McKracken uses an original resolution of 320x240, hence for this game the final resolution with a scaler will be 640x480 (2x) or 960x720 (3x).
* Supported games:
Likewise, games that were originally 640x480 (such as Curse of Monkey Island or the Broken Sword games) will be scaled to 1280x960 (2x) and 1920x1440 (3x).
** [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>]]
}}

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"