Initial commit
This commit is contained in:
156
doc/QuickStart
Normal file
156
doc/QuickStart
Normal file
@@ -0,0 +1,156 @@
|
||||
This document is a partial translation of the English README file. The
|
||||
original document has much more information, so if you cannot find what
|
||||
you need here and can understand a bit of English, try to look at the
|
||||
English README file.
|
||||
|
||||
For more information, compatibility lists, details on donating, the
|
||||
latest release, progress reports and more, please visit the ScummVM home
|
||||
page at: https://www.scummvm.org/
|
||||
|
||||
Table of Contents:
|
||||
------------------
|
||||
1.0) Introduction
|
||||
* 1.1 About ScummVM
|
||||
* 1.2 Quick start
|
||||
2.0) Contact
|
||||
* 2.1 Reporting Bugs
|
||||
|
||||
1.0) Introduction:
|
||||
---- -------------
|
||||
|
||||
1.1) About 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!
|
||||
|
||||
Originally it was designed to run LucasArts' SCUMM games, such as Maniac
|
||||
Mansion, Monkey Island, Day of the Tentacle or Sam and Max. SCUMM stands
|
||||
for "Script Creation Utility for Maniac Mansion", which was the first
|
||||
game for which LucasArts designed this system. And much later it gave
|
||||
its name to ScummVM ('VM' meaning Virtual Machine).
|
||||
|
||||
Over time support for a lot of non-SCUMM games has been added, and
|
||||
ScummVM now also supports many of Sierra's AGI and SCI games (such as
|
||||
King's Quest 1-7, Space Quest 1-6, ...), Discworld 1 and 2, Simon the
|
||||
Sorcerer 1 and 2, Beneath A Steel Sky, Lure of the Temptress, Broken
|
||||
Sword I and II, Flight of the Amazon Queen, Gobliiins 1-3, The Legend of
|
||||
Kyrandia series, many of Humongous Entertainment's children's SCUMM
|
||||
games (including Freddi Fish and Putt Putt games) and many more. You can
|
||||
find a full list with details on which adventures 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 regular desktop
|
||||
computers (running Windows, Linux, macOS, ...), game consoles
|
||||
(Dreamcast, Nintendo DS & Wii, PSP, ...), smartphones (Android, iPhone,
|
||||
...) and more.
|
||||
|
||||
At this time ScummVM 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 and we offer no warranty. That being
|
||||
said, some of the games have been supported for a long time and should
|
||||
work fine with any recent stable release. You can get a feeling of how
|
||||
well each game is working in ScummVM by looking at the compatibility
|
||||
page. Actually, if you browse a bit around you might discover that
|
||||
ScummVM is even being used commercially to re-release some of the
|
||||
supported games on modern platforms. This shows that several companies
|
||||
are happy with the quality of the software and how well it can run some
|
||||
of the games.
|
||||
|
||||
If you enjoy ScummVM feel free to donate using the PayPal button on the
|
||||
ScummVM homepage. This will help us buy utilities needed to develop
|
||||
ScummVM easier and quicker. If you cannot donate, help and contribute a
|
||||
patch!
|
||||
|
||||
1.2) Quick start:
|
||||
---- ------------
|
||||
IMPORTANT: This short guide assumes you are using ScummVM in <translated
|
||||
language>. By default, ScummVM will use your operating system's
|
||||
language. If you prefer to use ScummVM in English, You may also prefer
|
||||
to follow the guide from the English README file.
|
||||
|
||||
For the impatient among you, here is how to get ScummVM running in five
|
||||
simple steps.
|
||||
|
||||
1. Download ScummVM from <https://www.scummvm.org/downloads/> and
|
||||
install it.
|
||||
|
||||
2. Create a directory on your hard drive and copy the game datafiles
|
||||
from the original media to this directory. Repeat this for every
|
||||
game you want to play (it is better to use a separate directory for
|
||||
each game).
|
||||
|
||||
3. Start ScummVM.
|
||||
|
||||
If at this stage ScummVM appears in English instead of <translated
|
||||
language>, do as follow to change the language:
|
||||
- Click on "Options".
|
||||
- Click on the right arrow in the tab bar and select the "GUI"
|
||||
tab.
|
||||
- Select "<translated language>" in the "GUI Language" box and
|
||||
click on "OK".
|
||||
|
||||
Now choose 'Add game', select the directory with the game datafiles
|
||||
(do not try to select the datafiles themselves!) and press
|
||||
"Choose".
|
||||
|
||||
4. A dialog should pop up allowing you to configure various settings if
|
||||
you wish to (it should be just fine to leave everything at its
|
||||
default, though). Confirm the dialog.
|
||||
|
||||
5. Select the game you want to play in the list, and press "Start".
|
||||
|
||||
In the future, you should be able to directly skip to step 5, unless you
|
||||
want to add more games.
|
||||
|
||||
Hint: If you want to add multiple games in one go, try pressing and
|
||||
holding the shift key before clicking 'Add game' -- its label will
|
||||
change to 'Mass Add' and if you press it, you are again asked to select
|
||||
a directory, only this time ScummVM will search through all
|
||||
subdirectories for supported games.
|
||||
|
||||
|
||||
2.0) Contact:
|
||||
---- --------
|
||||
The easiest way to contact the ScummVM team is by submitting bug reports
|
||||
(see section 2.1) or by using our forums at https://forums.scummvm.org .
|
||||
You can also join and e-mail the scummvm-devel mailing list, or chat
|
||||
with us on IRC (#scummvm on irc.libera.chat) Please do not ask us to
|
||||
support an unsupported game -- read the FAQ on our web site first. Note
|
||||
that the official language of the forum, mailing list and chat is
|
||||
English and no other languages should be used.
|
||||
|
||||
|
||||
2.1) Reporting Bugs:
|
||||
---- ---------------
|
||||
To report a bug, please follow the "Bug Tracker" link from our homepage
|
||||
and log in with your GitHub account. Please make sure the bug is
|
||||
reproducible, and still occurs in the latest git/Daily build version.
|
||||
Also check the known problems list (below) and the compatibility list on
|
||||
our website for that game, to ensure the issue is not already known:
|
||||
|
||||
https://www.scummvm.org/compatibility/
|
||||
|
||||
Please do not report bugs for games that are not listed as being
|
||||
completable in the 'Supported Games' section, or compatibility list. We
|
||||
-know- those games have bugs.
|
||||
|
||||
Please include the following information:
|
||||
|
||||
- ScummVM version (PLEASE test the latest git/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 saved 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.
|
||||
|
||||
Finally, please report each issue separately; do not file multiple
|
||||
issues on the same ticket. (Otherwise, it gets difficult to track the
|
||||
status of each individual bug). Please keep also in mind that all the
|
||||
bug reports must be written in English.
|
||||
2129
doc/cz/PrectiMe
Normal file
2129
doc/cz/PrectiMe
Normal file
File diff suppressed because it is too large
Load Diff
151
doc/da/HurtigStart
Normal file
151
doc/da/HurtigStart
Normal file
@@ -0,0 +1,151 @@
|
||||
Dette dokument er en delvis oversættelse af den engelske README filen.
|
||||
Det originale dokument har meget mere information, så hvis du ikke kan
|
||||
finde det du har brug for her og kan forstå en smule engelsk, så prøv
|
||||
at se i den Engelske README-fil.
|
||||
|
||||
For mere information, kompatibilitet lister, detaljer om donering, den
|
||||
seneste udgivelse, statusrapporter og mere, kan du besøge ScummVMs hjemme-
|
||||
side på: https://www.scummvm.org/
|
||||
|
||||
Indholdsfortegnelse:
|
||||
--------------------
|
||||
1.0) Indledning
|
||||
* 1.1 Om ScummVM
|
||||
* 1.2 Hurtig start
|
||||
2.0) Kontakt
|
||||
* 2.1 Rapportering af fejl
|
||||
|
||||
1.0) Indledning:
|
||||
---- -----------
|
||||
|
||||
1.1) Om ScummVM:
|
||||
---- -----------
|
||||
ScummVM er et program, som tillader dig at køre visse klassiske grafiske
|
||||
peg-og-klik eventyr spil, hvis du allerede har deres data filer. Den
|
||||
smarte del omkring dette: ScummVM erstatter bare de eksekverbare filer
|
||||
der fulgte med i spillet, så du kan afspille dem på systemer, hvor de
|
||||
aldrig var designet til!
|
||||
|
||||
Oprindeligt var det designet til at køre LucasArts' SCUMM spil, såsom
|
||||
Maniac Mansion, Monkey Island, Day of the Tentacle eller Sam and Max.
|
||||
SCUMM står for 'Script Creation Utility for Maniac Mansion', som var det
|
||||
første spil som LucasArts designede dette system til. Og langt senere gav
|
||||
navn til ScummVM ('VM', betyder Virtuel Maskine).
|
||||
|
||||
Efterhånden er understøttelse for en masse ikke-SCUMM spil blevet tilføjet,
|
||||
og ScummVM understøtter nu også mange af Sierras AGI og SCI-spil (såsom
|
||||
Kings Quest 1-6, Space Quest 1-5, ...), Discworld 1 og 2, Simon the Sorcerer
|
||||
1 og 2, Beneath A Steel Sky, Lure of the Temptress, Broken Sword I og II,
|
||||
Flight of the Amazon Queen, Gobliiins 1-3, The Legend of Kyrandia serien,
|
||||
mange af Humongous Entertainments børne SCUMM spil (herunder Freddi Fish
|
||||
and Putt Putt spil) og mange flere. Du kan finde en komplet liste med
|
||||
oplysninger om, hvilke eventyr der understøttes og hvor godt, på
|
||||
kompatibilitetssiden. ScummVM forbedres løbende, så vend ofte tilbage.
|
||||
|
||||
Blandt de systemer, som du kan spille disse spil på er regulære desktop
|
||||
computere (Windows, Linux, macOS, ...), spillekonsoller (Dreamcast,
|
||||
Nintendo DS og Wii, PSP, ...), smartphones (Android, iPhone, Symbian...)
|
||||
og flere.
|
||||
|
||||
På dette tidspunkt er ScummVM stadig under kraftig udvikling. Vær opmærksom
|
||||
på, at selvom vi forsøger at sørge for, at mange spil kan gennemføres med få
|
||||
store fejl, kan nedbrud ske, og vi tilbyder ingen garanti. Når det er sagt,
|
||||
er nogle af spillene blevet understøttet i lang tid og bør fungerer fint
|
||||
med alle nyere stabile udgaver. Du kan få en fornemmelse af, hvor godt
|
||||
hvert spil virker i ScummVM, ved at kigge på kompatibilitetssiden. Faktisk,
|
||||
hvis du søger lidt rundt, vil du måske opdage, at ScummVM endog anvendes
|
||||
kommercielt til genudgivelse af nogle af understøttede spil på moderne
|
||||
platforme. Dette viser, at flere virksomheder er tilfredse med kvaliteten
|
||||
af programmet, og hvor godt det kan køre nogle af spillene.
|
||||
|
||||
Hvis du har fornøjelse af ScummVM, er du velkommen til at donere ved hjælp
|
||||
af PayPal-knappen på ScummVM's hjemmeside. Dette vil hjælpe os med at købe
|
||||
værktøjer nødvendige for at udvikle ScummVM nemmere og hurtigere. Hvis du
|
||||
ikke kan donere, hjælp og bidrage med en programrettelse!
|
||||
|
||||
1.2) Hurtig start:
|
||||
---- ------------
|
||||
VIGTIGT: Denne korte vejledning antager, at du bruger ScummVM på dansk.
|
||||
Som standard vil ScummVM bruge dit operativsystem sprog. Hvis du
|
||||
foretrækker at bruge ScummVM på engelsk, kan du også foretrække at
|
||||
følge vejledning fra den engelske README fil.
|
||||
|
||||
For de utålmodige blandt jer, er her hvordan du får ScummVM op at køre
|
||||
i fem enkle trin.
|
||||
|
||||
1. Hent ScummVM fra <https://www.scummvm.org/downloads/> og
|
||||
installere det.
|
||||
|
||||
2. Opret en mappe på din harddisk og kopiere spillets datafiler fra de
|
||||
oprindelige medier til denne mappe. Gentag dette for hvert spil du
|
||||
ønsker at spille (det er bedre at bruge en separat mappe til hvert spil).
|
||||
|
||||
3. Start ScummVM.
|
||||
|
||||
Hvis ScummVM på dette tidspunkt vises på engelsk i stedet for dansk, gør
|
||||
som følger for at ændre sprog:
|
||||
- Klik på 'Options'.
|
||||
- Klik på højre pil i fanebjælken og vælg 'Misc' fanen.
|
||||
- Vælg "Dansk" i "GUI Language'og klik på 'OK'.
|
||||
- Bekræft meddelelsen boksen, der popper op, klik på 'Quit' for at
|
||||
afslutte ScummVM og derefter genstarte programmet.
|
||||
|
||||
Vælg nu 'Tilføj spil', vælge mappen med spillets datafiler (forsøg ikke
|
||||
at vælge datafilerne selv!) Og tryk på 'Vælg'
|
||||
|
||||
4. En dialog skulle komme op, hvor du kan konfigurere forskellige
|
||||
indstillinger, hvis du ønsker det (det burde dog være fint at lade alt
|
||||
forblive på sin standard). Bekræft dialogen.
|
||||
|
||||
5. Vælg det spil, du ønsker at spille på listen, og tryk på 'Start'.
|
||||
|
||||
ScummVM husker de spil, du tilføjer. Så hvis du lukker ScummVM, vil
|
||||
listen over spil næste gang du starter den, indeholde alle de spil du
|
||||
tidligere har tilføjet. Du kan derfor gå direkte til trin 5, medmindre
|
||||
du ønsker at tilføje flere spil.
|
||||
|
||||
Tip: Hvis du ønsker at tilføje flere spil på én gang, så prøv at trykke
|
||||
og holde shift-tasten nede før du klikker på 'Tilføj spil' - teksten vil
|
||||
skifte til 'Tilføj flere', og hvis du trykker på den, bliver du igen bedt
|
||||
om at vælge en mappe, men denne gang vil ScummVM søge gennem alle
|
||||
undermapper for understøttede spil.
|
||||
|
||||
2.0) Kontakt:
|
||||
---- --------
|
||||
Den nemmeste måde at kontakte ScummVM holdet på er ved at sende fejlrapporter
|
||||
(se afsnit 2.1) eller ved at bruge vores fora på https://forums.scummvm.org.
|
||||
Du kan også deltage og e-maile til scummvm-devel postlisten, eller chatte
|
||||
med os på IRC (#scummvm på irc.libera.chat). Bed os venligst ikke om at
|
||||
understøtte et ikke-understøttet spil -- læs FAQ på vores hjemmeside først.
|
||||
Bemærk, at det officielle sprog i dette forum, mailing liste og chat er
|
||||
engelsk og ingen andre sprog bør anvendes.
|
||||
|
||||
2.1) Rapportering af fejl:
|
||||
---- ---------------------
|
||||
For at rapportere en fejl, skal du oprette en SourceForge konto, og følge
|
||||
"Bug Tracker" linket fra vores hjemmeside. Sørg for at fejlen er reproducerbare,
|
||||
og stadig forekommer i den seneste git/Daglig byggede version.
|
||||
Kontroller også listen med kendte problemer (nedenfor) og kompatibilitetslisten
|
||||
på vores hjemmeside for spillet, for at sikre, at problemet ikke allerede er kendt:
|
||||
|
||||
https://www.scummvm.org/compatibility/
|
||||
|
||||
Vær venlig ikke at rapportere fejl på spil, der ikke er anført som værende
|
||||
mulige at gennemføre i 'understøttede spil' sektionen, eller kompatibilitetslisten.
|
||||
Vi -ved- disse spil har fejl.
|
||||
|
||||
Inkluder venligst følgende oplysninger:
|
||||
- ScummVM version (VENLIGST test på den nyeste git/Daglig byggede)
|
||||
- Detaljer om fejlen, herunder oplysninger om genskabelsen af fejlen
|
||||
- Sprog i spillet (engelsk, tysk, ...)
|
||||
- Version af spillet (talkie, diskette, ...)
|
||||
- Platform og Kompiler (Win32, Linux, FreeBSD, ...)
|
||||
- Medsend et gemt spil hvis det er muligt
|
||||
- Hvis fejlen kun skete for nylig, notér venligst den sidste version
|
||||
uden fejl, og den første version med fejlen. På denne måde kan vi
|
||||
ordne det hurtigere ved at kigge på de foretagne ændringer.
|
||||
|
||||
Endelig, bedes du rapportere hvert problem separat; indsend ikke flere
|
||||
problemer på samme billet. (Ellers bliver det svært at spore status for
|
||||
hver enkelt fejl). Husk også på, at alle fejlrapporter skal skrives på
|
||||
engelsk.
|
||||
3179
doc/de/LIESMICH
Normal file
3179
doc/de/LIESMICH
Normal file
File diff suppressed because it is too large
Load Diff
4688
doc/de/NEUES.md
Normal file
4688
doc/de/NEUES.md
Normal file
File diff suppressed because it is too large
Load Diff
176
doc/de/Schnellstart
Normal file
176
doc/de/Schnellstart
Normal file
@@ -0,0 +1,176 @@
|
||||
Dieses Dokument ist eine auszugsweise Übersetzung der englischen README-Datei.
|
||||
Das Original-Dokument enthält viel mehr Informationen. Sollten Sie hier also
|
||||
nicht das finden, was Sie benötigen und ein wenig Englisch können, sollten Sie
|
||||
sich die englische README-Datei ansehen.
|
||||
|
||||
Für weitere Informationen, Kompatibilitätslisten, Einzelheiten zu Spenden, die
|
||||
neusten veröffentlichten Versionen, Fortschrittsberichte und mehr besuchen Sie
|
||||
bitte die ScummVM-Website unter der Adresse: https://www.scummvm.org/
|
||||
|
||||
|
||||
Inhaltsverzeichnis:
|
||||
------------------
|
||||
1.0) Einführung
|
||||
* 1.1 Über ScummVM
|
||||
* 1.2 Schnellstart
|
||||
2.0) Kontakt
|
||||
* 2.1 Fehler berichten
|
||||
|
||||
|
||||
1.0) Einführung:
|
||||
---- -------------
|
||||
|
||||
1.1) Über ScummVM:
|
||||
---- -------------
|
||||
ScummVM ist ein Programm, welches es Ihnen ermöglicht, bestimmte klassische
|
||||
Grafik-Adventure (unter anderem aus dem Point-and-Click-Bereich) zu spielen,
|
||||
vorausgesetzt, Sie sind im Besitz der Dateien des Spiels. Der Trick dabei ist:
|
||||
ScummVM ersetzt lediglich die Funktion der ausführbaren Dateien, die mit den
|
||||
Spielen kamen, was ermöglicht, diese Spiele auf Systemen zu spielen, für welche
|
||||
sie nie erstellt wurden!
|
||||
|
||||
Ursprünglich wurde dieses Programm dafür entwickelt, um SCUMM-Spiele von
|
||||
LucasArts auszuführen, wie beispielsweise Maniac Mansion, Monkey Island, Day of
|
||||
the Tentacle oder Sam & Max. SCUMM steht als Abkürzung für „Script Creation
|
||||
Utility for Maniac Mansion“ (deutsch etwa: Skripterstellungsdienstprogramm für
|
||||
Maniac Mansion), was das erste Spiel von LucasArts war, für welches LucasArts
|
||||
dieses System entworfen hatte. Und viel später verlieh es seinen Namen an
|
||||
ScummVM (wobei „VM“ für „Virtuelle Maschine“ steht).
|
||||
|
||||
Mit der Zeit wurde Unterstützung für viele Nicht-SCUMM-Spiele hinzugefügt und
|
||||
ScummVM unterstützt nun auch viele AGI- und SCI-Spiele von Sierra (wie
|
||||
beispielsweise King's Quest 1-6, Space Quest 1-5, ...), Discworld 1 und 2, Simon
|
||||
the Sorcerer 1 und 2, Beneath A Steel Sky, Lure of the Temptress, Baphomets
|
||||
Fluch I und II, Flight of the Amazon Queen, Gobliiins 1-3, die Adventure-Reihe
|
||||
The Legend of Kyrandia, viele der SCUMM-Spiele für Kinder von Humongous
|
||||
Entertainment (einschließlich der Spiele von Fritzi Fisch und Töff-Töff) und
|
||||
viele mehr. Sie können eine vollständige Liste mit Einzelheiten einsehen, welche
|
||||
Auskunft darüber gibt, welche Spiele unterstützt werden und wie gut. Gehen Sie
|
||||
hierfür auf die Kompatibilitätsseite. ScummVM wird fortlaufend verbessert, also
|
||||
schauen Sie öfter einmal vorbei.
|
||||
|
||||
Unter den Systemen, mit denen Sie diese Spiele spielen können, befinden sich
|
||||
normale Schreibtisch-Computer (mit den Betriebssystemen Windows, Linux,
|
||||
macOS, ...), Spielekonsolen (Dreamcast, Nintendo DS & Wii, PSP, ...),
|
||||
Smartphones (Android, iPhone, Symbian ...) und einige weitere.
|
||||
|
||||
Zurzeit befindet sich ScummVM immer noch stark in der Entwicklung. Seien Sie
|
||||
sich bewusst, dass wir zwar versuchen, dass viele Spiele mit wenigen erheblichen
|
||||
Fehlern durchgespielt werden können, aber es dennoch zu Abstürzen kommen kann
|
||||
und wir keine Gewähr übernehmen. Davon abgesehen: Einige Spiele werden seit
|
||||
längerer Zeit unterstützt und sollten in jeder neusten stabilen veröffentlichten
|
||||
Version ohne größere Probleme laufen. Sie können sich einen Eindruck davon
|
||||
verschaffen, wie gut jedes Spiel unter ScummVM läuft, indem Sie auf die
|
||||
Kompatibilitätsseite schauen. Wenn Sie sich ein wenig im Internet umsehen,
|
||||
können Sie feststellen, dass ScummVM sogar kommerziell genutzt wird, um einige
|
||||
der unterstützen Spiele für moderne Plattformen wiederzuveröffentlichen. Dies
|
||||
zeigt, dass mehrere Firmen mit der Qualität der Software zufrieden sind und wie
|
||||
gut einige der Spiele mit Hilfe des Programms laufen.
|
||||
|
||||
Wenn Ihnen ScummVM gefällt, können Sie uns gerne Geld spenden, indem Sie auf die
|
||||
PayPal-Schaltfläche auf der ScummVM-Website klicken. Dies hilft uns dabei,
|
||||
notwendige Dienstprogramme zu kaufen, um ScummVM einfacher und schneller zu
|
||||
entwickeln. Wenn Sie nicht spenden können, dürfen Sie auch gerne einen Patch
|
||||
beisteuern.
|
||||
|
||||
1.2) Schnellstart:
|
||||
---- -------------
|
||||
WICHTIG: In dieser kurzen Anleitung wird davon ausgegangen, dass Sie ScummVM auf
|
||||
Deutsch benutzen. Standardmäßig wird ScummVM die Sprache Ihres Betriebssystems
|
||||
verwenden. Wenn Sie ScummVM lieber auf Englisch verwenden möchten, benutzen Sie
|
||||
bitte die Anleitung in der englischen README-Datei.
|
||||
|
||||
Für die ungeduldigen unter den Anwendern ist hier in fünf einfachen Schritten
|
||||
kurz beschrieben, wie man ScummVM lauffähig macht und das Programm verwendet.
|
||||
|
||||
1. Laden Sie ScummVM unter der Adresse https://www.scummvm.org/downloads/
|
||||
herunter und installieren Sie es.
|
||||
|
||||
2. Erstellen Sie ein Verzeichnis auf Ihrer Festplatte und kopieren Sie die
|
||||
Dateien des Spiels vom Original-Datenträger in dieses Verzeichnis. Wiederholen
|
||||
Sie diesen Vorgang für jedes Spiel, das Sie spielen möchten (es ist besser, für
|
||||
jedes Spiel ein eigenes Verzeichnis zu verwenden).
|
||||
|
||||
3. Starten Sie ScummVM.
|
||||
|
||||
Sollte an diesem Punkt ScummVM auf Englisch statt auf Deutsch erscheinen, gehen
|
||||
Sie wie folgt vor, um die Spracheinstellung zu ändern:
|
||||
-Klicken Sie auf „Options“.
|
||||
-Klicken Sie auf den rechten Pfeil in der Reiterleiste und wählen den Reiter
|
||||
„Misc“ aus.
|
||||
-Wählen Sie im Feld „GUI Language“ „Deutsch“ aus und klicken auf „OK“.
|
||||
-Bestätigen Sie die erscheinende Nachricht, klicken auf „Quit“, um ScummVM zu
|
||||
beenden, und starten dann das Programm erneut.
|
||||
|
||||
Nun klicken Sie auf „Spiel hinzufügen“, wählen das Verzeichnis mit den Dateien
|
||||
des Spiels aus (versuchen Sie nicht, die Dateien des Spiels selbst auszuwählen!)
|
||||
und klicken Sie auf „Auswählen“.
|
||||
|
||||
4. Ein Dialog sollte erscheinen, der Ihnen ermöglicht, verschiedene
|
||||
Einstellungen vorzunehmen, sollten Sie dies wünschen (es sollte jedoch in
|
||||
Ordnung sein, alles voreingestellt zu belassen). Bestätigen Sie diesen Dialog.
|
||||
|
||||
5. Wählen Sie das Spiel aus der Liste aus, welches Sie spielen möchten, und
|
||||
klicken Sie auf „Starten“.
|
||||
|
||||
ScummVM behält die Spiele in der Liste, die Sie hinzufügen. Wenn Sie also
|
||||
ScummVM schließen, werden beim nächsten Start alle Spiele, die Sie zuvor
|
||||
hinzugefügt haben, in der Liste angezeigt. Sie können somit direkt zu Schritt 5
|
||||
übergehen, außer Sie wollen noch mehr Spiele hinzufügen.
|
||||
|
||||
Tipp: Wenn Sie mehrere Spiele auf einmal hinzufügen möchten, drücken Sie die
|
||||
Umschalt-Taste (Shift), bevor Sie auf „Spiel hinzufügen“ klicken. Diese
|
||||
Schaltfläche wird somit ihren Text zu „Durchsuchen“ umändern und wenn Sie dann
|
||||
auf diese klicken, werden Sie auch dazu aufgefordert, ein Verzeichnis
|
||||
auszuwählen, nur dieses Mal wird ScummVM alle Unterverzeichnisse automatisch
|
||||
nach unterstützen Spielen durchsuchen.
|
||||
|
||||
|
||||
2.0) Kontakt:
|
||||
---- --------
|
||||
Der einfachste Weg, um mit dem ScummVM-Team in Verbindung zu treten, ist,
|
||||
Fehlerberichte einzusenden (siehe Abschnitt 2.1) oder durch Verwendung des
|
||||
Forums unter der Adresse https://forums.scummvm.org .
|
||||
Sie können ebenso der Mailing-Liste scummvm-devel beitreten und an diese E-Mails
|
||||
versenden oder mit uns im IRC chatten (#scummvm unter irc.libera.chat). Bitte
|
||||
fordern Sie uns nicht dazu auf, ein nicht unterstütztes Spiel zu unterstützen.
|
||||
Lesen Sie zuerst die Seite FAQ (Häufig gestellte Fragen) auf unserer Website.
|
||||
Bitte beachten Sie, dass die offizielle Sprache des Forums, der Mailing-Liste
|
||||
und des Chats Englisch ist und keine andere Sprache dort verwendet werden
|
||||
sollte.
|
||||
|
||||
|
||||
2.1) Fehler berichten:
|
||||
---- -----------------
|
||||
Um einen Fehler zu berichten, erstellen Sie bitte ein SourceForge-Konto und
|
||||
folgen Sie dem Link „Bug Tracker“ auf der ScummVM-Website. Bitte stellen Sie
|
||||
sicher, dass sich der Bug wiedererzeugen lässt und immer noch in der neusten
|
||||
Version von git oder des Daily Builds auftritt. Bitte sehen Sie auch auf der
|
||||
Kompatibilitätsliste der ScummVM-Website für dieses Spiel nach, um
|
||||
sicherzustellen, dass das Problem nicht bereits bekannt ist:
|
||||
|
||||
https://www.scummvm.org/compatibility/
|
||||
|
||||
Bitte berichten Sie keine Fehler zu Spielen, die nicht als durchspielbar im
|
||||
Bereich „Supported Games“ oder der Kompatibilitätsliste aufgelistet sind.
|
||||
Wir -wissen-, dass diese Spiele Fehler aufweisen.
|
||||
|
||||
Bitte liefern Sie folgende Informationen:
|
||||
- ScummVM-Version (BITTE mit neuster Version von git oder des Daily Builds
|
||||
testen)
|
||||
- Einzelheiten zum Fehler, einschließlich Anweisungen, um den Fehler
|
||||
hervorzurufen
|
||||
- Sprache des Spiels (Deutsch, Englisch ...)
|
||||
- Version des Spiels (Version mit Sprachausgabe [Talkie],
|
||||
Diskettenversion, ...)
|
||||
- Plattform und gegebenenfalls Compiler (Win32, Linux, FreeBSD, ...)
|
||||
- Fügen Sie - wenn möglich - einen Speicherstand hinzu.
|
||||
- Wenn dieser Fehler erst seit kurzem Auftritt, teilen Sie bitte die letzte
|
||||
Version ohne den Fehler mit und die erste Version mit diesem Fehler.
|
||||
Auf diese Weise können wir diesen schneller beseitigen, indem wir die
|
||||
vorgenommen Veränderungen einsehen.
|
||||
|
||||
Zum Schluss möchten wir Sie noch bitten, jeden Punkt einzeln zu berichten. Bitte
|
||||
senden Sie nicht mehrere Punkte mit demselben Ticket ein, ansonsten wird es
|
||||
schwierig, den Status jedes einzelnen Fehlers zu verfolgen. Denken Sie bitte
|
||||
auch daran, dass alle Fehlerberichte in Englisch verfasst sein müssen.
|
||||
20
doc/docportal/Makefile
Normal file
20
doc/docportal/Makefile
Normal file
@@ -0,0 +1,20 @@
|
||||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line, and also
|
||||
# from the environment for the first two.
|
||||
SPHINXOPTS ?=
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
SOURCEDIR = .
|
||||
BUILDDIR = _build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
150
doc/docportal/_static/custom.css
Normal file
150
doc/docportal/_static/custom.css
Normal file
@@ -0,0 +1,150 @@
|
||||
/* word wrapping */
|
||||
|
||||
.std,
|
||||
.std-ref,
|
||||
.head {
|
||||
word-wrap: break-word;
|
||||
}
|
||||
|
||||
p {
|
||||
word-wrap: break-word;
|
||||
white-space: normal;
|
||||
}
|
||||
|
||||
/* changes table to block element when screen size is small*/
|
||||
|
||||
@media screen and (min-width: 770px) and (max-width: 900px),
|
||||
screen and (min-width: 200px) and (max-width: 600px) {
|
||||
table,
|
||||
thead,
|
||||
tbody,
|
||||
th,
|
||||
td,
|
||||
tr {
|
||||
display: block;
|
||||
}
|
||||
|
||||
thead tr {
|
||||
position: absolute;
|
||||
top: -9999px;
|
||||
left: -9999px;
|
||||
}
|
||||
table.config td, table.command td, table.touch td, table.controls td {
|
||||
border: none;
|
||||
position: relative;
|
||||
padding-left: 40% !important;
|
||||
|
||||
}
|
||||
td:before {
|
||||
position: absolute;
|
||||
top: 6px;
|
||||
left: 6px;
|
||||
width: 35%;
|
||||
padding-right: 10px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
table.config td:nth-of-type(1):before {
|
||||
content: "Key";
|
||||
}
|
||||
table.config td:nth-of-type(2):before {
|
||||
content: "Type";
|
||||
}
|
||||
table.config td:nth-of-type(3):before {
|
||||
content: "Default";
|
||||
}
|
||||
table.config td:nth-of-type(4):before {
|
||||
content: "Description/ Options";
|
||||
white-space: normal;
|
||||
}
|
||||
|
||||
|
||||
table.command td:nth-of-type(1):before {
|
||||
content: "Option";
|
||||
}
|
||||
table.command td:nth-of-type(2):before {
|
||||
content: "Short";
|
||||
}
|
||||
table.command td:nth-of-type(3):before {
|
||||
content: "Description";
|
||||
}
|
||||
|
||||
table.controls td:nth-of-type(1):before {
|
||||
content: "Control";
|
||||
}
|
||||
table.controls td:nth-of-type(2):before {
|
||||
content: "Action";
|
||||
}
|
||||
|
||||
table.touch td:nth-of-type(1):before {
|
||||
content: "Touch";
|
||||
}
|
||||
table.touch td:nth-of-type(2):before {
|
||||
content: "Action";
|
||||
}
|
||||
/* Hides empty table cells*/
|
||||
td:empty {
|
||||
display: none;
|
||||
}
|
||||
/* Makes Description/Options field in config file table min height of 3rem*/
|
||||
|
||||
table.config td:nth-of-type(4) {
|
||||
min-height: 3rem;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
/* Overrides table width */
|
||||
@media (min-width: 385px) {
|
||||
.wy-table-responsive table td {
|
||||
white-space: normal !important;
|
||||
}
|
||||
|
||||
.wy-table-responsive {
|
||||
overflow: visible !important;
|
||||
}
|
||||
.wy-table-responsive table {
|
||||
table-layout: fixed !important;
|
||||
width: 100% !important;
|
||||
}
|
||||
}
|
||||
|
||||
/* Change theme colors*/
|
||||
|
||||
.wy-side-nav-search,
|
||||
.wy-nav-top {
|
||||
background-color: #cc6600 !important;
|
||||
}
|
||||
|
||||
.caption-text,
|
||||
.icon-home {
|
||||
color: #cc6600;
|
||||
}
|
||||
|
||||
/* Change H4 header size*/
|
||||
|
||||
h4 {
|
||||
font-size: 100% !important;
|
||||
}
|
||||
|
||||
/* Change inline code formatting*/
|
||||
|
||||
.rst-content code.literal {
|
||||
padding: 5px !important;
|
||||
white-space: normal;
|
||||
color: #000000;
|
||||
}
|
||||
|
||||
/* Change color of tabs and cards */
|
||||
|
||||
body {
|
||||
--sd-color-tabs-underline-active: #cc6600;
|
||||
--sd-color-tabs-label-active: #cc6600;
|
||||
--sd-color-tabs-label-inactive: #fd962e;
|
||||
--sd-color-tabs-label-hover: #cc6600;
|
||||
--sd-color-tabs-underline-hover: #ffd3a8;
|
||||
--sd-color-tabs-overline: #ffd3a8;
|
||||
--sd-color-tabs-underline: #ffd3a8;
|
||||
--sd-color-card-header: rgba(0,0,0,0.03);
|
||||
}
|
||||
19
doc/docportal/_static/version.js
Normal file
19
doc/docportal/_static/version.js
Normal file
@@ -0,0 +1,19 @@
|
||||
window.addEventListener("load", function(){
|
||||
|
||||
var url = window.location.href;
|
||||
var start = url.indexOf("/", 27);
|
||||
var end = url.indexOf("/", start+1);
|
||||
var endMinus = url.indexOf("-", start+1);
|
||||
var versionNumber = url.substring(start+1, endMinus);
|
||||
var found = url.substring(start+1, end);
|
||||
var version = null;
|
||||
|
||||
switch(found) {
|
||||
case 'latest':
|
||||
version = "development build"
|
||||
break;
|
||||
default:
|
||||
version = versionNumber
|
||||
break;
|
||||
}
|
||||
});
|
||||
65
doc/docportal/advanced_topics/autostart.rst
Normal file
65
doc/docportal/advanced_topics/autostart.rst
Normal file
@@ -0,0 +1,65 @@
|
||||
=========================
|
||||
Autostart
|
||||
=========================
|
||||
|
||||
Use the autostart feature to automatically start or add games. The available features and the way they work depend on the system on which ScummVM is running.
|
||||
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: General
|
||||
|
||||
On most systems, such as Windows and Linux, ScummVM can detect and start a game located in the same folder as the ScummVM executable, as long as it is a game supported by ScummVM. It is the equivalent of using the ``--path`` and ``--auto-detect`` :doc:`command line options <../advanced_topics/command_line>`. This also works on macOS when ScummVM is built as a command line application and not as a .app bundle.
|
||||
|
||||
There are two ways to use the autostart feature:
|
||||
|
||||
- Rename the executable file to ``scummvm-auto.xxx``, where ``.xxx`` is the file type extension (if applicable).
|
||||
- Create an empty file named ``scummvm-autorun`` in the same folder as both the executable and the chosen game. Either leave the file empty, or use it to specify any further command line options. Specify one option per line.
|
||||
|
||||
.. tab-item:: macOS
|
||||
|
||||
The following information are only correct when ScummVM is built as a .app bundle. When ScummVM is built as a command line application it behaves as on Windows and Linux.
|
||||
|
||||
ScummVM can automatically detect and run a supported game included in the ScummVM.app bundle. The game files simply need to be in the ``ScummVM.app/Contents/Resources/game/`` folder.
|
||||
|
||||
ScummVM can also automatically detect and add to the launcher supported games included in the ScummVM.app bundle. The games simply need to be in the ``ScummVM.app/Contents/Resources/games/`` folder, or subfolders in that folder (you can for example use one subfolder per game).
|
||||
|
||||
A ``scummvm-autorun`` file can also be used to specify command line options to use, with one option per line. The file should be in the ``ScummVM.app/Contents/Resources/`` folder.
|
||||
|
||||
In addition if a ``scummvm.ini`` file is present in the ``ScummVM.app/Contents/Resources/`` folder, it will be used as initial config file if no ``ScummVM Preferences`` file exists yet. It is the equivalent of using the ``--initial-cfg`` :doc:`command line option <../advanced_topics/command_line>`.
|
||||
|
||||
Finally it can be noted that the bundle name specified in the ``ScummVM.app/Contents/Info.plist`` file is used for the default config file name. For example by default, when the bundle name is ``ScummVM``, the default config file where settings are saved is ``~/Library/Preferences/ScummVM Preferences``. But if you change the bundle name to ``MyGame``, the default config file used is ``~/Library/Preferences/MyGame Preferences``
|
||||
|
||||
Thus to create a game bundle for a specific game you can:
|
||||
|
||||
1. Copy the ScummVM.app bundle for example to MyGame.app
|
||||
2. Create a MyGame.app/Contents/Resources/game/ folder and copy your game data files to that folder.
|
||||
3. Edit the bundle name and bundle display name in the MyGame.app/Contents/Info.plist file.
|
||||
4. Create a new icons file in MyGame.app/Contents/Resources/ and edit the icon file in the MyGame.app/Contents/Info.plist file.
|
||||
5. Create a MyGame.app/Contents/Resources/scummvm.ini file with the default settings for your game bundle (for example to set fullscreen to true).
|
||||
|
||||
Note that modifying a signed bundle will invalidate the signature. So the bundle needs to be signed again after for example adding a ``game`` folder inside the ScummVM.app bundle.
|
||||
|
||||
.. tab-item:: iOS
|
||||
|
||||
ScummVM can automatically detect and run a supported game included in the ScummVM.app bundle. The game files simply need to be in the ``ScummVM.app/game/`` folder.
|
||||
|
||||
ScummVM can also automatically detect and add to the launcher supported games included in the ScummVM.app bundle. The games simply need to be in the ``ScummVM.app/games/`` folder, or subfolders in that folder (you can for example use one subfolder per game).
|
||||
|
||||
A ``scummvm-autorun`` file can also be used to specify command line options to use, with one option per line. The file should be in the ``ScummVM.app/`` folder.
|
||||
|
||||
In addition if a ``scummvm.ini`` file is present in the ``ScummVM.app/`` folder, it will be used as initial config file if no config file exists yet. It is the equivalent of using the ``--initial-cfg`` :doc:`command line option <../advanced_topics/command_line>`.
|
||||
|
||||
Note that modifying a signed bundle will invalidate the signature. So the bundle needs to be signed again after for example adding a ``game`` folder inside the ScummVM.app bundle.
|
||||
|
||||
|
||||
|
||||
Example of a scummvm-autorun file
|
||||
===================================
|
||||
|
||||
.. code::
|
||||
|
||||
--fullscreen
|
||||
--shader=crt/crt-lottes.glslp
|
||||
--path=./game/
|
||||
--auto-detect
|
||||
286
doc/docportal/advanced_topics/command_line.rst
Normal file
286
doc/docportal/advanced_topics/command_line.rst
Normal file
@@ -0,0 +1,286 @@
|
||||
|
||||
=======================
|
||||
Command line interface
|
||||
=======================
|
||||
|
||||
Launching ScummVM from the command line lets you pass a number of options, some of which override the applicable global or game-specific settings. It also lets you launch straight into a game without going to the Launcher first.
|
||||
|
||||
|
||||
Usage
|
||||
=========
|
||||
|
||||
.. code-block::
|
||||
|
||||
scummvm [option] [game]
|
||||
|
||||
- By default, executing ``scummvm`` on the command line starts the Launcher.
|
||||
- Specify a game or use ``--auto-detect`` to start a game directly.
|
||||
- Some options, such as ``--help`` or ``--list-audio-devices``, allow you to view information about ScummVM directly on the command line without starting the Launcher or starting a game.
|
||||
|
||||
|
||||
Starting a game
|
||||
===============
|
||||
|
||||
To start a game on the command line, three options are possible.
|
||||
|
||||
For games that have previously been added to ScummVM:
|
||||
|
||||
.. code::
|
||||
|
||||
scummvm <target>
|
||||
|
||||
For any supported games, even if they have not been added to ScummVM:
|
||||
|
||||
.. code::
|
||||
|
||||
scummvm -p <path to game files> <game id>
|
||||
|
||||
or
|
||||
|
||||
.. code::
|
||||
|
||||
scummvm -p <path to game files> --auto-detect
|
||||
|
||||
In all cases additional options can be specified on the command line, for example to specify the graphics mode or which saved game to load.
|
||||
|
||||
The ``target`` is a name assigned to a game added to ScummVM. It is also known as the ID in the GUI, and can be changed in the :ref:`Game Options <id>`. In the configuration file, this is the game name in square brackets. If the same game is added to ScummVM twice, it will have two different ``target`` names, and they can be configured differently. To see the list of configured targets:
|
||||
|
||||
.. code::
|
||||
|
||||
scummvm --list-targets
|
||||
|
||||
The ``game id`` is a unique identifier for any game supported by ScummVM. To see a list of all supported games for your ScummVM release:
|
||||
|
||||
.. code::
|
||||
|
||||
scummvm --list-games
|
||||
|
||||
Specify a ``target`` on the command line to use settings already configured for that target, unless different options are specified on the command line. There is no need to specify the path for the game files since this is already part of the target configuration.
|
||||
|
||||
Use the ``game id`` or ``--auto-detect`` to start games with default settings for any settings not specified on the command line. The path to the game file needs to be specified.
|
||||
|
||||
The full ``game id`` contains both an engine name and a game name. For example, the game id for Full Throttle is ``scumm:ft``, where ``scumm`` is the engine name. In many cases where there is no ambiguity, you can omit the engine name when specifying a ``game id`` on the command line. For example, both ``scumm:ft`` and ``ft`` can be used. However, if there is an ambiguity with the game name, the full ``game id`` must be used. For example, for Indiana Jones and the Fate of Atlantis only ``scumm:atlantis`` can be used as there would otherwise be an ambiguity with ``cryomni3d:atlantis``.
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: Windows
|
||||
|
||||
.. card::
|
||||
|
||||
The following examples assume that the path to ScummVM is ``C:\Program Files\ScummVM\scummvm.exe``.
|
||||
|
||||
To run Monkey Island, fullscreen (``-f``), if the game has already been added to ScummVM under the `target` name `monkey1`:
|
||||
|
||||
.. code-block::
|
||||
|
||||
C:\Program Files\ScummVM\scummvm.exe -f monkey1
|
||||
|
||||
|
||||
|
||||
To run Full Throttle, fullscreen (``-f``) and with subtitles enabled (``-n``), specifying the path to the game on a CD (``-p``):
|
||||
|
||||
.. code-block::
|
||||
|
||||
C:\Program Files\ScummVM\scummvm.exe -f -n -p "D:\resource" scumm:ft
|
||||
|
||||
.. tab-item:: macOS
|
||||
|
||||
.. card::
|
||||
|
||||
The following examples assume the path to the ScummVM app is ``Applications/ScummVM.app``.
|
||||
|
||||
If you are unsure of the path to the app, drag the ScummVM app icon into the Terminal window. This prints the path to the ScummVM app.
|
||||
|
||||
To run ScummVM from the command line, add ``/Contents/MacOS/scummvm`` to that path.
|
||||
|
||||
To run Monkey Island, fullscreen (``-f``), if the game has already been added to ScummVM under the `target` name `monkey1`:
|
||||
|
||||
.. code::
|
||||
|
||||
/Applications/ScummVM.app/Contents/MacOS/scummvm -f monkey1
|
||||
|
||||
|
||||
To run Full Throttle, fullscreen (``-f``) and with subtitles enabled (``-n``), specifying the path to the game on a CD (``-p``):
|
||||
|
||||
.. code::
|
||||
|
||||
/Applications/ScummVM.app/Contents/MacOS/scummvm -f -n -p "/Volumes/Full Throttle/resource" scumm:ft
|
||||
|
||||
.. tab-item:: Linux
|
||||
|
||||
.. card::
|
||||
|
||||
The following examples assume the path to ScummVM is ``/usr/games/scummvm``.
|
||||
|
||||
To run Monkey Island, fullscreen (``-f``), if the game has already been added to ScummVM under the `target` name `monkey1`:
|
||||
|
||||
.. code::
|
||||
|
||||
/usr/games/scummvm -f monkey1
|
||||
|
||||
|
||||
To run Full Throttle, fullscreen (``-f``) and with subtitles enabled (``-n``), specifying the path to the game on a CD (``-p``):
|
||||
|
||||
.. code::
|
||||
|
||||
/usr/games/scummvm -f -n -p /cdrom/resource scumm:ft
|
||||
|
||||
.. tip::
|
||||
|
||||
If ScummVM is on PATH, there is no need to enter the full path to ScummVM. Similarly, if a game is already added to the Launcher, there is no need to specify the path to the game.
|
||||
|
||||
|
||||
Options
|
||||
========
|
||||
|
||||
The meaning of most options can be inverted by prefixing them with ``no-``. For example, ``--no-aspect-ratio`` will turn aspect ratio correction off. This does not apply to short options.
|
||||
|
||||
Option parameters are shown below in capitals, and need to be replaced with real values.
|
||||
|
||||
Short options are listed where they are available.
|
||||
|
||||
.. csv-table::
|
||||
:widths: 25 10 45 15
|
||||
:class: command
|
||||
:header-rows: 1
|
||||
|
||||
Option,Short,Description,Default
|
||||
``--add``,``-a``,"Adds all games from current or specified directory. If ``--game=ID`` is passed, only the game with specified ID is added. See also ``--detect``. Use ``--path=PATH`` before ``-a`` or ``--add`` to specify a directory.",
|
||||
``--alt-intro``, ,":ref:`Uses alternative intro for CD versions <altintro>`, Sky and Queen engines only",false
|
||||
``--aspect-ratio``,,":ref:`Enables aspect ratio correction <ratio>`",false
|
||||
``--auto-detect``,,"Displays a list of games from the current or specified directory and starts the first game. Use ``--path=PATH`` before ``--auto-detect`` to specify a directory",
|
||||
``--boot-param=NUM``,``-b``,"Pass number to the boot script (`boot param <https://wiki.scummvm.org/index.php/Boot_Params>`_).",0
|
||||
``--cdrom=DRIVE``,,"Sets the CD drive to play CD audio from. This can be a drive, path, or numeric index",0
|
||||
``--config=FILE``,``-c``,"Uses alternate configuration file",
|
||||
``--console``,,"Enables the console window. Win32 and Symbian32 only.",true
|
||||
``--copy-protection``,,"Enables copy protection",false
|
||||
``--debug-channels-only``,,"Shows only the specified debug channels",
|
||||
``--debugflags=FLAGS``,,"Enables engine specific debug flags",
|
||||
``--debuglevel=NUM``,``-d``,"Sets debug verbosity level",0
|
||||
``--demo-mode``,,"Starts demo mode of Maniac Mansion or The 7th Guest",false
|
||||
``--detect``,,"Displays a list of games with their game id from the current or specified directory. This does not add the game to the games list. Use ``--path=PATH`` before ``--detect`` to specify a directory.",
|
||||
``--dirtyrects``,, Enables dirty rectangles optimisation in software renderer,true
|
||||
``--disable-display``,,Disables any graphics output. Use for headless events playback by `Event Recorder <https://wiki.scummvm.org/index.php/Event_Recorder>`_ ,false
|
||||
``--dump-midi``,, "Dumps MIDI events to 'dump.mid' while game is running. Overwrites file if it already exists.",false
|
||||
``--dump-scripts``,``-u``,"Enables script dumping if a directory called 'dumps' exists in the current directory",false
|
||||
``--enable-gs``,,":ref:`Enables Roland GS mode for MIDI playback <gs>`",false
|
||||
``--engine=ID``,,"In combination with ``--list-games`` or ``--list-all-games`` only lists games for this engine",
|
||||
``--engine-speed=NUM``,,"Sets frame-per-second limit for Grim Fandango or Escape from Monkey Island. 0 is no limit. Allowed values 0 - 100", 60
|
||||
``--extrapath=PATH``,,":ref:`Extra path to additional game data <extra>`",
|
||||
``--filtering``,,":ref:`Forces filtered graphics mode <filtering>`",false
|
||||
``--fullscreen``,``-f``,":ref:`Forces full-screen mode <fullscreen>`",false
|
||||
``--game=ID``,,"In combination with ``--add`` or ``--detect`` only adds or attempts to detect the game with specified ID.",
|
||||
``--gfx-mode``,``-g``,":ref:`Selects graphics mode <gfxmode>`",normal
|
||||
``--gui-theme=THEME``,,":ref:`Selects GUI theme <theme>`",
|
||||
``--help``,``-h``,"Displays a brief help text and exit",
|
||||
``--iconspath=PATH``,,":ref:`Path to additional icons for the launcher grid view <iconspath>`",
|
||||
``--initial-cfg=FILE``,``-i``,"Loads an initial configuration file if no configuration file has been saved yet.",
|
||||
``--joystick=NUM``,,"Enables joystick input.",0
|
||||
``--language``,``-q``,":ref:`Selects language <lang>`. Allowed values: en, de, fr, it, pt, es, jp, zh, kr, sv, gb, hb, ru, cz",en
|
||||
``--list-all-debugflags``,,"Lists all debug flags",
|
||||
``--list-all-engines``,,"Lists all detection engines, then exits",
|
||||
``--list-audio-devices``,,"Lists all available audio devices",
|
||||
``--list-debugflags=engine``,,"Lists engine-specific debug flags. If ``engine=global`` or engine is not specified, then it lists global debug flags.",
|
||||
``--list-engines``,,"Lists supported engines, then exits",
|
||||
``--list-engines-json``,,"Lists supported engines as json, then exits",
|
||||
``--list-games``,``-z``, "Lists supported games, then exits.",
|
||||
``--list-games-json``,, "Lists supported games as json, then exits.",
|
||||
``--list-records --game=TARGET``,, "Lists recordings for the specified target (`Event Recorder <https://wiki.scummvm.org/index.php/Event_Recorder>`_)",
|
||||
``--list-records-json --game=TARGET``,, "Lists recordings as json for the specified target (`Event Recorder <https://wiki.scummvm.org/index.php/Event_Recorder>`_)",
|
||||
``--list-saves --game=TARGET``,,"Displays a list of saved games for the game specified, or for all targets if no game specified.",
|
||||
``--list-targets``,``-t``,"Lists configured targets, then exits",
|
||||
``--list-targets-json``,,"Lists configured targets as json, then exits",
|
||||
``--list-themes``,,"Lists all usable GUI themes",
|
||||
``--logfile=PATH``,``-l``,"Uses alternate path for log file (SDL backend only).",
|
||||
``--md5``,,"Shows MD5 hash of the file given by ``--md5-path=PATH``. If ``--md5-length=NUM`` is passed then it shows the MD5 hash of the first or last ``NUM`` bytes of the file given by ``PATH``. If ``--md5-engine=ENGINE_ID`` option is passed then it auto-calculates the required bytes and its hash, overriding ``--md5-length``",
|
||||
``--md5mac``,,"Shows MD5 hash for both the resource fork and data fork of the file given by ``--md5-path=PATH``. If ``--md5-length=NUM`` is passed then it shows the MD5 hash of the first or last``NUM`` bytes of each fork.",
|
||||
``--md5-engine=ENGINE_ID``,,"Used with ``--md5`` to specify the engine for which number of bytes to be hashed must be calculated. This option overrides ``--md5-length`` if used along with it. Use ``--list-engines`` to find all engine IDs.",
|
||||
``--md5-length=NUM``,,"Used with ``--md5`` or ``--md5mac`` to specify the number of bytes to be hashed. If ``NUM`` is 0, MD5 hash of the whole file is calculated. If ``NUM`` is negative, the MD5 hash is calculated from the tail. Is overridden if passed with ``--md5-engine`` option",0
|
||||
``--md5-path=PATH``,,"Used with ``--md5`` or ``--md5mac`` to specify path of file to calculate MD5 hash of", ./scummvm
|
||||
``--midi-gain=NUM``,,":ref:`Sets the gain for MIDI playback <gain>` Only supported by some MIDI drivers. 0-1000",100
|
||||
``--multi-midi``,,":ref:`Enables combination AdLib and native MIDI <multi>`",false
|
||||
``--music-driver=MODE``,``-e``,":ref:`Selects preferred music device <device>`",auto
|
||||
``--music-volume=NUM``,``-m``,":ref:`Sets the music volume <music>`, 0-255",192
|
||||
``--native-mt32``,,":ref:`True Roland MT-32 (disables GM emulation) <mt32>`",false
|
||||
``--no-fullscreen``,``-F``,"Forces windowed mode",
|
||||
``--opl-driver=DRIVER``,,":ref:`Selects AdLib (OPL) emulator <opl>`",
|
||||
``--output-channels=CHANNELS``,,"Select output channel count, for example, 2 for stereo.",
|
||||
``--output-rate=RATE``,,"Selects output sample rate in Hz, for example 22050Hz.",
|
||||
``--path=PATH``,``-p``,"Sets path to where the game is installed",
|
||||
``--platform=STRING``,,":ref: `Specifies platform of game <platform>`
|
||||
Allowed values:
|
||||
|
||||
- 2gs
|
||||
- 3do
|
||||
- acorn
|
||||
- amiga
|
||||
- atari
|
||||
- c64
|
||||
- fmtowns
|
||||
- nes
|
||||
- mac
|
||||
- pc
|
||||
- pc98
|
||||
- pce
|
||||
- segacd
|
||||
- wii
|
||||
- windows",
|
||||
``--random-seed=SEED``,,":ref:`Sets the random seed used to initialize entropy <seed>`",
|
||||
``--record-file-name=FILE``,,"Specifies recorded file name (`Event Recorder <https://wiki.scummvm.org/index.php/Event_Recorder>`_)",record.bin
|
||||
``--record-mode=MODE``,,"Specifies record mode for `Event Recorder <https://wiki.scummvm.org/index.php/Event_Recorder>`_. Allowed values: record, playback, fast_playback, info, update, passthrough.", none
|
||||
``--recursive``,,"In combination with ``--add or ``--detect`` recurses down all subdirectories",
|
||||
``--renderer=RENDERER``,,"Selects 3D renderer. Allowed values: software, opengl, opengl_shaders",
|
||||
``--render-mode=MODE``,,":ref:`Enables additional render modes <render>`.
|
||||
Allowed values:
|
||||
|
||||
- hercGreen
|
||||
- hercAmber
|
||||
- cga
|
||||
- ega
|
||||
- vga
|
||||
- amiga
|
||||
- fmtowns
|
||||
- pc9821
|
||||
- pc9801
|
||||
- 2gs
|
||||
- atari
|
||||
- macintosh
|
||||
- macintoshbwdefault", default
|
||||
``--save-slot=NUM``,``-x``,"Specifies the saved game slot to load", 0 (autosave)
|
||||
``--savepath=PATH``,,":ref:`Specifies path to where saved games are stored <savepath>`",
|
||||
``--scale-factor=FACTOR``,,"Specifies the factor to scale the graphics by",
|
||||
``--scaler=MODE``,, "Selects graphics scaler.
|
||||
Allowed values:
|
||||
|
||||
- normal
|
||||
- hq
|
||||
- edge
|
||||
- advmame
|
||||
- sai
|
||||
- supersai
|
||||
- supereagle
|
||||
- pm
|
||||
- dotmatrix
|
||||
- tv",default
|
||||
``--screenshotpath=PATH``,,"Specify path where screenshot files are created. SDL backend only.",
|
||||
``--screenshot-period=NUM``,,"When recording, triggers a screenshot every NUM milliseconds.(`Event Recorder <https://wiki.scummvm.org/index.php/Event_Recorder>`_)",60000
|
||||
``--sfx-volume=NUM``,``-s``,":ref:`Sets the sfx volume <sfx>`, 0-255",192
|
||||
``--show-fps``,,Turns on frames-per-second information in 3D games,false
|
||||
``--soundfont=FILE``,,":ref:`Selects the SoundFont for MIDI playback. <soundfont>`. Only supported by some MIDI drivers.",
|
||||
``--speech-volume=NUM``,``-r``,":ref:`Sets the speech volume <speechvol>`, 0-255",192
|
||||
``--start-movie=NAME@NUM``,,"Starts Director movie at specified frame. Either can be specified without the other.",
|
||||
``--stretch-mode=MODE``,, "Selects stretch mode.
|
||||
Allowed values:
|
||||
|
||||
- center
|
||||
- pixel-perfect
|
||||
- even-pixels
|
||||
- fit
|
||||
- stretch
|
||||
- fit_force_aspect",
|
||||
``--subtitles``,``-n``,":ref:`Enables subtitles <speechmute>`",
|
||||
``--talkspeed=NUM``,,":ref:`Sets talk speed for games <talkspeed>`",60
|
||||
``--tempo=NUM``,,"Sets music tempo (in percent, 50-200) for SCUMM games.",100
|
||||
``--themepath=PATH``,,":ref:`Specifies path to where GUI themes are stored <themepath>`",
|
||||
``--version``,``-v``,"Displays ScummVM version information, then exits.",
|
||||
"``--window-size=W,H``",,"Sets the ScummVM window size to the specified dimensions. OpenGL only.",
|
||||
529
doc/docportal/advanced_topics/configuration_file.rst
Normal file
529
doc/docportal/advanced_topics/configuration_file.rst
Normal file
@@ -0,0 +1,529 @@
|
||||
|
||||
=======================
|
||||
Configuration file
|
||||
=======================
|
||||
|
||||
The configuration file provides a way to edit both global and game-specific settings. It is a text file containing configuration keys and parameters.
|
||||
|
||||
Settings are also accessible directly from the Launcher. See :doc:`../use_scummvm/how_to_settings`.
|
||||
|
||||
Location
|
||||
==========
|
||||
|
||||
The configuration file saves to different default locations, depending on the platform. The configuration file path is also displayed on the :doc:`../settings/paths` tab.
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: Windows
|
||||
|
||||
``%APPDATA%\ScummVM\scummvm.ini``
|
||||
|
||||
For Windows 95/98/ME, the file is at ``C:\WINDOWS\scummvm.ini``
|
||||
|
||||
|
||||
.. tab-item:: macOS
|
||||
|
||||
``~/Library/Preferences/ScummVM Preferences``
|
||||
|
||||
.. note::
|
||||
|
||||
If an earlier version of ScummVM was installed on your system, the configuration file remains in the previous default location of ``~/.scummvmrc``.
|
||||
|
||||
.. tip::
|
||||
|
||||
To see the Library folder, press :kbd:`Option` when clicking **Go** in the Finder menu.
|
||||
|
||||
|
||||
.. tab-item:: Linux
|
||||
|
||||
ScummVM follows the XDG Base Directory Specification, so by default the configuration file is found at ``~/.config/scummvm/scummvm.ini``, but its location might vary depending on the value of the ``XDG_CONFIG_HOME`` environment variable.
|
||||
|
||||
If ScummVM was installed using Snap, the configuration file is found at ``~/snap/scummvm/current/.config/scummvm/scummvm.ini``
|
||||
|
||||
.. note::
|
||||
|
||||
``.config`` is a hidden directory. To view it use ``ls -a`` on the command line.
|
||||
|
||||
|
||||
|
||||
|
||||
Using the configuration file
|
||||
==================================
|
||||
|
||||
Global settings are listed under the ``[scummvm]`` heading. Global :doc:`keymaps settings <../settings/keymaps>` are listed under the ``[keymapper]`` heading. Game-specific settings, including keymaps, are listed under the heading for that game, for example ``[queen]`` for Flight of the Amazon Queen. Use the configuration keys to change settings.
|
||||
|
||||
|
||||
Example of a configuration file
|
||||
************************************
|
||||
|
||||
.. code::
|
||||
|
||||
[scummvm]
|
||||
gfx_mode=supereagle
|
||||
fullscreen=true
|
||||
savepath=C:\saves\
|
||||
|
||||
[sky]
|
||||
path=C:\games\SteelSky\
|
||||
|
||||
[germansky]
|
||||
gameid=sky
|
||||
language=de
|
||||
path=C:\games\SteelSky\
|
||||
description=Beneath a Steel Sky w/ German subtitles
|
||||
|
||||
[germandott]
|
||||
gameid=tentacle
|
||||
path=C:\german\tentacle\
|
||||
description=German version of DOTT
|
||||
|
||||
[tentacle]
|
||||
path=C:\tentacle\
|
||||
subtitles=true
|
||||
music_volume=40
|
||||
sfx_volume=255
|
||||
|
||||
[loomcd]
|
||||
cdrom=1
|
||||
path=C:\loom\
|
||||
talkspeed=5
|
||||
savepath=C:\loom\saves\
|
||||
|
||||
[monkey2]
|
||||
path=C:\amiga_mi2\
|
||||
music_driver=windows
|
||||
|
||||
|
||||
Default configuration file option
|
||||
=====================================
|
||||
|
||||
An initial (default) configuration file can be specified via the :doc:`command line <../advanced_topics/command_line>` using the ``--i`` or ``--initial-cfg`` option. ScummVM uses this default file if the configuration file is missing from its usual location, such as after initial install, or if the user deletes their configuration file.
|
||||
|
||||
Setting an initial configuration file in this way allows default settings to easily be bundled with a game. The alternatives are to use the command line for all settings, which has fewer options and in some cases means the user can't change settings, or to install a default configuration file to a writable location and using the ``--config`` option, which is harder to deploy, and leaves the user with no way to restore default settings except re-installing the game.
|
||||
|
||||
|
||||
.. _configuration_keys:
|
||||
|
||||
Configuration keys
|
||||
=====================
|
||||
|
||||
There are many recognized configuration keys. In the table below, each key is either linked to an explanatory description in the Settings pages, or has further information in the **Description/Options** column.
|
||||
|
||||
.. csv-table::
|
||||
:header-rows: 1
|
||||
:class: config
|
||||
|
||||
Key,Type,Default,Description/Options
|
||||
alsa_port,integer,,Specifies which ALSA port ScummVM uses when using the ALSA music driver (Linux).
|
||||
":ref:`alt_intro <altintro>`",boolean,false,
|
||||
":ref:`altamigapalette <altamiga>`",boolean,false,
|
||||
":ref:`always_christmas <christmas>`",boolean,true,
|
||||
":ref:`antialiasing <antialiasing>`", integer,0,"0, 2, 4, 8"
|
||||
":ref:`apple2gs_speedmenu <2gs>`",boolean,false,
|
||||
":ref:`aspect_ratio <ratio>`",boolean,false,
|
||||
":ref:`audio_buffer_size <buffer>`",integer,"Calculated based on output sampling frequency to keep audio latency below 45ms.","Overrides the size of the audio buffer. Allowed values
|
||||
|
||||
- 256
|
||||
- 512
|
||||
- 1024
|
||||
- 2048
|
||||
- 4096
|
||||
- 8192
|
||||
- 16384
|
||||
- 32768"
|
||||
":ref:`audio_override <aoverride>`",boolean,true,
|
||||
":ref:`automatic_drilling <drill>`",boolean,false,
|
||||
":ref:`auto_savenames <autoname>`",boolean,false,
|
||||
":ref:`autosave_period <autosave>`", integer, 300,
|
||||
auto_savenames,boolean,false, Automatically generates names for saved games
|
||||
":ref:`bilinear_filtering <bilinear>`",boolean,false,
|
||||
`boot_param <https://wiki.scummvm.org/index.php/Boot_Params>`_,integer,none,
|
||||
":ref:`bright_palette <bright>`",boolean,true,
|
||||
":ref:`camera_on_player <silencer>`",boolean,true,
|
||||
cdrom,integer,0, "Sets which CD drive to play CD audio from (as a numeric index). If a negative number is set, ScummVM does not access the CD drive."
|
||||
":ref:`cdromdelay <cdrom>`",boolean,,
|
||||
":ref:`cheat <cheat>`",boolean,false,
|
||||
":ref:`cheats <cheats>`",boolean,true,
|
||||
":ref:`color <color>`",boolean,,
|
||||
":ref:`commandpromptwindow <cmd>`",boolean,false,
|
||||
":ref:`confirm_exit <guiconfirm>`",boolean,false,
|
||||
console,boolean,true, Enables the console window for Win32/Symbian32.
|
||||
controller_map_db,string,"``gamecontrollerdb.txt`` is loaded from the specified extrapath", "Specifies the custom controller mapping file to load to complete the default database (SDL backend only)."
|
||||
copy_protection,boolean,false, Enables copy protection
|
||||
demo_mode,boolean,false, Starts demo mode of Maniac Mansion or the 7th Guest
|
||||
":ref:`correct_spanish_credits <spanishcredits>`",boolean,false,
|
||||
":ref:`credits_music <creditsmusic>`",boolean,false,
|
||||
":ref:`datausr_load <datausr>`",boolean,false,
|
||||
":ref:`debug <debugmode>`",boolean,false,
|
||||
":ref:`description <description>`",string,,
|
||||
desired_screen_aspect_ratio,string,auto,
|
||||
dimuse_tempo,integer,10,"Sets internal Digital iMuse tempo per second; 0 - 100"
|
||||
":ref:`disable_demo_mode <demo>`",boolean,false,
|
||||
":ref:`disable_dithering <dither>`",boolean,false,
|
||||
":ref:`disable_falling <falling>`",boolean,false,
|
||||
":ref:`disable_sensors <sensors>`",boolean,false,
|
||||
":ref:`disable_stamina_drain <stamina>`",boolean,false,
|
||||
":ref:`displaytext <displaytext>`",boolean,true,
|
||||
":ref:`dos_music_tempo <dostempo>`",boolean,true,"If set to false, plays the Windows version music tempo."
|
||||
":ref:`DurableArmor <durable>`",boolean,false,
|
||||
":ref:`easier_ai <ai>`",boolean,false,
|
||||
":ref:`EasyMouse <easy>`",boolean,true,
|
||||
":ref:`enable_assets_mod <assets>`",boolean,true,
|
||||
":ref:`enable_bearded_musicians <beard>`",boolean,false,
|
||||
":ref:`enable_black_lined_video <blackline>`",,false,
|
||||
":ref:`enable_censoring <censor>`",boolean,false,
|
||||
":ref:`enable_color_blind <blind>`",boolean,false,
|
||||
":ref:`enable_enhancements <enhancements>`",boolean,true,
|
||||
":ref:`enable_font_antialiasing <fontantialias>`",boolean,true,
|
||||
":ref:`enable_gore <gore>`",boolean,,
|
||||
":ref:`enable_gs <gs>`",boolean,,
|
||||
":ref:`enable_high_resolution_graphics <hires>`",boolean,true,
|
||||
":ref:`enable_hq_video <hq>`",boolean,true,
|
||||
":ref:`enable_larryscale <larry>`",boolean,true,
|
||||
":ref:`enable_reporter <reporter>`",boolean,false,RISC OS only.
|
||||
":ref:`enable_video_upscale <upscale>`",boolean,true,
|
||||
":ref:`enable_tts <ttsenabled>`",boolean,false,
|
||||
enable_unsupported_game_warning,boolean,true, Shows a warning when adding a game that is unsupported.
|
||||
enable_unsupported_addon_warning,boolean,true, Shows a warning when starting a game including an add-on that is unsupported.
|
||||
":ref:`extended_timer <extended>`",boolean,false,
|
||||
extra,string, ,"Shows additional information about a game, such as version"
|
||||
":ref:`english_speech <english>`",boolean,false,
|
||||
":ref:`extrapath <extra>`",string,None,
|
||||
":ref:`iconspath <iconspath>`",string,None,
|
||||
":ref:`infiniteAmmo <infA>`",boolean,false,
|
||||
":ref:`infiniteHealth <infH>`",boolean,false,
|
||||
":ref:`disable_fade_effects <fadeout>`",boolean,false,
|
||||
":ref:`doublefps <double>`",boolean,false,
|
||||
":ref:`fade_style <fade>`",boolean,true,
|
||||
":ref:`fast_movie_speed <fastmovie>`",boolean,false,
|
||||
":ref:`filtering <filtering>`",boolean,false,
|
||||
":ref:`floating_cursors <floating>`",boolean,false,
|
||||
":ref:`fluidsynth_chorus_activate <chact>`",boolean,true,
|
||||
":ref:`fluidsynth_chorus_depth <chdepth>`",integer,80,"- 0 - 210"
|
||||
":ref:`fluidsynth_chorus_level <chlevel>`",integer,100,"- 0 - 100"
|
||||
":ref:`fluidsynth_chorus_nr <chnr>`",integer,3,"- 0 - 99"
|
||||
":ref:`fluidsynth_chorus_speed <chspeed>`",integer,30,"- 10 - 500"
|
||||
":ref:`fluidsynth_chorus_waveform <chwave>`",string,Sine,"
|
||||
- sine
|
||||
- triangle"
|
||||
":ref:`fluidsynth_misc_interpolation <interp>`",string,4th,"
|
||||
- none
|
||||
- 4th
|
||||
- 7th
|
||||
- linear."
|
||||
":ref:`fluidsynth_reverb_activate <revact>`",boolean,true,
|
||||
":ref:`fluidsynth_reverb_damping <revdamp>`",integer,0,"- 0 - 1"
|
||||
":ref:`fluidsynth_reverb_level <revlevel>`",integer,90,"- 0 - 100"
|
||||
":ref:`fluidsynth_reverb_roomsize <revroom>`",integer,20,"- 0 - 100"
|
||||
":ref:`fluidsynth_reverb_width <revwidth>`",integer,1,"- 0 - 100"
|
||||
":ref:`font_antialiasing <fontantialias>`",boolean,false,
|
||||
":ref:`font_override <fontoverride>`",boolean,false,
|
||||
":ref:`footsteps <footsteps>`",boolean,true,
|
||||
":ref:`force_2d_renderer <2d>`",boolean,false,
|
||||
forced_dpi_scaling,integer,,"Overrides DPI scaling factor reported by the system."
|
||||
":ref:`frameLimit <framelimit>`",boolean,true,
|
||||
":ref:`frameSkip <frameskip>`",boolean,false,
|
||||
":ref:`frames_per_secondfl <fpsfl>`",boolean,false,
|
||||
":ref:`frontpanel_touchpad_mode <frontpanel>`",boolean, false
|
||||
":ref:`fullscreen <fullscreen>`",boolean,false,
|
||||
gameid,string,,"Short name of the game. For internal use only, do not edit."
|
||||
gamepath,string,,Specifies the path to the game
|
||||
":ref:`gfx_mode <gfxmode>`",string,normal (1x),"
|
||||
- 1x
|
||||
- 2x
|
||||
- 3x
|
||||
- 2xsai
|
||||
- super2xsai
|
||||
- supereagle
|
||||
- advmame2x
|
||||
- advmame3x
|
||||
- hq2x
|
||||
- hq3x
|
||||
- tv2x
|
||||
- dot-matrix
|
||||
- opengl"
|
||||
":ref:`gm_device <gm>`",string,null,"
|
||||
- auto
|
||||
- alsa
|
||||
- seq
|
||||
- sndio
|
||||
- fluidsynth
|
||||
- timidity"
|
||||
":ref:`gui_browser_native <guibrowser>`", boolean, true
|
||||
gui_browser_show_hidden,boolean,false, Shows hidden files/folders in the ScummVM file browser.
|
||||
gui_list_max_scan_entries,integer,-1, "Specifies the threshold for scanning directories in the Launcher. If the number of game entries exceeds the specified number, then scanning is skipped."
|
||||
":ref:`gui_return_to_launcher_at_exit <guireturn>`",boolean,false,
|
||||
gui_saveload_chooser,string,grid,"- list
|
||||
- grid"
|
||||
gui_saveload_last_pos,string,0,
|
||||
":ref:`gui_use_game_language <guilanguage>`",boolean, ,
|
||||
":ref:`helium_mode <helium>`",boolean,false,
|
||||
":ref:`help_style <help>`",boolean,false,
|
||||
":ref:`herculesfont <herc>`",boolean,false,
|
||||
":ref:`hpbargraphs <hp>`",boolean,true,
|
||||
":ref:`hypercheat <hyper>`",boolean,false,
|
||||
":ref:`iconspath <iconspath>`",string,,
|
||||
":ref:`improved <improved>`",boolean,true,
|
||||
":ref:`intro_music_digital <digitalmusic>`",boolean,true,
|
||||
":ref:`InvObjectsAnimated <objanimated>`",boolean,true,
|
||||
":ref:`joystick_deadzone <deadzone>`",integer, 3
|
||||
joystick_num,integer,0,Enables joystick input and selects which joystick to use. The default is the first joystick.
|
||||
":ref:`kbdmouse_speed <mousespeed>`", integer, 10
|
||||
":ref:`keymap_engine-default_DOWN <down>`",string,JOY_DOWN
|
||||
":ref:`keymap_engine-default_LCLK <LCLK>`",string,MOUSE_LEFT JOY_A
|
||||
":ref:`keymap_engine-default_LEFT <left>`",string,JOY_LEFT
|
||||
":ref:`keymap_engine-default_MCLK <MCLK>`",string,MOUSE_MIDDLE
|
||||
":ref:`keymap_engine-default_MENU <menu>`",string,F5 JOY_LEFT_SHOULDER
|
||||
":ref:`keymap_engine-default_PAUSE <pause>`",string,SPACE
|
||||
":ref:`keymap_engine-default_PIND <PIND>`",string,
|
||||
":ref:`keymap_engine-default_RCLK <RCLK>`",string,MOUSE_RIGHT JOY_B
|
||||
":ref:`keymap_engine-default_RETURN <RETURN>`",string,RETURN
|
||||
":ref:`keymap_engine-default_RIGHT <right>`",string,JOY_RIGHT
|
||||
":ref:`keymap_engine-default_SKIP <skip>`",string,ESCAPE JOY
|
||||
":ref:`keymap_engine-default_SKLI <SKLI>`",string,PERIOD JOY_X
|
||||
":ref:`keymap_engine-default_UP <up>`",string,JOY_UP
|
||||
":ref:`keymap_global_DEBUGGER <debug>`",string,C+A+d
|
||||
":ref:`keymap_global_MENU <gmm>`",string,C+F5 JOY_START,
|
||||
":ref:`keymap_global_MUTE <mute>`",string,C+u,
|
||||
":ref:`keymap_global_QUIT <globalquit>`",string,C+q,
|
||||
":ref:`keymap_global_VMOUSEDOWN <vmousedown>`",string,JOY_LEFT_STICK_Y+,
|
||||
":ref:`keymap_global_VMOUSELEFT <vmouseleft>`",string,JOY_LEFT_STICK_X-,
|
||||
":ref:`keymap_global_VMOUSERIGHT <vmouseright>`",string,JOY_LEFT_STICK_X+,
|
||||
":ref:`keymap_global_VMOUSESLOW <vmouseslow>`",string,JOY_RIGHT_SHOULDER,
|
||||
":ref:`keymap_global_VMOUSEUP <vmouseup>`",string,JOY_LEFT_STICK_Y-,
|
||||
":ref:`keymap_gui_CLOS <close>`",string,ESCAPE JOY_Y,
|
||||
":ref:`keymap_gui_DOWN <guidown>`",string,JOY_DOWN,
|
||||
":ref:`keymap_gui_INTRCT <interact>`",string,JOY_A,
|
||||
":ref:`keymap_gui_LEFT <guileft>`",string,
|
||||
":ref:`keymap_gui_RIGHT <guiright>`",string,JOY_RIGHT,
|
||||
":ref:`keymap_gui_UP <guiup>`",string,JOY_UP,
|
||||
":ref:`keymap_sdl-graphics_ASPT <ASPT>`",string,C+A+a,
|
||||
":ref:`keymap_sdl-graphics_CAPT <CAPT>`",string,C+m,
|
||||
":ref:`keymap_sdl-graphics_FILT <FILT>`",string,C+A+f
|
||||
":ref:`keymap_sdl-graphics_FLTN <FLTN>`",string,C+A+0
|
||||
":ref:`keymap_sdl-graphics_FLTP <FLTP>`",string,C+A+9
|
||||
":ref:`keymap_sdl-graphics_FULS <FULS>`",string,A+RETURN
|
||||
":ref:`keymap_sdl-graphics_SCL- <SCL>`",string,C+A+MINUS
|
||||
":ref:`keymap_sdl-graphics_SCL+ <SCL>`",string,C+A+PLUS
|
||||
":ref:`keymap_sdl-graphics_SCRS <SCRS>`",string,A+s
|
||||
":ref:`keymap_sdl-graphics_STCH <STCH>`",string,C+A+s
|
||||
":ref:`language <lang>`",string,,
|
||||
":ref:`local_server_port <serverport>`",integer,12345,
|
||||
":ref:`mac_v3_low_quality_music <macmusic>`",boolean,false,
|
||||
":ref:`midi_gain <gain>`",integer,,"- 0 - 1000"
|
||||
":ref:`midi_mode <midimode>`",string,,"- Standard
|
||||
- D110
|
||||
- FB01"
|
||||
":ref:`mm_nes_classic_palette <classic>`",boolean,false,
|
||||
":ref:`monotext <mono>`",boolean,true,
|
||||
":ref:`mouse <mouse>`",boolean,true,
|
||||
":ref:`mousebtswap <btswap>`",boolean,false,
|
||||
":ref:`mousesupport <support>`",boolean,true,
|
||||
":ref:`movie <movie>`",boolean,true,
|
||||
":ref:`mpegmovies <mpeg>`",boolean,true,
|
||||
":ref:`mt32_device <mt32>`",string,auto,"
|
||||
- auto
|
||||
- alsa
|
||||
- seq
|
||||
- fluidsynth
|
||||
- mt32
|
||||
- timidity "
|
||||
":ref:`mtropolis_debug_at_start <debugger>`",boolean,false,
|
||||
":ref:`mtropolis_mod_auto_save_at_checkpoints <saveatcheckpoints>`",boolean,true,
|
||||
":ref:`mtropolis_mod_dynamic_midi <dynamicmidi>`",boolean,true,
|
||||
":ref:`mtropolis_mod_minimum_transition_duration <shorttransitions>`",boolean,true,
|
||||
":ref:`mtropolis_mod_obsidian_widescreen <widescreen>`",boolean,false,
|
||||
":ref:`mtropolis_mod_sound_gameplay_subtitles <sfxsubs>`",boolean,false,
|
||||
":ref:`multi_midi <multi>`",boolean,,
|
||||
":ref:`music_driver [scummvm] <device>`",string,auto,"
|
||||
- null
|
||||
- auto
|
||||
|
||||
- seq (Unix)
|
||||
- sndio (Unix)
|
||||
- alsa (Unix)
|
||||
- CAMD (Amiga)
|
||||
- core (Mac)
|
||||
- coremidi (Mac - hardware)
|
||||
|
||||
- windows (Windows)
|
||||
|
||||
- fluidsynth
|
||||
- mt32
|
||||
- adlib
|
||||
- pcspk
|
||||
- pcjr
|
||||
- cms
|
||||
- timidity
|
||||
"
|
||||
"music_driver [game]",string, auto, "
|
||||
The same options as ``music_driver in [scummvm]`` plus:
|
||||
|
||||
- towns
|
||||
- C64
|
||||
- pc98
|
||||
- segacd
|
||||
"
|
||||
music_mute,boolean,false, Mutes the game music.
|
||||
":ref:`music_volume <music>`",integer,192,"- 0-256 "
|
||||
":ref:`mute <mute>`",boolean,false,
|
||||
":ref:`native_mt32 <nativemt32>`",boolean,false,
|
||||
":ref:`NaughtyMode <naughty>`",boolean,true,
|
||||
":ref:`noanimwhileturning <noanim>`",boolean,false,
|
||||
":ref:`nodelaymillisfl <nodelay>`",boolean,false,
|
||||
":ref:`ntsc <ntsc>`",boolean,,
|
||||
":ref:`object_labels <labels>`",boolean,true,
|
||||
opl2lpt_parport,,null,
|
||||
":ref:`opl3_mode <opl3mode>`",boolean,false,
|
||||
":ref:`opl_driver <opl>`",string,,"
|
||||
- auto
|
||||
- mame
|
||||
- db
|
||||
- nuked
|
||||
- alsa
|
||||
- op2lpt
|
||||
- op3lpt
|
||||
- rwopl3 "
|
||||
":ref:`original_gui <originalgui>`",boolean,true,
|
||||
":ref:`original_menus <originalmenu>`",boolean,false,
|
||||
":ref:`originalsaveload <osl>`",boolean,false,
|
||||
outputchannels,integer,,"Allows the user to specify the number of audio output channels; 1 for mono or 2 for stereo"
|
||||
":ref:`output_rate <outputrate>`",integer,,"
|
||||
Sensible values are:
|
||||
|
||||
- 11025
|
||||
- 22050
|
||||
- 44100"
|
||||
":ref:`palette_mods <palette>`",boolean,false,
|
||||
":ref:`platform <platform>`",string,,
|
||||
":ref:`portraits_on <portraits>`",boolean,true,
|
||||
":ref:`prefer_digitalsfx <dsfx>`",boolean,true,
|
||||
":ref:`prerecorded_sounds <prerecorded>`",boolean,true,
|
||||
":ref:`renderer <renderer>`",string,default,"
|
||||
- opengl
|
||||
- opengl_shaders
|
||||
- software"
|
||||
":ref:`render_mode <render>`",string,default,"
|
||||
- hercGreen
|
||||
- hercAmber
|
||||
- cga
|
||||
- ega
|
||||
- vga
|
||||
- amiga
|
||||
- fmtowns
|
||||
- pc9821
|
||||
- pc9801
|
||||
- 2gs
|
||||
- atari
|
||||
- macintosh "
|
||||
":ref:`repeatwillihint <hint>`",boolean,,
|
||||
":ref:`restored <restored>`",boolean,true,
|
||||
":ref:`retrowaveopl3_bus <adlib>`",string,,"
|
||||
Specifies how the RetroWave OPL3 is connected:
|
||||
|
||||
- serial (connected to a USB port using a PotatoPi)
|
||||
- spi (connected as a HAT using SPI) "
|
||||
":ref:`retrowaveopl3_disable_buffer <adlib>`",boolean,false,
|
||||
":ref:`retrowaveopl3_port <adlib>`",string,,"
|
||||
Specifies the serial port that the RetroWave OPL3 is connected to.
|
||||
For example:
|
||||
|
||||
- COM3
|
||||
- ttyACM2 "
|
||||
":ref:`retrowaveopl3_spi_cs <adlib>`",string,,"Specifies the GPIO chip and line that the RetroWave OPL3 is connected to. Use the format <chip>,<line>."
|
||||
":ref:`rgb_rendering <rgb>`",boolean,false,
|
||||
":ref:`rootpath <rootpath>`",string,,
|
||||
":ref:`savepath <savepath>`",string,,
|
||||
save_slot,integer,autosave, Specifies the saved game slot to load
|
||||
":ref:`scalemakingofvideos <scale>`",boolean,false,
|
||||
":ref:`scanlines <scan>`",boolean,false,
|
||||
screenshotpath,string,See :ref:`screenshotpath <screenshotpath>`,Specifies where screenshots are saved
|
||||
":ref:`semi_smooth_scroll <semi>`",boolean,false,
|
||||
sfx_mute,boolean,false, Mutes the game sound effects.
|
||||
":ref:`sfx_volume <sfx>`",integer,192,
|
||||
":ref:`shorty <shorty>`",boolean,false,
|
||||
":ref:`show_fps <fps>`",boolean,false,
|
||||
":ref:`ShowItemCosts <cost>`",boolean,false,
|
||||
":ref:`silver_cursors <silver>`",boolean,false,
|
||||
":ref:`sitcom <sitcom>`",boolean,false,
|
||||
":ref:`skip_support <skipsupport>`",boolean,true,
|
||||
":ref:`skiphallofrecordsscenes <skiphall>`",boolean,false,
|
||||
":ref:`slim_hotspots <hotspots>`",boolean,true,
|
||||
":ref:`smooth_scrolling <smooth>`",boolean,true,
|
||||
":ref:`sound <sound>`",boolean,true,
|
||||
":ref:`speech_mute <speechmute>`",boolean,false,
|
||||
":ref:`speech_volume <speechvol>`",integer,192,
|
||||
":ref:`speedrun_mode <speedrun>`",boolean,false,
|
||||
":ref:`stretch_mode <stretchmode>`",string,,"
|
||||
- center
|
||||
- pixel-perfect
|
||||
- fit
|
||||
- stretch
|
||||
- fit_force_aspect "
|
||||
":ref:`studio_audience <studio>`",boolean,true,
|
||||
":ref:`subtitles <speechmute>`",boolean,false,
|
||||
":ref:`talkspeed <talkspeed>`",integer,60,"- 0 - 255 "
|
||||
tempo,integer,100,"Sets the music tempo, in percent, for SCUMM games.
|
||||
|
||||
- 50-200"
|
||||
":ref:`targetedjump <jump>`",boolean,true,
|
||||
":ref:`TextWindowAnimated <windowanimated>`",boolean,true,
|
||||
":ref:`themepath <themepath>`",string,none,
|
||||
":ref:`transition_mode <tmode>`",boolean,false, "For Riven, this is a string with :ref:`4 options <tspeed>`
|
||||
- Disabled
|
||||
- Fastest
|
||||
- Normal
|
||||
- Best"
|
||||
":ref:`transparent_windows <transparentwindows>`",boolean,true,
|
||||
":ref:`transparentdialogboxes <transparentdialog>`",boolean,false,
|
||||
":ref:`trim_fmtowns_to_200_pixels <trim>`",boolean,false,
|
||||
":ref:`tts_enabled <ttsenabled>`",boolean,false,
|
||||
":ref:`tts_enabled_objects <tts_objects>`",boolean,false,
|
||||
":ref:`tts_enabled_speech <tts_speech>`",boolean,false,
|
||||
":ref:`tts_narrator <ttsnarrator>`",boolean,false,
|
||||
use_cdaudio,boolean,true, "If true, ScummVM uses audio from the game CD."
|
||||
versioninfo,string,,Shows the ScummVM version that created the configuration file.
|
||||
":ref:`unlockAlllevels <unlock>`",boolean,false,
|
||||
":ref:`usecd <usecd>`",boolean,false,
|
||||
":ref:`use_crawl_subs <crawlsubs>`",boolean,true,
|
||||
":ref:`usehighres <highres>`",boolean,false,
|
||||
":ref:`use_linear_filtering <linearfilter>`",boolean,true,
|
||||
":ref:`version <usa>`",boolean,false,
|
||||
":ref:`voice <voice>`",boolean,true,
|
||||
":ref:`venusenabled <venus>`",boolean,true,
|
||||
":ref:`vsync <vsync>`",boolean,true,
|
||||
":ref:`wallcollision <wall>`",boolean,false,
|
||||
":ref:`water_effects <water>`",boolean,,
|
||||
":ref:`widescreen_mod <widescreen_mod>`",boolean,false,
|
||||
":ref:`window_style <style>`",boolean,true,
|
||||
":ref:`windows_cursors <wincursors>`",boolean,false,
|
||||
":ref:`zip_mode <zip>`",boolean,,
|
||||
|
||||
|
||||
|
||||
.. _screenshotpath:
|
||||
|
||||
Screenshot path
|
||||
===============
|
||||
|
||||
The default location for the screenshotpath depends on your system.
|
||||
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: Windows
|
||||
|
||||
In ``%USERPROFILE%\Pictures\ScummVM Screenshots``
|
||||
|
||||
.. tab-item:: macOS
|
||||
|
||||
On the Desktop.
|
||||
|
||||
|
||||
.. tab-item:: Linux
|
||||
|
||||
In the XDG Pictures user directory, for example ``~/Pictures/ScummVM Screenshots``
|
||||
|
||||
.. tab-item:: Any other OS
|
||||
|
||||
In the current directory.
|
||||
221
doc/docportal/advanced_topics/understand_audio.rst
Normal file
221
doc/docportal/advanced_topics/understand_audio.rst
Normal file
@@ -0,0 +1,221 @@
|
||||
======================================================
|
||||
Understanding the audio settings
|
||||
======================================================
|
||||
|
||||
This guide expands on the information contained on the :doc:`audio settings <../settings/audio>` page.
|
||||
|
||||
|
||||
How do the audio settings work together?
|
||||
==========================================
|
||||
|
||||
The **Preferred device** in the global settings Audio tab, or the **Music device** in the game-specific settings Audio tab, specifies the device that ScummVM uses to output audio. This device can be an emulated sound device or a software synthesizer, or an actual hardware device such as a soundcard or a hardware MIDI synthesizer. When set to **<default>**, ScummVM will automatically choose the most appropriate option for the played game.
|
||||
|
||||
If **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses either an MT-32 or General MIDI device automatically, the settings on the MT-32 or MIDI tabs also apply, and the devices selected on these tabs are the ones that will be used. If **Preferred device** or **Music device** is set to either an MT-32 device or a GM device, ScummVM will use that device and ignore the devices chosen on the MT-32 and MIDI tabs.
|
||||
|
||||
Not all settings are applicable to all games. For example, changing the General MIDI settings will not have any effect on a game that only has CD audio.
|
||||
|
||||
|
||||
The evolution of PC audio
|
||||
=============================
|
||||
|
||||
For a look at the evolution of PC audio, see `this video on YouTube <https://www.youtube.com/watch?v=a324ykKV-7Y>`_, or `this excellent post <http://www.oldskool.org/sound/pc>`_.
|
||||
|
||||
Many of these old-school audio devices can be emulated by ScummVM:
|
||||
|
||||
- PC Speaker: emulates the built-in PC speaker. This is mostly supported by older games, and was the only option before sound cards became widely used.
|
||||
|
||||
*pcspk*
|
||||
|
||||
- IBM PCjr: emulates the sound of the 1984 IBM PCjr computer, which, enhanced with a Texas Instruments chip, provided three-voice sound and a white noise generator.
|
||||
|
||||
*pcjr*
|
||||
|
||||
- Creative Music System `(C/MS) <https://en.wikipedia.org/wiki/Sound_Blaster#Creative_Music_System>`_: emulates the first sound card developed by Creative Technology (later Creative Labs), the precursor to the SoundBlaster line of sound cards. The C/MS provided 12 channels of square-wave stereo sound.
|
||||
|
||||
*cms*
|
||||
|
||||
- C64 Audio: emulates the sound chip `(Sound Interface Device) <https://theconversation.com/the-sound-of-sid-35-years-of-chiptunes-influence-on-electronic-music-74935>`_ in the Commodore 64 computer. The SID was a three-voice synthesizer module, with a fourth voice for sampled drums or speech.
|
||||
|
||||
*C64*
|
||||
|
||||
- Amiga Audio: emulates the Amiga audio chip, `Paula <https://en.wikipedia.org/wiki/Original_Chip_Set#Audio>`_, which had four 8-bit PCM sound channels.
|
||||
|
||||
*CAMD*
|
||||
|
||||
- FM-Towns Audio: emulates the audio of the `FM Towns PC <https://en.wikipedia.org/wiki/FM_Towns#Sound>`_. Games on FM Towns computers often used audio CD standard tracks. The soundchips were capable of eight PCM voices and six FM channels.
|
||||
|
||||
*towns*
|
||||
|
||||
- PC-98 Audio: emulates the audio of the NEC PC-9801-26 and PC-9801-86 sound cards.
|
||||
|
||||
*pc98*
|
||||
|
||||
- SegaCD Audio: emulates the audio of the Sega CD add-on for the Sega Genesis/32x.
|
||||
|
||||
*segacd*
|
||||
|
||||
To find out which emulation is compatible with the game you're playing, have a look at the manual that comes with the game.
|
||||
|
||||
What is MIDI?
|
||||
======================
|
||||
|
||||
MIDI is a communications protocol for musical information; it can be likened to digital sheet music. By itself, MIDI is not sound. Hardware or software synthesizers create (synthesize) audio by interpreting the information given to them by the MIDI protocol.
|
||||
|
||||
While some older soundcards (and a few modern ones) have their own hardware-based synthesizers, this is relatively rare. Generally, soundcard drivers work with software synthesizers to interpret MIDI and output audio.
|
||||
|
||||
Some games only contain MIDI audio data. In the past this prevented audio for these games from working on platforms that did not support MIDI, or with soundcards that did not provide MIDI drivers. ScummVM can now convert MIDI data to sampled audio using MIDI device emulators.
|
||||
|
||||
|
||||
What is General MIDI?
|
||||
------------------------------
|
||||
|
||||
General MIDI is a MIDI standard which is implemented by a large number of devices. While using MIDI as its protocol, it also specifies an instrument map and some other information that devices must implement.
|
||||
|
||||
|
||||
.. _FS:
|
||||
|
||||
General MIDI device emulation (FluidSynth)
|
||||
*************************************************
|
||||
|
||||
If the ScummVM you're using has libfluidsynth support it will be able to play MIDI music by using the FluidSynth emulator if set as the **Preferred device** or **Music device**, or if specified in the MIDI tab when **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses General MIDI output automatically.
|
||||
|
||||
You will have to specify a SoundFont in the MIDI tab for ScummVM to use FluidSynth. MIDI is like digital sheet music; it needs a library of sound samples known as a SoundFont to draw from to synthesize music. See the `ScummVM forum <https://forums.scummvm.org/viewtopic.php?t=14541>`_ for an example of a great SoundFont.
|
||||
|
||||
The default output volume from FluidSynth can be fairly low, so ScummVM automatically sets the gain to get a stronger signal. Use the :ref:`MIDI gain <gain>` setting to further adjust this.
|
||||
|
||||
The processor requirements for FluidSynth are quite high; a fast CPU is recommended.
|
||||
|
||||
What is MT-32?
|
||||
---------------------
|
||||
|
||||
The MT-32 is a `Roland sound module <https://en.wikipedia.org/wiki/Roland_MT-32>`_, although the term also commonly refers to a range of devices that are fully compatible with the MT-32. MT-32 devices also use MIDI as the communications protocol.
|
||||
|
||||
|
||||
.. _MT-32:
|
||||
|
||||
MT-32 device emulation
|
||||
********************************
|
||||
|
||||
Some games which contain MIDI music data have tracks designed specifically for the Roland MT-32. ScummVM can emulate the MT-32 device, however you must provide the original MT-32 ROMs, taken from the MT-32 module, for the emulator to work. These files are:
|
||||
|
||||
- MT32_PCM.ROM - IC21 (512KB)
|
||||
- MT32_CONTROL.ROM - IC26 (32KB) and IC27 (32KB)
|
||||
|
||||
Place these ROMs in the game directory, in your extrapath, or in the directory where your ScummVM executable resides. ScummVM also looks for ``CM32L_PCM.ROM`` and ``CM32L_CONTROL.ROM``—the ROMs from the CM-32L device—and uses these instead of the MT32 ROMs if they are available.
|
||||
|
||||
.. note::
|
||||
|
||||
The MT-32 ROMs are copyrighted, and are not provided by ScummVM. These must be taken from your own MT-32 module.
|
||||
|
||||
ScummVM uses the MT-32 emulator if it is set as the **Preferred device** or **Music device**, or if it is specified in the MT-32 tab when **Preferred device** or **Music device** is set to **<default>** and ScummVM chooses MT-32 output automatically.
|
||||
|
||||
You don't need to enable **True Roland MT-32** in the MT-32 tab, ScummVM does this automatically.
|
||||
|
||||
.. tip::
|
||||
|
||||
Some games work better with some MT-32 devices than others. As an example, Lure of the Temptress makes use of extra sound effects included with the CM-32L and won't sound right with an MT-32. Likewise, The Colonel's Bequest uses some bugs in the early MT-32 modules, which means that later devices will play incorrect sound effects!
|
||||
|
||||
`This article <https://www.vogonswiki.com/index.php/List_of_MT-32-compatible_computer_games>`_ provides a comprehensive list of MT-32 compatible games, including which games work best with which device.
|
||||
|
||||
The processor requirements for the MT-32 emulator are quite high; a fast CPU is strongly recommended.
|
||||
|
||||
|
||||
Built-in MIDI support
|
||||
--------------------------
|
||||
|
||||
All MIDI ports show up in the **Preferred device** or **Music device** dropdown selector. If you have selected a MIDI port, you need to specify what type of MIDI device this is with the options in the :ref:`MT-32 <mt32>` tab.
|
||||
|
||||
- Enable **True Roland MT-32** to tell ScummVM that the MIDI device is an MT-32 (or fully compatible) device.
|
||||
- Enable **Roland GS device** to tell ScummVM to use an MT-32 soundtrack on a GS device. This is not supported by all games.
|
||||
- If no options are selected, ScummVM treats the device on the port as a General MIDI device.
|
||||
|
||||
If you select an option that does not match the actual device, this might have unintended consequences. For example, if a game only has support for MT-32 and you have a General MIDI device selected as the **Preferred device** or **Music device**, ScummVM will convert the MT-32 MIDI data to GM-compatible MIDI data. While this might work fine for some games, it really depends on how the game has made use of the MT-32.
|
||||
|
||||
|
||||
|
||||
macOS/Mac OS X
|
||||
***************
|
||||
|
||||
Mac has a built-in MIDI synthesizer; Apple DLS software synthesizer. It uses the Mac's built-in sounds (which are based on Roland GS).
|
||||
|
||||
The `Apple Support page <https://support.apple.com/en-nz/guide/audio-midi-setup/ams875bae1e0/mac>`_ has further information about setting up MIDI devices on a Mac.
|
||||
|
||||
Windows
|
||||
**********
|
||||
|
||||
Windows has a generic built-in MIDI synthesizer—GS WaveTable Synth—also based on Roland's GS sounds.
|
||||
|
||||
For an in-depth look at audio and MIDI device setup on a Windows computer, see this `very helpful article <http://donyaquick.com/midi-on-windows/>`_.
|
||||
|
||||
Linux
|
||||
******
|
||||
|
||||
MIDI device setup might vary depending on your Linux distro.
|
||||
|
||||
If you do not have a hardware MIDI device, there are two options: FluidSynth and TiMidity. FluidSynth is recommended as TiMidity might have some lag, depending on the system.
|
||||
|
||||
Here are a couple of helpful articles from the Ubuntu community documentation to get you started.
|
||||
|
||||
`How to: Software Synthesizers <https://help.ubuntu.com/community/Midi/SoftwareSynthesisHowTo>`_
|
||||
|
||||
`How to: Hardware synthesizer soundcard setup <https://help.ubuntu.com/community/Midi/HardwareSynthesisSetup?action=show&redirect=MidiHardwareSynthesisSetup>`_
|
||||
|
||||
,,,,,,,,,,,,,,,,,,,,
|
||||
|
||||
.. _adlib:
|
||||
|
||||
What is AdLib?
|
||||
================
|
||||
|
||||
AdLib devices do not use MIDI. They instead have a chip that produces sound through FM synthesis. While some games do store their audio data using a MIDI-derived format, this is converted by the game to work with the AdLib chip. ScummVM emulates a few different AdLib configurations, and selects the most appropriate for the game:
|
||||
|
||||
- The original AdLib and SoundBlaster card had one OPL2 chip.
|
||||
- The SoundBlaster Pro 1 had two OPL2 chips
|
||||
- The SoundBlaster Pro 2 and 16 had an OPL3 chip.
|
||||
|
||||
The AdLib emulator setting offers MAME, DOSBox and Nuked emulation, with MAME being the least accurate and using the least CPU power, and Nuked being the most accurate and also using the most CPU power - DOSBox is somewhere in between.
|
||||
|
||||
There is also the option to select the OPL2LPT, OPL3LPT and RetroWave OPL3 devices, which are external hardware devices with a real OPL chip, connected through the parallel port (OPLxLPT) or a USB port (RetroWave OPL3) of a computer. To use these devices you must specify some configuration settings in the :doc:`configuration file <../advanced_topics/configuration_file>`. The keys start with ``opl2lpt_`` and ``retrowaveopl3_``.
|
||||
|
||||
AdLib does not require a SoundFont or ROMs, so for many games it might be the easiest to configure. However, if an MT-32 or GS emulator or device is available, ScummVM will prioritize this over AdLib.
|
||||
|
||||
Mixed AdLib/MIDI mode
|
||||
------------------------
|
||||
Some games contain sound effects that are exclusive to the AdLib soundtrack, or the AdLib soundtrack might provide better sound effects. For these games, you can combine MIDI music with AdLib sound effects by using the :ref:`mixed AdLib/MIDI mode <multi>`.
|
||||
|
||||
.. note::
|
||||
|
||||
Mixed AdLib/MIDI mode is not supported by all games.
|
||||
|
||||
Digital Sound effects
|
||||
=======================
|
||||
|
||||
Some games have both sampled and synthesized sound effects. ScummVM will usually use the sampled sound effects, even if you select Adlib, MT-32 or GM as your audio device. Some games allow you to choose between sampled and synthesized sound effects by using the **Prefer digital sound effects** option in the Engine tab.
|
||||
|
||||
.. _outputrate:
|
||||
|
||||
Sample output rate
|
||||
========================
|
||||
|
||||
The output sample rate tells ScummVM how many sound samples to play per channel per second.
|
||||
|
||||
Most of the sounds were originally sampled at either 22050Hz or 11025Hz, so using a higher sample rate in these cases will not improve the quality of the audio.
|
||||
|
||||
For games that use CD audio, the sounds were probably sampled at 44100Hz, so that is a better sample rate to choose for these games.
|
||||
|
||||
ScummVM generates the samples when using AdLib, FM-Towns, PC Speaker or IBM PCjr emulated sound. 22050Hz will usually be fine for these options, although for Beneath a Steel Sky 44100Hz is recommended.
|
||||
|
||||
ScummVM has to resample all sounds to the selected output frequency. It is recommended to choose an output frequency that is a multiple of the original frequency. Choosing an in-between number might not be supported by your sound card.
|
||||
|
||||
.. _buffer:
|
||||
|
||||
Audio buffer size
|
||||
==========================
|
||||
|
||||
There is no option to control audio buffer size through the GUI, but the default value can be overridden in the :doc:`configuration file <../advanced_topics/configuration_file>` with the *audio_buffer_size* configuration keyword. The default value is calculated based on output sampling frequency to keep audio latency below 45ms.
|
||||
|
||||
Appropriate values are normally between 512 and 8192, but the value must be one of: 256, 512, 1024, 2048, 4096, 8192, 16384, or 32768.
|
||||
|
||||
Smaller values yield faster response time, but can lead to stuttering if your CPU isn't able to catch up with audio sampling when using the sound emulators. Large buffer sizes might lead to minor audio delays (high latency).
|
||||
|
||||
|
||||
251
doc/docportal/advanced_topics/understand_graphics.rst
Normal file
251
doc/docportal/advanced_topics/understand_graphics.rst
Normal file
@@ -0,0 +1,251 @@
|
||||
=====================================
|
||||
Understanding the graphics settings
|
||||
=====================================
|
||||
|
||||
This guide expands on the information contained on the :doc:`graphics settings <../settings/graphics>` page.
|
||||
|
||||
How do the graphics settings work together?
|
||||
----------------------------------------------
|
||||
|
||||
The graphics mode scaler, aspect ratio, and stretch mode settings work together to change the resolution and display of each game.
|
||||
|
||||
For the SDL Surface graphics mode, the scaler is applied first, then the aspect ratio correction, and finally the stretch mode. For the OpenGL graphics mode there is no scaler and the aspect ratio correction and stretch modes are applied together in one pass to arrive to the final image. This means that when you want to preserve pixels, you may prefer to use the OpenGL mode, especially if you use aspect ratio correction. The aspect ratio correction in the SDL Surface mode introduces some irregularities that can be avoided with the OpenGL mode.
|
||||
|
||||
Render modes are only applicable to some older games that were designed to be played on multiple systems, and let us choose which system's graphics to replicate.
|
||||
|
||||
.. _graphics:
|
||||
|
||||
Graphics modes
|
||||
---------------------------
|
||||
|
||||
Most platforms have either one or two available graphics modes. The most common ones are OpenGL and SDL Surface.
|
||||
|
||||
OpenGL graphics mode
|
||||
*************************************
|
||||
|
||||
With the OpenGL graphics mode the original game image is provided to the graphics card, and the graphics card stretches this image to the requested size. This means that the aspect ratio correction and stretch mode are applied together in one step to go directly from the original game resolution (for example 320x200) to the final display resolution (for example 1280x960). This scaling uses either bilinear interpolation or nearest neighbor interpolation depending on the :ref:`Filter graphics <filter>` option.
|
||||
|
||||
SDL Surface graphics mode
|
||||
*************************************
|
||||
|
||||
With the SDL Surface graphics mode, a software scaler is applied to the game image, before applying the aspect ratio correction with a software vertical stretch. The image is then passed to SDL to apply the :ref:`stretch mode <stretch>` and get the final result. With this graphics mode the software scaler is not affected by the :ref:`Filter graphics <filter>` option. This option only affects the aspect ratio correction and the final scaling related to the stretch mode.
|
||||
|
||||
A comparison of SDL Surface software scalers
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The original game graphics are upscaled using different graphical filters, which are specialized algorithms used to ensure that low resolution pixel-art still looks good when it is displayed at a higher resolution.
|
||||
|
||||
If the game originally ran at a resolution of 320x200—which is typical for most SCUMM games—then using a graphics mode with a scale factor of 2x yields 640x400 graphics. A 3x scale factor yields 960x600.
|
||||
|
||||
There is always a speed penalty when using a scaler other than Normal 1x.
|
||||
|
||||
To cycle forwards or backwards between graphical filters, press :kbd:`Ctrl + Alt` and :kbd:`0` or :kbd:`9` (respectively).
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/1x.png
|
||||
|
||||
**Normal 1x**: No filtering, no scaling (original resolution). Fastest.
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/2x.png
|
||||
|
||||
**Normal 2x**: No filtering, scales the image by a factor of 2. Default for non 640x480 games.
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/3x.png
|
||||
|
||||
**Normal 3x**: No filtering, scales the image by a factor of 3.
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/4x.png
|
||||
|
||||
**Normal 4x**: No filtering, scales the image by a factor of 4.
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/hq2x.png
|
||||
|
||||
**HQ 2x**: Uses lookup tables to create anti-aliased output. Very nice high quality filter, but slow.
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/hq3x.png
|
||||
|
||||
**HQ 3x**: Uses lookup tables to create anti-aliased output. Very nice high quality filter, but slow.
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/edge2x.png
|
||||
|
||||
**Edge 2x**: Uses edge-directed interpolation. Sharp, clean, anti-aliased image with very few artifacts.
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/edge3x.png
|
||||
|
||||
**Edge 3x**: Uses edge-directed interpolation. Sharp, clean, anti-aliased image with very few artifacts.
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/advmame2x.png
|
||||
|
||||
**AdvMAME 2x**: Expands each pixel into 4 new pixels based on the surrounding pixels. Doesn't rely on blurring like 2xSAI, fast.
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/advmame3x.png
|
||||
|
||||
**AdvMAME 3x**: Expands each pixel into 9 new pixels based on the surrounding pixels. Doesn't rely on blurring like 2xSAI, fast.
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/advmame4x.png
|
||||
|
||||
**AdvMAME 4x**: Expands each pixel into 16 new pixels based on the surrounding pixels. Doesn't rely on blurring like 2xSAI, fast.
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/sai2x.png
|
||||
|
||||
**SaI 2x**: Uses bilinear filtering to interpolate pixels.
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/supersai2x.png
|
||||
|
||||
**SuperSaI 2x**: An enhanced version of the SAI2x filter.
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/supereagle2x.png
|
||||
|
||||
**SuperEagle 2x**: A variation of the SAI2x filter. Less blurry than SAI2x, but slower.
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/pm2x.png
|
||||
|
||||
**PM 2x**: Analyzes the eight neighboring pixels to create smoother diagonal lines and rounded edges.
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/dotmatrix2x.png
|
||||
|
||||
**DotMatrix 2x**: Dot matrix effect.
|
||||
|
||||
.. figure:: ../images/graphics/graphics_mode/tv2x.png
|
||||
|
||||
**TV 2x**: Interlace filter. Introduces scan lines to emulate a TV.
|
||||
|
||||
|
||||
.. _aspect:
|
||||
|
||||
Aspect ratio correction
|
||||
------------------------------------
|
||||
|
||||
Older games were designed to be run at 320x200 pixels, but on systems where each pixel was rectangular instead of square. This means that on modern systems these games look wider and flatter than they are supposed to. Aspect ratio correction duplicates lines of pixels to correct this.
|
||||
|
||||
For a game with an original resolution of 320x200, aspect ratio correction results in a resolution of 320x240.
|
||||
|
||||
.. figure:: ../images/graphics/aspect_ratio/no_aspect_ratio.png
|
||||
|
||||
No aspect ratio correction applied.
|
||||
|
||||
.. figure:: ../images/graphics/aspect_ratio/aspect_ratio.png
|
||||
|
||||
Aspect ratio correction applied. The moon is actually round, as it should be!
|
||||
|
||||
To toggle aspect ratio on and off, press :kbd:`Ctrl+Alt+a`.
|
||||
|
||||
.. _stretch:
|
||||
|
||||
Stretch modes
|
||||
----------------------
|
||||
|
||||
Stretch modes control how the game screen is stretched to fill the ScummVM window (or the screen in full screen mode).
|
||||
|
||||
.. figure:: ../images/graphics/stretch_mode/center.png
|
||||
|
||||
**Center**: The game screen is not scaled and is centered in the ScummVM window.
|
||||
|
||||
.. figure:: ../images/graphics/stretch_mode/pixel-perfect.png
|
||||
|
||||
**Pixel-perfect scaling**: The game screen is scaled to the highest multiple of the game resolution that fits in the ScummVM window. Any empty space is filled with black bars.
|
||||
|
||||
The base resolution for this stretch mode includes the selected scaler and, if enabled, the :ref:`aspect ratio correction <aspect>`. This means that if the original game resolution is 320x200 and a 2x scaler is selected, the display is a multiple of 640x400 (for example 1280x800 or 1920x1200). And if aspect ratio correction is also selected, the display is a multiple of 640x480. With this stretch mode you may thus prefer to use either the OpenGL graphics mode or the SDL Surface graphics mode with a 1x scaler.
|
||||
|
||||
This means that, while the width of result will always be a multiple of the original game width, if aspect ratio correction is enabled, the height of the result may not be a multiple of the original game height. This can thus cause some blurring. If you want to use aspect ratio correction but avoid any blurring, you may prefer to use the Even-pixels scaling.
|
||||
|
||||
.. figure:: ../images/graphics/stretch_mode/even-pixels.png
|
||||
|
||||
**Even pixels scaling**: The game screen is scaled to the highest multiples of the original game width and height. Any empty space is filled with black bars. This mode is only available for the OpenGL graphics mode.
|
||||
|
||||
The factors used on the width and height may be different if the :ref:`aspect ratio correction <aspect>` is enabled as it will try to get the result as close as possible to the expected aspect ratio. For example, with a screen resolution of 1920x1080, a game with an original resolution of 320x200 and the aspect ratio correction enabled will be stretched to 1280x1000 (original width of 320 x 4 and original height of 200 x 5). Unlike the Pixel-perfect scaling, this does not provide exactly the expected aspect ratio (4:3) but uses instead a good approximation (4:3.125) while ensuring all the original pixels are scaled by the same amount.
|
||||
|
||||
.. figure:: ../images/graphics/stretch_mode/fit-to-window.png
|
||||
|
||||
**Fit to window**: Fits the game to the window, but maintains the aspect ratio.
|
||||
|
||||
With this mode you may get either horizontal black bars or vertical black bars on the side, but not both.
|
||||
|
||||
.. figure:: ../images/graphics/stretch_mode/stretch-to-window.png
|
||||
|
||||
**Stretch to window**: Stretches the game to fill the window.
|
||||
|
||||
The game may be stretched horizontally or vertically to fill the window. This mode does not enforce the aspect ratio of the game to be preserved.
|
||||
|
||||
.. figure:: ../images/graphics/stretch_mode/fit-3-4.png
|
||||
|
||||
**Fit to window (4:3)**: Fits the image to the window, at a forced 4:3 aspect ratio.
|
||||
|
||||
To switch between stretch modes, press :kbd:`Ctrl+Alt+s`.
|
||||
|
||||
.. _filter:
|
||||
|
||||
Render mode
|
||||
-------------
|
||||
|
||||
For most games this setting will have no effect. For some of the older games that could be played on different systems and graphics cards, this control lets you decide which system you want ScummVM to reproduce.
|
||||
|
||||
Below are some of the common render modes, to illustrate how the render mode setting works.
|
||||
|
||||
.. figure:: ../images/graphics/render_mode/default.png
|
||||
|
||||
Maniac Mansion with <default> render mode
|
||||
|
||||
.. figure:: ../images/graphics/render_mode/herc_green.png
|
||||
|
||||
Maniac Mansion with Hercules Green render mode
|
||||
|
||||
.. figure:: ../images/graphics/render_mode/herc_amber.png
|
||||
|
||||
Maniac Mansion with Hercules Amber render mode
|
||||
|
||||
.. figure:: ../images/graphics/render_mode/cga.png
|
||||
|
||||
Maniac Mansion with CGA (4 color) render mode
|
||||
|
||||
.. figure:: ../images/graphics/render_mode/ega.png
|
||||
|
||||
Maniac Mansion with EGA (16 color) render mode
|
||||
|
||||
.. figure:: ../images/graphics/render_mode/amiga.png
|
||||
|
||||
Maniac Mansion with Amiga (32 color) render mode
|
||||
|
||||
Shaders
|
||||
------------
|
||||
|
||||
Shaders change the way a game is rendered, and can be used to make a game look exactly how you remember it from years past - right down to the border of your Game Boy console and its old LCD screen, or your CRT monitor. Alternatively, use shaders simply to improve the overall look and feel of a game.
|
||||
|
||||
The shaders included in the ScummVM pack are curated from the Libretro repository, and are grouped according to effect. For an overview of specific shaders, see the `Libretro documentation <https://docs.libretro.com/shader/introduction/>`_
|
||||
|
||||
|
||||
|
||||
Filter graphics
|
||||
----------------
|
||||
|
||||
When enabled, ScummVM uses bilinear interpolation instead of nearest neighbor for the :ref:`aspect ratio <aspect>` and :ref:`stretch mode <stretch>`. It does not affect the :ref:`graphics mode scaler <graphics>`.
|
||||
|
||||
Nearest neighbor is a simple way to scale an image; each pixel becomes multiple pixels of the same color. While this preserves the sharper details in a pixel art image, it also creates "jagged" edges as the image is scaled up. Bilinear interpolation finds the average color between pixel color values and fills in missing pixel, which results in a "smoothed" image.
|
||||
|
||||
To toggle between bilinear interpolation and nearest neighbor, press :kbd:`Ctrl+Alt+f`.
|
||||
|
||||
3D Graphics settings
|
||||
---------------------
|
||||
|
||||
Vsync
|
||||
*******
|
||||
V-sync, or vertical sync, synchronizes the frame rate of the game with the monitor's refresh rate, or the video capture refresh rate. This helps to prevent screen "tearing", where the screen displays parts of multiple frames at once, which looks like a horizontal line where the image appears to split.
|
||||
|
||||
This setting is enabled by default.
|
||||
|
||||
Renderers
|
||||
*********
|
||||
There are three options for rendering 3D games: OpenGL, OpenGL with shaders, or software.
|
||||
|
||||
- OpenGL uses the graphics card (GPU) to render the game.
|
||||
- OpenGL with shaders also uses the GPU, but also uses shaders, if available, to render the game. Shaders are small programs running on the GPU which transform certain graphics inputs to outputs. They control things such as how the pixels are drawn on the 3D shapes.
|
||||
- The software option uses the computer's CPU, instead of a graphics card, to render the game.
|
||||
|
||||
Not all render options are available for all games. If in doubt, leave the setting at **<default>**.
|
||||
|
||||
Anti-aliasing
|
||||
***************
|
||||
Without anti-aliasing, the computer takes the color it finds at the center of the pixel, and applies that color to the entire pixel. This results in jagged, pixelated lines at the edges of objects. Anti-aliasing, in a nutshell, is how we get nice, smooth lines on a 3D game.
|
||||
|
||||
Historically, anti-aliasing was done using a method called Supersampling. With this method, each frame is rendered behind-the-scenes to a higher resolution, and then downscaled to produce a much smoother, better looking image. Unfortunately, this method is very GPU-intensive, and too slow.
|
||||
|
||||
Multisampling Anti-Aliasing, or MSAA for short, was developed as a much faster alternative; the computer renders as much of the image as possible without anti-aliasing, and then only applies anti-aliasing to the edges. It samples each pixel to find out where the edge is, and how to blend the colors to create a smooth edge. The numbered options in the ScummVM :doc:`../settings/graphics` tab (2x, 4x and 8x), refer to how many samples are taken. 8x MSAA produces a better image than 2x MSAA, but is also more GPU-intensive.
|
||||
130
doc/docportal/advanced_topics/understand_search_box.rst
Normal file
130
doc/docportal/advanced_topics/understand_search_box.rst
Normal file
@@ -0,0 +1,130 @@
|
||||
======================================================
|
||||
Understanding the search box
|
||||
======================================================
|
||||
|
||||
This guide expands on the information contained in the :ref:`the search box <search_box>` section of the Launcher interface description.
|
||||
|
||||
|
||||
Main functionality
|
||||
===========================================
|
||||
|
||||
- A filter is applied as you type, so there is no need to press Enter or click anything to perform the search.
|
||||
- All searches are case insensitive.
|
||||
- To reset the filter and get the full list of games, click on the cross icon next to the text input field.
|
||||
- Whitespace breaks the search input into separate tokens or search patterns.
|
||||
|
||||
|
||||
Search patterns
|
||||
===========================================
|
||||
|
||||
|
||||
Simple patterns
|
||||
___________________________________________
|
||||
|
||||
The simplest way to search is to use the substring search functionality. For example, type ``m`` to get all the games containing an 'M' or 'm' in description, and type ``monkey`` to get games like "The Curse of Monkey Island (Demo/Windows)", "Infinite Monkeys" or "Three Monkeys, One Cage". Ensure the search pattern does not contain ``:``/``=``/``~`` characters and it does not start with the ``!`` character.
|
||||
|
||||
|
||||
Searching configuration key values
|
||||
___________________________________________
|
||||
|
||||
|
||||
Advanced patterns
|
||||
**************************
|
||||
|
||||
To search for game properties listed in the :doc:`configuration_file` there are 3 available patterns:
|
||||
|
||||
.. csv-table::
|
||||
:header-rows: 1
|
||||
:class: config
|
||||
|
||||
Type,Description,Example,Example result
|
||||
"<key>=<value>", check exact value of ``<key>``, ``gameid=reversion2``, games with exact gameid "reversion2"
|
||||
"<key>:<value>", search substring at ``<key>``, ``description::``, games with ":" substring at description
|
||||
"<key>~<value>", match wildcard against ``<key>``, ``path~D:\\games\\*``, games located at Windows folder D:\\Games\\
|
||||
|
||||
|
||||
.. note::
|
||||
|
||||
Escape the ``\`` character used in Windows paths by using ``\\`` when using wildcards.
|
||||
|
||||
|
||||
Available configuration keys
|
||||
*******************************************
|
||||
|
||||
You can use any :ref:`configuration key <configuration_keys>` as a ``<key>`` part of the search pattern.
|
||||
|
||||
Here are some more examples:
|
||||
|
||||
- ``show_fps=true`` - games with "Show FPS" option set to true
|
||||
- ``extra~?*`` - games with non-empty extra part of the description
|
||||
- ``guioptions:noLang`` - games without displayed language
|
||||
- ``keymap_engine-default_LCLK:MOUSE_RIGHT`` - games with right mouse button remapped to left mouse button
|
||||
|
||||
Abbreviating configuration keys
|
||||
*******************************************
|
||||
|
||||
To abbreviate the 6 most common configuration keys, just type any prefix instead of full strings for those keys:
|
||||
|
||||
.. csv-table::
|
||||
:header-rows: 1
|
||||
:class: config
|
||||
|
||||
Full key,Description,Examples
|
||||
``description``, game description as displayed on the game list,"
|
||||
|
||||
- ``d:monkey``
|
||||
- ``desc:monkey``
|
||||
- ``descr:monkey``
|
||||
- ``description:monkey``"
|
||||
``engineid``, internal ID of the game engine,"
|
||||
|
||||
- ``e:ags``
|
||||
- ``engine:monkey``
|
||||
- ``engineid:monkey``"
|
||||
``gameid``, internal ID of the game,"
|
||||
|
||||
- ``g:monkey``
|
||||
- ``game:monkey``
|
||||
- ``gameid:monkey``"
|
||||
``language``, internal ID of the language (usually 2 letter code like "de"/"en"/"fr"/"jp","
|
||||
|
||||
- ``l=en``
|
||||
- ``lang=en``
|
||||
- ``language=en``"
|
||||
``path``, Filesystem path for the game,"
|
||||
|
||||
- ``p~D:*``
|
||||
- ``path~D:*``"
|
||||
``platform``, internal ID of the platform,"
|
||||
|
||||
- ``pl~windows``
|
||||
- ``platform~windows``"
|
||||
|
||||
.. note::
|
||||
|
||||
The ``platform`` key can't be abbreviated to ``p``, since ``p`` is already used for ``path``.
|
||||
|
||||
|
||||
Inverting the search pattern
|
||||
___________________________________________
|
||||
|
||||
To invert the search result, prefix the search pattern with the`!` character. For example:
|
||||
|
||||
- ``!GOG`` - games that don't contain "GOG" substring in description
|
||||
- ``!lang=ru`` - games not in Russian language
|
||||
- ``!p:demo`` - games that don't have "demo" substring in game path
|
||||
- ``!engine~sword#`` - games not made with "sword1" and "sword2" engines (but "sword25" is fine)
|
||||
|
||||
|
||||
How do the search patterns work together?
|
||||
===========================================
|
||||
|
||||
If you have provided several search patterns, only games that match all of them are displayed.
|
||||
|
||||
The matches are independent and not ordered, which means that if you search for ``Open Quest``, you get all the games with words "Open" and "Quest" in description. The results would contain games like "Open Quest (Windows/English)" and "Police Quest IV: Open Season (DOS/Demo)".
|
||||
|
||||
Here are some more examples of complex requests:
|
||||
|
||||
- ``engine=ags path:steamapps !extra:Steam`` - AGS games at your /SteamApps/ folder, but not marked as Steam game at "extra"
|
||||
- ``e=wintermute l=`` - Wintermute games with empty "language" property
|
||||
- ``pl:dos lang=he desc~a*`` - Hebrew games for DOS with description starting with letter "A"
|
||||
94
doc/docportal/conf.py
Normal file
94
doc/docportal/conf.py
Normal file
@@ -0,0 +1,94 @@
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file only contains a selection of the most common options. For a full
|
||||
# list see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'ScummVM Documentation'
|
||||
copyright = '2020-2026, ScummVM'
|
||||
author = 'ScummVM'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
|
||||
extensions = [
|
||||
|
||||
"sphinx_rtd_theme",
|
||||
"sphinx_design",
|
||||
"sphinx_mdinclude",
|
||||
]
|
||||
souce_suffix = ['.rst','.md']
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'contribute/*.rst']
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
|
||||
html_logo = 'logo.png'
|
||||
|
||||
html_theme_options = {
|
||||
'logo_only': True,
|
||||
'style_external_links': True,
|
||||
}
|
||||
|
||||
|
||||
html_static_path = ['_static']
|
||||
|
||||
html_js_files = ['version.js']
|
||||
|
||||
html_extra_path = ['images/donate/ppdonate.png','images/donate/ZOOM_button_small.png']
|
||||
html_favicon = 'scummvm.ico'
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
|
||||
html_css_files = ["https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"]
|
||||
|
||||
def setup(app):
|
||||
app.add_css_file("custom.css")
|
||||
|
||||
master_doc = 'index'
|
||||
html_sidebars = {'**': ['localtoc.html']}
|
||||
|
||||
#Options for LaTex Output
|
||||
|
||||
latex_elements = {
|
||||
'extraclassoptions': 'openany,oneside',
|
||||
'fncychap': ' ',
|
||||
'pointsize': '11pt',
|
||||
'preamble': r'''
|
||||
\usepackage{charter}
|
||||
\usepackage[defaultsans]{lato}
|
||||
\usepackage{inconsolata}
|
||||
''',
|
||||
|
||||
}
|
||||
75
doc/docportal/contribute/platform_template.rst
Normal file
75
doc/docportal/contribute/platform_template.rst
Normal file
@@ -0,0 +1,75 @@
|
||||
=============================
|
||||
Title
|
||||
=============================
|
||||
|
||||
What you'll need
|
||||
===================
|
||||
|
||||
- Bullet points listing all prerequisites.
|
||||
|
||||
Install ScummVM
|
||||
===============================
|
||||
|
||||
Detailed download and install instructions.
|
||||
|
||||
Transferring game files
|
||||
=========================
|
||||
|
||||
Detailed instructions for getting game files onto the device.
|
||||
|
||||
"See :doc:`../use_scummvm/game_files` for more information about game file requirements."
|
||||
|
||||
Controls
|
||||
=================
|
||||
|
||||
"Controls can also be manually configured in the :doc:`Keymaps tab <../settings/keymaps>`."
|
||||
|
||||
"See the :doc:`../using_scummvm/keyboard_shortcuts` page for common keyboard shortcuts."
|
||||
|
||||
Default control mapping
|
||||
*************************
|
||||
|
||||
Use a CSV-list table. Set widths to equal 100%. Choose how many header rows you have.
|
||||
|
||||
It's easiest to use Google Sheets or Excel to export a spreadsheet as a CSV file.
|
||||
|
||||
.. csv-table::
|
||||
:widths: 30 30 40
|
||||
:header-rows: 1
|
||||
|
||||
Button, Action, Description
|
||||
Left stick, Move pointer,
|
||||
|
||||
|
||||
|
||||
[Other control information] - Optional
|
||||
*****************************************
|
||||
|
||||
Paths
|
||||
=======
|
||||
|
||||
Saved games
|
||||
*******************
|
||||
|
||||
``path/to/savedgames``
|
||||
|
||||
Configuration file
|
||||
**************************
|
||||
``path/to/configurationfile``
|
||||
|
||||
|
||||
Settings
|
||||
==========
|
||||
|
||||
"For more information, see the Settings section of the documentation. Only platform-specific differences are listed here."
|
||||
|
||||
[Applicable tab] e.g. Audio
|
||||
*******************************
|
||||
|
||||
|
||||
|
||||
|
||||
Known issues
|
||||
==============
|
||||
|
||||
Anything specific to this port that is a known issue.
|
||||
35
doc/docportal/contribute/settings_template.rst
Normal file
35
doc/docportal/contribute/settings_template.rst
Normal file
@@ -0,0 +1,35 @@
|
||||
=====================
|
||||
Name of settings tab
|
||||
=====================
|
||||
|
||||
Short description of what is on the tab, and why you would use settings on this tab.
|
||||
|
||||
"**To change settings globally:**
|
||||
|
||||
From the Launcher, select **Options**. The **xxxx** tab is the first tab shown.
|
||||
|
||||
**To change settings for a specific game:**
|
||||
|
||||
Highlight the game in the games list, select **Edit Game** then select the **xxxx** tab."
|
||||
|
||||
.. figure:: ../images/settings/screenshotoftab.png
|
||||
|
||||
The xxxx tab in the global settings
|
||||
|
||||
"All settings can also be changed in the :doc:`../advanced_topics/configuration_file`. The configuration key is listed in italics after each setting description."
|
||||
|
||||
,,,,,,,,,,,,,,
|
||||
|
||||
.. _refforconfigurationfile:
|
||||
|
||||
Option label
|
||||
Description of option.
|
||||
|
||||
*config_file_key*
|
||||
|
||||
.. _refforconfigurationfile:
|
||||
|
||||
Option label
|
||||
Description of option.
|
||||
|
||||
*config_file_key*
|
||||
20
doc/docportal/help/contact.rst
Normal file
20
doc/docportal/help/contact.rst
Normal file
@@ -0,0 +1,20 @@
|
||||
|
||||
==============
|
||||
Contact us
|
||||
==============
|
||||
|
||||
There are a few ways to become a part of the ScummVM community:
|
||||
|
||||
- Chat with us on `Discord <https://discord.com/invite/4cDsMNtcpG>`_ or the `IRC Channel <irc://irc.libera.chat/scummvm?key=scummvm>`_ . It's a great place to hang out with developers and other ScummVM users.
|
||||
|
||||
- Post on the `ScummVM Forum <https://forums.scummvm.org/>`_ . We have several forums; the `Help and Support forum <https://forums.scummvm.org/viewforum.php?f=2>`_ if you need help while using ScummVM, the `General discussion forum <https://forums.scummvm.org/viewforum.php?f=1>`_ for all general questions, and `The Junkyard <https://forums.scummvm.org/viewforum.php?f=8>`_ for almost everything else! We also have some platform-specific forums, in case you have a specific question. Make sure to read the `Forum Rules <https://forums.scummvm.org/viewtopic.php?t=17>`_ before posting.
|
||||
|
||||
- There are three ScummVM mailing lists, which you can join `here <https://lists.scummvm.org/>`_.
|
||||
|
||||
- If you find a bug, :doc:`report_bugs`.
|
||||
|
||||
- Feature requests can be made to our `Feature request tracker <https://bugs.scummvm.org/report/11>`_.
|
||||
|
||||
- If you have made modifications to the ScummVM source code and would like to see them merged into the main code, open a Pull Request on our `GitHub page <https://github.com/scummvm/scummvm/pulls>`_.
|
||||
|
||||
We look forward to meeting you!
|
||||
2954
doc/docportal/help/credits.rst
Normal file
2954
doc/docportal/help/credits.rst
Normal file
File diff suppressed because it is too large
Load Diff
251
doc/docportal/help/faq.rst
Normal file
251
doc/docportal/help/faq.rst
Normal file
@@ -0,0 +1,251 @@
|
||||
|
||||
============================
|
||||
Frequently Asked Questions
|
||||
============================
|
||||
|
||||
.. contents::
|
||||
|
||||
|
||||
1. General
|
||||
==================
|
||||
|
||||
1.1 About
|
||||
***********
|
||||
|
||||
1.1.1. Is ScummVM an emulator?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
No! ScummVM actually replaces the original executable file that shipped with the game. This means that your games can run on platforms they were never designed for! For an in-depth look at how ScummVM works, see the `About ScummVM <https://wiki.scummvm.org/index.php?title=About>`_ wiki page.
|
||||
|
||||
1.1.2. Is ScummVM free?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
ScummVM is released under the GPL (General Public License), so it's more than just free. ScummVM source code is available for you to do whatever you want with it, but if you make modifications and redistribute your work, you must make your source code available.
|
||||
|
||||
The ScummVM team would be delighted if you send them your modifications, so that the changes you've made can be merged into the main source code. See the `Developer Central <https://wiki.scummvm.org/index.php/Developer_Central>`_ wiki page for contributing guidelines.
|
||||
|
||||
1.1.3. Can I create my own games using ScummVM?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
A few engines supported by ScummVM have publicly available authoring tools. See this `wiki page <https://wiki.scummvm.org/index.php/HOWTO-Fangames>`_ for more information.
|
||||
|
||||
1.1.4. I want to compile ScummVM myself from the source code. How do I do this?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
See the `Compiling ScummVM wiki page <https://wiki.scummvm.org/index.php?title=Compiling_ScummVM>`_.
|
||||
|
||||
1.1.5 Can I run my pirated/abandonware/warez/unauthorized copies of a game?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Our project has a strict no-piracy policy. Hence, we do not provide any support when it becomes evident that you did not obtain your game copy legally.
|
||||
|
||||
We outlined a more detailed response on `our Wiki <https://wiki.scummvm.org/index.php?title=Copyright_FAQ>`_.
|
||||
|
||||
And no, "abandonware" is not a proper legal concept in any country. Just like how it's not legal to copy a book under copyright because it is out-of-print, it is not legal to copy a game under copyright because the company is no longer selling it.
|
||||
|
||||
In addition, some versions of games downloaded from random websites may have been modified to include malware that could compromise your computer.
|
||||
|
||||
1.2 Using ScummVM
|
||||
**********************
|
||||
|
||||
1.2.1. How do I install ScummVM onto my device?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
See :ref:`firststeps`.
|
||||
|
||||
1.2.2. How do I get game files onto my device?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
For general guidance, see the :doc:`../use_scummvm/game_files` page. For platform-specific information, see the relevant page in the **OTHER PLATFORMS** section of the sidebar.
|
||||
|
||||
ScummVM has cloud and LAN functionality to simplify the file transfer process. For more information, see :doc:`../use_scummvm/connect_cloud` and :doc:`../use_scummvm/LAN`.
|
||||
|
||||
1.2.3. On what platform(s) will ScummVM run?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
See our `Platforms <https://wiki.scummvm.org/index.php/Platforms>`_ wiki page for a full list. We have guides available for many of the supported platforms, see the relevant page in the **OTHER PLATFORMS** section of the sidebar.
|
||||
|
||||
1.2.4. Where do I find the configuration file?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
See :doc:`../advanced_topics/configuration_file`.
|
||||
|
||||
|
||||
1.3 Playing games
|
||||
********************
|
||||
|
||||
1.3.1. Can I only play LucasArts SCUMM games?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Although the ScummVM project started by reverse-engineering just the LucasArts SCUMM games, the project now supports hundreds of games from many different game developers. See the full list of supported games `here <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_. There is a caveat; not all supported games are playable on all platforms. Often this is because the game is simply too CPU intensive for the device, or because of some other hardware or software limitation. If a game is not available on a platform, you will not be able to add it to ScummVM.
|
||||
|
||||
.. _getgames:
|
||||
|
||||
1.3.2. Where do I get the games?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
See the ScummVM `Where to get the games <https://wiki.scummvm.org/index.php/Where_to_get_the_games>`_ wiki page.
|
||||
|
||||
|
||||
.. _installgames:
|
||||
|
||||
1.3.3. How do I install games from my floppy discs/CDs?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Generally speaking, you do not need to install the games. You only need to point ScummVM to the game files contained on these discs. For a complete guide, see :doc:`../use_scummvm/game_files`.
|
||||
|
||||
1.3.4. Do I need the original game discs?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Ideally yes, however we know that a lot of people don't! If you do not have any hard copy games, there are some digital options available, including some games that have been released as freeware. See the ScummVM `Where to get the games <https://wiki.scummvm.org/index.php/Where_to_get_the_games>`_ wiki page.
|
||||
|
||||
1.3.5. How do I get the Macintosh versions of games to work?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
See :doc:`../use_scummvm/mac_game_files`
|
||||
|
||||
1.3.6. How do I know if I can play my game using ScummVM?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
The best place to check is the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on the ScummVM website. You can also have a look at the full list of supported games `here <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_.
|
||||
|
||||
1.3.7. I have saved games from when I played the original game - can I use these with ScummVM?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
This is only supported for a select number of games. See the `wiki <https://wiki.scummvm.org/index.php/Category:Supported_Games>`_ page for the game you are playing.
|
||||
|
||||
1.3.8. Where are my games saved?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
See :doc:`../use_scummvm/save_load_games`.
|
||||
|
||||
1.3.9. How do I launch a game straight from the game folder?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Games must be added to and started from :doc:`the ScummVM Launcher <../use_scummvm/the_launcher>`; they cannot be started directly from the game files. See :doc:`../use_scummvm/add_play_games`.
|
||||
|
||||
1.3.10. What are the in-game keyboard shortcuts?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
A list of default shortcuts can be found on the :doc:`../use_scummvm/keyboard_shortcuts` page. From version 2.2.0 you can also create custom shortcuts on the :doc:`../settings/keymaps` tab.
|
||||
|
||||
1.3.11. What is the ScummVM policy on fanmade mods (unofficial subtitles & translations, upscaled graphics & audio, etc.)?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Some engines support fan mods, but ScummVM does not endorse any mods that infringe the copyright of the original rights holders. This includes graphic and audio "upscales" that redistribute modified game assets without permission.
|
||||
|
||||
Several mods that exist with the permission of the original rights holders can be found `on our website <https://www.scummvm.org/links/>`_.
|
||||
|
||||
2. Troubleshooting
|
||||
===================
|
||||
|
||||
2.1. General
|
||||
**************
|
||||
|
||||
2.1.1. ScummVM crashes, but the console window disappears too quickly to see the error message.
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
If you are using a computer, you can run ScummVM from the :doc:`command line <../advanced_topics/command_line>`. By doing this, error messages remain visible even after ScummVM exits.
|
||||
|
||||
You can also find error messages in the ScummVM log file. See :ref:`logfile`.
|
||||
|
||||
2.1.2. I get "Failed to save game state to file: ". What's going on?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Check that your :ref:`save path <savepath>` is a writeable directory.
|
||||
|
||||
2.1.3. I think I found a bug. What do I do?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
See :doc:`report_bugs`.
|
||||
|
||||
2.2 Games
|
||||
**********
|
||||
|
||||
2.2.1. Help! My game won't run!
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
1. Make sure your game is supported. Check the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on the ScummVM website, and the `Platform Overview <https://wiki.scummvm.org/index.php?title=Platforms/Overview>`_ page on the wiki.
|
||||
|
||||
2. Check that you have all the required datafiles. See the :doc:`../use_scummvm/game_files` page.
|
||||
|
||||
3. Ask for advice on the ScummVM forums or on Discord. See the :doc:`contact` page.
|
||||
|
||||
4. If you think the game should run, and it doesn't, report it as a bug. See :doc:`report_bugs`.
|
||||
|
||||
2.2.2. I installed my game but ScummVM can't find it... What do I do?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Installing the game does not necessarily provide ScummVM with the files it needs. In most cases you will need to copy the files from the disc into a folder ScummVM can access. See :doc:`../use_scummvm/game_files`.
|
||||
|
||||
2.2.3. Why are the subtitles in my non-English game messed up?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
You need to specify the correct :ref:`language <lang>` in the game-specific settings.
|
||||
|
||||
2.2.4. My game crashes at a specific point. What do I do?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
First, check the `Compatibility page <https://www.scummvm.org/compatibility/>`_ on the ScummVM website to see if the game has any known issues. If not, and the crash can be reproduced, report the crash as a bug. See :doc:`report_bugs`.
|
||||
|
||||
2.2.5. I downloaded the Broken Sword packs from your website but the game won't run.
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
These are not full games, they are re-encoded cutscene (video) packs. To run the games you still need the original disks. See the `Broken Sword wiki page <https://wiki.scummvm.org/index.php/Broken_Sword_1#Cutscenes>`_.
|
||||
|
||||
2.3 Audio
|
||||
***********
|
||||
|
||||
.. _nosound:
|
||||
|
||||
2.3.1 Help! There's no sound!
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Sometimes it's worth checking the obvious.
|
||||
|
||||
1. Are your speakers on? Are your headphones properly connected?
|
||||
2. Try playing an audio clip from another source to see if you have sound in general.
|
||||
3. If you narrow it down to an issue with ScummVM, check the :doc:`audio settings <../settings/audio>`. ScummVM falls back on an audio setting that works, but if for some reason it doesn't, you might need to change the settings yourself. A safe bet is usually to set the **Preferred device** to **<default>** and allow ScummVM to choose for you.
|
||||
|
||||
2.3.2 Help! There's no sound on my iPhone/iPad!
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
ScummVM will not play any sound if your device is in Silent Mode. If this is not the problem, see :ref:`nosound`.
|
||||
|
||||
2.3.3 I have a "talkie" version of a LucasArts game but I can't hear the voices. What's the problem?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
The original games shipped with an uncompressed voice file (``MONSTER.SOU``). If you have compressed this file to an mp3 file (``MONSTER.SO3``), an Ogg Vorbis file (``MONSTER.SOG``), or a FLAC file (``MONSTER.SOF``), make sure that the ScummVM you're using has support for those formats.
|
||||
|
||||
2.3.4 The audio is really glitchy. What can I do?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
There are a few things you can try:
|
||||
|
||||
- Try to increase the :ref:`audio buffer size <buffer>` in the configuration file.
|
||||
- If you are using the :ref:`MT-32 emulator <MT-32>`, your CPU might not have the processing power to keep up. In this case, you might have some success with running an external MT-32 emulator (Munt), as described in `this forum post <https://forums.scummvm.org/viewtopic.php?f=2&t=15251>`_, provided your platform supports it.
|
||||
- If you are using :ref:`FluidSynth <FS>`, in particular with a large Soundfont, your CPU might not have the processing power to keep up. Try selecting a different :ref:`Preferred device <device>`.
|
||||
- If you are using the :ref:`AdLib <adlib>` emulator, try selecting the least CPU-intensive option; MAME.
|
||||
|
||||
2.3.5. I have a CD version of a game, how do I get the sound to work without running the game from the CD?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
See :ref:`cdaudio`.
|
||||
|
||||
2.4 Graphics
|
||||
**************
|
||||
|
||||
2.4.1. There are so many options... How do I know what to pick?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Start by checking out our :doc:`../advanced_topics/understand_graphics` page. It has comprehensive information on how all this stuff works.
|
||||
|
||||
2.4.2. Can I just make the image larger (for example, 1 pixel becomes 4 pixels) without any smoothing or antialiasing?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Yes. Using the **OpenGL** graphics mode or the **SDL Surface** graphics mode with **Normal** scaler in conjunction with pixel-perfect stretch will result in a larger image without any smoothing. The **Normal** scaler also has options to scale by **2x**, **3x**, or **4x**. Also check that **Filter graphics** is not enabled. If you want to use aspect ratio correction, it is recommended to use the **OpenGL** graphics mode with the **Even pixels scaling** stretch mode.
|
||||
|
||||
|
||||
2.4.3. The game colors are messed up, how do I fix them?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Ensure the correct game platform has been detected. For example, with Amiga game files, check that the :ref:`platform <platform>` is set to Amiga.
|
||||
|
||||
3. Features
|
||||
================
|
||||
|
||||
3.1 Requests
|
||||
*****************
|
||||
|
||||
3.1.1. When will you add support for ZIP archives?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
We won't. There are two main reasons: firstly, we believe that it would ease illegal distribution of games, and secondly, we already support compression of sound and speech to reduce file sizes.
|
||||
|
||||
3.1.2. Will ScummVM support other games in the future?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
That depends on a few factors. Firstly, it has to fit within the scope of ScummVM. Secondly, there has to be a developer who is interested and willing to carry out the work.
|
||||
|
||||
ScummVM developers are all volunteers who work on ScummVM in their spare time, solely for fun, and not for profit. Reverse engineering a completely new game without the source code is a long and difficult process. Even with source it can be tedious and time consuming.
|
||||
|
||||
Unless you work for a company interested in providing us with source code for one of their classic titles, or want to do the work yourself, please do not ask us to add support for a new game.
|
||||
|
||||
3.1.3. Will ScummVM be officially released for consoles? (eg PlayStation, Xbox, Switch, ...)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Unfortunately no, because of licensing issues. There are two important facts at play here:
|
||||
|
||||
1. Each console has an associated developer kit (including platform documentation and an SDK) that developers must use to implement games.
|
||||
That developer kit is provided to developers under strict non-disclosure agreements.
|
||||
2. By contrast, the ScummVM source code is licensed under the GPL v3 (see section 1.1.2 of this FAQ).
|
||||
The GPL requires that any code integrated with a release of ScummVM (the aforementioned SDK) be made available upon request.
|
||||
|
||||
From these facts it follows that anyone releasing a port of ScummVM to a console must either release parts of the SDK upon request (and breach the developer kit NDA) or refuse to release the modified source code and NDA'd parts of the developer kit (and breach the GPL).
|
||||
|
||||
Note that "homebrew" SDKs are not affected by this problem as they themselves are released under a free license.
|
||||
6
doc/docportal/help/release.rst
Normal file
6
doc/docportal/help/release.rst
Normal file
@@ -0,0 +1,6 @@
|
||||
---------------
|
||||
Release notes
|
||||
---------------
|
||||
|
||||
.. mdinclude:: ../../../NEWS.md
|
||||
|
||||
42
doc/docportal/help/report_bugs.rst
Normal file
42
doc/docportal/help/report_bugs.rst
Normal file
@@ -0,0 +1,42 @@
|
||||
|
||||
=======================
|
||||
Report a bug
|
||||
=======================
|
||||
|
||||
To report a bug, go to the ScummVM `Issue Tracker <https://bugs.scummvm.org/>`_ and log in with your GitHub account.
|
||||
|
||||
Please make sure the bug is reproducible, and still occurs in the latest git/Daily build version. Also check the `compatibility list <https://www.scummvm.org/compatibility/>`_ for that game, to ensure the issue is not already known. Please do not report bugs for games that are not listed as completable on the `Supported Games <https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ wiki page, or on the compatibility list. We already know those games have bugs!
|
||||
|
||||
Please include the following information in the bug report:
|
||||
|
||||
- ScummVM version (test the latest git/Daily build)
|
||||
- Bug details, including instructions for how to reproduce the bug. If possible, include log files, screenshots, and any other relevant information.
|
||||
- Game language
|
||||
- Game version (for example, talkie or floppy)
|
||||
- Platform and Compiler (for example, Win32, Linux or FreeBSD)
|
||||
- An attached saved game, if possible.
|
||||
- If this bug only occurred recently, include the last version without the bug, and the first version with the bug. That way we can fix it quicker by looking at the changes made.
|
||||
|
||||
Finally, please report each issue separately; do not file multiple issues on the same ticket. It is difficult to track the status of each individual bug when they aren't on their own tickets.
|
||||
|
||||
|
||||
.. _logfile:
|
||||
|
||||
The ScummVM log file
|
||||
=====================
|
||||
|
||||
To help you report a bug, you can find error messages in the ScummVM log file. The location of this file varies depending on your operating system.
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: Windows
|
||||
|
||||
``%APPDATA%\ScummVM\Logs\scummvm.log``
|
||||
|
||||
.. tab-item:: macOS
|
||||
|
||||
``~/Library/Logs/scummvm.log``
|
||||
|
||||
.. tab-item:: Linux
|
||||
|
||||
We use the XDG Base Directory Specification, so by default the file will be ``~/.cache/scummvm/logs/scummvm.log`` but its location might vary depending on the value of the ``XDG_CACHE_HOME`` environment variable.
|
||||
BIN
doc/docportal/images/3ds/config.png
Normal file
BIN
doc/docportal/images/3ds/config.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
BIN
doc/docportal/images/Launcher/add_game.png
Normal file
BIN
doc/docportal/images/Launcher/add_game.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 186 KiB |
BIN
doc/docportal/images/Launcher/choose_game_directory.png
Normal file
BIN
doc/docportal/images/Launcher/choose_game_directory.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 165 KiB |
BIN
doc/docportal/images/Launcher/choose_version.png
Normal file
BIN
doc/docportal/images/Launcher/choose_version.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 38 KiB |
BIN
doc/docportal/images/Launcher/game_settings.png
Normal file
BIN
doc/docportal/images/Launcher/game_settings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 185 KiB |
BIN
doc/docportal/images/Launcher/gmm.png
Normal file
BIN
doc/docportal/images/Launcher/gmm.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 328 KiB |
BIN
doc/docportal/images/Launcher/gmm_options_audio.png
Normal file
BIN
doc/docportal/images/Launcher/gmm_options_audio.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 210 KiB |
BIN
doc/docportal/images/Launcher/gmm_options_keymaps.png
Normal file
BIN
doc/docportal/images/Launcher/gmm_options_keymaps.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 224 KiB |
BIN
doc/docportal/images/Launcher/gmm_save.png
Normal file
BIN
doc/docportal/images/Launcher/gmm_save.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 234 KiB |
BIN
doc/docportal/images/Launcher/launcher_grid.png
Normal file
BIN
doc/docportal/images/Launcher/launcher_grid.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 398 KiB |
BIN
doc/docportal/images/Launcher/launcher_group.png
Normal file
BIN
doc/docportal/images/Launcher/launcher_group.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 182 KiB |
BIN
doc/docportal/images/Launcher/launcher_group_grid.png
Normal file
BIN
doc/docportal/images/Launcher/launcher_group_grid.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 278 KiB |
BIN
doc/docportal/images/Launcher/launcher_list.png
Normal file
BIN
doc/docportal/images/Launcher/launcher_list.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 181 KiB |
BIN
doc/docportal/images/Launcher/launcher_list_group.png
Normal file
BIN
doc/docportal/images/Launcher/launcher_list_group.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 194 KiB |
BIN
doc/docportal/images/Launcher/launcher_popup.png
Normal file
BIN
doc/docportal/images/Launcher/launcher_popup.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 390 KiB |
BIN
doc/docportal/images/Launcher/load_game_grid.png
Normal file
BIN
doc/docportal/images/Launcher/load_game_grid.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 139 KiB |
BIN
doc/docportal/images/Launcher/load_game_list.png
Normal file
BIN
doc/docportal/images/Launcher/load_game_list.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 163 KiB |
BIN
doc/docportal/images/Launcher/mass_add.png
Normal file
BIN
doc/docportal/images/Launcher/mass_add.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 185 KiB |
BIN
doc/docportal/images/Launcher/mass_add_confirm.png
Normal file
BIN
doc/docportal/images/Launcher/mass_add_confirm.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 196 KiB |
BIN
doc/docportal/images/Launcher/mass_add_success.png
Normal file
BIN
doc/docportal/images/Launcher/mass_add_success.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 190 KiB |
BIN
doc/docportal/images/Launcher/save_game_grid.png
Normal file
BIN
doc/docportal/images/Launcher/save_game_grid.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 108 KiB |
BIN
doc/docportal/images/Launcher/save_game_grid_desc.png
Normal file
BIN
doc/docportal/images/Launcher/save_game_grid_desc.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 236 KiB |
BIN
doc/docportal/images/Launcher/save_game_list.png
Normal file
BIN
doc/docportal/images/Launcher/save_game_list.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 128 KiB |
BIN
doc/docportal/images/Launcher/start_game.png
Normal file
BIN
doc/docportal/images/Launcher/start_game.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 179 KiB |
BIN
doc/docportal/images/Launcher/start_game_cli.jpg
Normal file
BIN
doc/docportal/images/Launcher/start_game_cli.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 569 KiB |
BIN
doc/docportal/images/amigaos_4/installer.png
Normal file
BIN
doc/docportal/images/amigaos_4/installer.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
BIN
doc/docportal/images/android/browser-folder-in-list.png
Normal file
BIN
doc/docportal/images/android/browser-folder-in-list.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 665 KiB |
BIN
doc/docportal/images/android/browser-root.png
Normal file
BIN
doc/docportal/images/android/browser-root.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 649 KiB |
BIN
doc/docportal/images/android/fs-folder.png
Normal file
BIN
doc/docportal/images/android/fs-folder.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 139 KiB |
BIN
doc/docportal/images/android/fs-permission.png
Normal file
BIN
doc/docportal/images/android/fs-permission.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 251 KiB |
BIN
doc/docportal/images/android/fs-root.png
Normal file
BIN
doc/docportal/images/android/fs-root.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 218 KiB |
BIN
doc/docportal/images/android/gui-remove-list.png
Normal file
BIN
doc/docportal/images/android/gui-remove-list.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 102 KiB |
BIN
doc/docportal/images/android/gui-remove-permissions.png
Normal file
BIN
doc/docportal/images/android/gui-remove-permissions.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 145 KiB |
BIN
doc/docportal/images/cloud_and_lan/LAN.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/LAN.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 187 KiB |
BIN
doc/docportal/images/cloud_and_lan/LAN_server.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/LAN_server.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 171 KiB |
BIN
doc/docportal/images/cloud_and_lan/LAN_server_new.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/LAN_server_new.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 186 KiB |
BIN
doc/docportal/images/cloud_and_lan/LAN_server_running.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/LAN_server_running.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 187 KiB |
BIN
doc/docportal/images/cloud_and_lan/LAN_server_upload.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/LAN_server_upload.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 193 KiB |
BIN
doc/docportal/images/cloud_and_lan/cloud_enable.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/cloud_enable.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 206 KiB |
BIN
doc/docportal/images/cloud_and_lan/cloud_storage.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/cloud_storage.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 187 KiB |
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_browser.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_browser.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 88 KiB |
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_manual.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_manual.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_manual_1.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_manual_1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_manual_2.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_manual_2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 98 KiB |
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_manual_3.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_manual_3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 115 KiB |
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_manual_4.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_manual_4.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_quick.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_quick.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_quick_1.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_quick_1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_quick_2.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_quick_2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_success.png
Normal file
BIN
doc/docportal/images/cloud_and_lan/cloud_wizard_success.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
BIN
doc/docportal/images/donate/GOG_button_small.png
Normal file
BIN
doc/docportal/images/donate/GOG_button_small.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.8 KiB |
BIN
doc/docportal/images/donate/ZOOM_button_small.png
Normal file
BIN
doc/docportal/images/donate/ZOOM_button_small.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.6 KiB |
BIN
doc/docportal/images/donate/ppdonate.png
Normal file
BIN
doc/docportal/images/donate/ppdonate.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
BIN
doc/docportal/images/dreamcast/bootdreams.png
Normal file
BIN
doc/docportal/images/dreamcast/bootdreams.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
BIN
doc/docportal/images/dumper/browser_dumper.png
Normal file
BIN
doc/docportal/images/dumper/browser_dumper.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 83 KiB |
BIN
doc/docportal/images/graphics/aspect_ratio/aspect_ratio.png
Normal file
BIN
doc/docportal/images/graphics/aspect_ratio/aspect_ratio.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
BIN
doc/docportal/images/graphics/aspect_ratio/no_aspect_ratio.png
Normal file
BIN
doc/docportal/images/graphics/aspect_ratio/no_aspect_ratio.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 19 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/1x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/1x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 31 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/2x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/3x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/3x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/4x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/4x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/advmame2x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/advmame2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/advmame3x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/advmame3x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 43 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/advmame4x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/advmame4x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 57 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/dotmatrix2x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/dotmatrix2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/edge2x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/edge2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/edge3x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/edge3x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/hq2x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/hq2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/hq3x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/hq3x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 69 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/misc.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/misc.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/pm2x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/pm2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/sai2x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/sai2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/supereagle2x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/supereagle2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 48 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/supersai2x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/supersai2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
BIN
doc/docportal/images/graphics/graphics_mode/tv2x.png
Normal file
BIN
doc/docportal/images/graphics/graphics_mode/tv2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
BIN
doc/docportal/images/graphics/render_mode/amiga.png
Normal file
BIN
doc/docportal/images/graphics/render_mode/amiga.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
BIN
doc/docportal/images/graphics/render_mode/cga.png
Normal file
BIN
doc/docportal/images/graphics/render_mode/cga.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user