[Scummvm-git-logs] scummvm master -> e2f730074d5c0af2172ccfadd78beb66e2c72652
cadihowley
noreply at scummvm.org
Tue Jan 17 19:33:56 UTC 2023
This automated email contains information about 12 new commits which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .
Summary:
32249765ed DOCS: Fixes heading
00a84d19f5 DOCS: Fixes release notes section
da0f1f2194 DOCS: updates engine-specific Game tab options
69d1603af5 DOCS: updates requirements file
871b2933e7 DOCS: adds GUI page and updates Misc settings page
92a4311844 DOCS: updates Game page to include missing engines
f649920221 DOCS: Adds GUI tab to settings description
9ae5aceae5 DOCS: Adds information about shaders
de151ea3fd DOCS: Replaces test pattern screenshot
4305d57771 DOCS: Adds description of initial config file
ce288d0bbd DOCS: Updates command line options
e2f730074d DOCS: Fixes minor mistakes
Commit: 32249765ede955b698a930b2c4b18fdb86f69a2c
https://github.com/scummvm/scummvm/commit/32249765ede955b698a930b2c4b18fdb86f69a2c
Author: CadiH (cadihowley at gmail.com)
Date: 2023-01-18T06:33:47+11:00
Commit Message:
DOCS: Fixes heading
Changed paths:
doc/docportal/help/faq.rst
diff --git a/doc/docportal/help/faq.rst b/doc/docportal/help/faq.rst
index 8e319e1a023..cc59fd5d194 100644
--- a/doc/docportal/help/faq.rst
+++ b/doc/docportal/help/faq.rst
@@ -112,7 +112,7 @@ Games must be added to and started from :doc:`the ScummVM Launcher <../use_scumm
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/>`_.
Commit: 00a84d19f5c8079c7e4fe85f363f4c7f0fa2a2ad
https://github.com/scummvm/scummvm/commit/00a84d19f5c8079c7e4fe85f363f4c7f0fa2a2ad
Author: CadiH (cadihowley at gmail.com)
Date: 2023-01-18T06:33:47+11:00
Commit Message:
DOCS: Fixes release notes section
Changed paths:
doc/docportal/conf.py
diff --git a/doc/docportal/conf.py b/doc/docportal/conf.py
index 4673e1541d8..7d16f47f7e5 100644
--- a/doc/docportal/conf.py
+++ b/doc/docportal/conf.py
@@ -33,7 +33,8 @@ import sphinx_rtd_theme
extensions = [
"sphinx_rtd_theme",
- "sphinx_panels"
+ "sphinx_panels",
+ "sphinx_mdinclude"
]
extensions.append('sphinx_tabs.tabs')
souce_suffix = ['.rst','.md']
Commit: da0f1f219420bdbfff20ce88f1cc9127260cf6a2
https://github.com/scummvm/scummvm/commit/da0f1f219420bdbfff20ce88f1cc9127260cf6a2
Author: CadiH (cadihowley at gmail.com)
Date: 2023-01-18T06:33:47+11:00
Commit Message:
DOCS: updates engine-specific Game tab options
Changed paths:
doc/docportal/advanced_topics/configuration_file.rst
doc/docportal/settings/game.rst
diff --git a/doc/docportal/advanced_topics/configuration_file.rst b/doc/docportal/advanced_topics/configuration_file.rst
index 55875e97b1d..4ea36361eb1 100755
--- a/doc/docportal/advanced_topics/configuration_file.rst
+++ b/doc/docportal/advanced_topics/configuration_file.rst
@@ -116,10 +116,11 @@ There are many recognized configuration keys. In the table below, each key is ei
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:
+ ":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
@@ -129,12 +130,18 @@ There are many recognized configuration keys. In the table below, each key is ei
- 8192
- 16384
- 32768"
+ ":ref:`audio_override <aoverride>`",boolean,true,
+ ":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,
@@ -142,16 +149,27 @@ There are many recognized configuration keys. In the table below, each key is ei
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_dithering <dither>`",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,
@@ -162,9 +180,15 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`enable_tts <ttsenabled>`",boolean,false,
enable_unsupported_game_warning,boolean,true, Shows a warning when adding a game that is unsupported.
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,
@@ -185,8 +209,14 @@ There are many recognized configuration keys. In the table below, each key is ei
":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,
+ ":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:`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
@@ -211,7 +241,6 @@ There are many recognized configuration keys. In the table below, each key is ei
- sndio
- fluidsynth
- timidity"
- ":ref:`GraphicsDithering <gdither>`",boolean,true,
":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 entires exceeds the specified number, then scanning is skipped."
@@ -227,6 +256,7 @@ There are many recognized configuration keys. In the table below, each key is ei
":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.
@@ -277,11 +307,18 @@ There are many recognized configuration keys. In the table below, each key is ei
":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
@@ -322,13 +359,14 @@ There are many recognized configuration keys. In the table below, each key is ei
music_mute,boolean,false, Mutes the game music.
":ref:`music_volume <music>`",integer,192,"- 0-256 "
":ref:`mute <mute>`",boolean,false,
- ":ref:`native_fb01 <fb01>`",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
@@ -338,6 +376,8 @@ There are many recognized configuration keys. In the table below, each key is ei
- op2lpt
- op3lpt
- rwopl3 "
+ ":ref:`original_gui <originalgui>`",boolean,true,
+ ":ref:`original_menus <originalmenu>`",boolean,false,
":ref:`originalsaveload <osl>`",boolean,false,
":ref:`output_channels <outputchannels>`",integer,,"
Supported values are:
@@ -350,6 +390,7 @@ There are many recognized configuration keys. In the table below, each key is ei
- 11025
- 22050
- 44100"
+ ":ref:`palette_mods <palette>`",boolean,false,
":ref:`platform <platform>`",string,,
":ref:`portaits_on <portraits>`",boolean,true,
":ref:`prefer_digitalsfx <dsfx>`",boolean,true,
@@ -370,6 +411,8 @@ There are many recognized configuration keys. In the table below, each key is ei
- 2gs
- atari
- macintosh "
+ ":ref:`repeatwillihint <hint>`",boolean,,
+ ":ref:`restored <restored>`",boolean,true,
":ref:`retrowaveopl3_bus <adlib>`",string,,"
Specifies how the RetroWave OPL3 is connected:
@@ -383,12 +426,14 @@ There are many recognized configuration keys. In the table below, each key is ei
- 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,
@@ -398,9 +443,12 @@ There are many recognized configuration keys. In the table below, each key is ei
":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
@@ -413,17 +461,37 @@ There are many recognized configuration keys. In the table below, each key is ei
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:`window_style <style>`",boolean,true,
":ref:`windows_cursors <wincursors>`",boolean,false,
+ ":ref:`zip_mode <zip>`",boolean,,
diff --git a/doc/docportal/settings/game.rst b/doc/docportal/settings/game.rst
index ef35536f1e4..2d3ffe0154a 100644
--- a/doc/docportal/settings/game.rst
+++ b/doc/docportal/settings/game.rst
@@ -50,7 +50,7 @@ The Game tab also shows settings unique to the game engine for the selected game
To find out which engine powers your game, have a look at the ScummVM Supported Games `wiki page
<https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ or :ref:`group <group>` games by Engine in the Launcher.
-Engines: ADL_ | AGI_ | AGOS_ | BLADERUNNER_ | CGE_ | CINE_ | DRASCULA_ | DREAMWEB_ | HDB_ | HOPKINS_ | KYRA_ | LURE_ | MADS_ | MTROPOLIS_ | NEVERHOOD_ | SCI_ | SCUMM_ | SHERLOCK_ | SKY_ | SUPERNOVA_ | TOLTECS_ | WINTERMUTE_ | XEEN_ |
+Engines: ADL_ | AGI_ | AGOS_ | Bladerunner_ | Buried_ | CGE_ | CGE2_ | Chewy_ | Cine_ | Drascula_ | Dreamweb_ | FREESCAPE_ | Griffon_ | GrimE_ | HDB_ | Hopkins_ | Hypno_ | Kyra_ | Lure_ | MADE_ | MADS_ | MTROPOLIS_ | MYST3_ | Neverhood_ | SCI_ | SCUMM_ | Sherlock_ | Sky_ | Stark_ | Supernova_ | Sword2_ | Sword25_ | Toltecs_ | Trecision_ | Ultima_ | Wintermute_ | Xeen_ | ZVision_
@@ -145,6 +145,34 @@ Add speed menu
AGOS
******
+.. _opl3mode:
+
+AdLib OPL3 Mode
+ OPL3 features are used when AdLib is selected. Depending on the game, this prevents cut-off notes, adds extra notes or instruments, and/or adds stereo.
+
+ *opl3_mode*
+
+.. _dostempo:
+
+Use DOS version music tempos
+ Plays music using the tempo of the DOS version of the game (slower than the Windows version)
+
+ *dos_music_tempos*
+
+
+
+Use Windows version music tempos
+ Plays music using the tempo of the Windows version of the game (faster than the DOS version)
+
+ *dos_music_tempos*
+
+.. _prefer_digitalsfx:
+
+Prefer digital sound effects
+ Uses digital sound effects instead of synthesized ones.
+
+ *prefer_digitalsfx*
+
.. _fadeout:
Disable fade-out effects
@@ -156,7 +184,7 @@ Disable fade-out effects
.. _BLADERUNNER:
-BLADERUNNER
+Bladerunner
******************
.. _sitcom:
@@ -194,12 +222,41 @@ Disable McCoy's quick stamina drain
*disable_stamina_drain*
+.. _crawlsubs:
+
+Show subtitles during text crawl
+ During the intro cutscene, show subtitles during the text crawl.
+
+ *use_crawl_subs*
+
+.. _spanishcredits:
+
+Fix credits for voice actors
+ Updates the end credits with corrected credits for the Spanish voice actors.
+
+ *correct_spanish_credits*
+
+
,,,,,,,,
+.. _Buried:
+
+Buried
+********
+
+.. _allowskip:
+
+Skip support
+ Allows the user to skip cutscenes.
+
+ *skip_support*
+
+,,,,,,,,,,
+
.. _CGE:
CGE
-*******
+*********
.. _blind:
@@ -208,19 +265,58 @@ Color Blind Mode
*enable_color_blind*
+.. _tts:
+
+Enable Text to Speech
+ Uses TTS to read text in the game, if it is available.
+
+ *tts_enabled*
+
,,,,,,
-.. _CINE:
+.. _CGE2:
+
+CGE2
+******
+
+Color Blind Mode
+ Enables Color Blind Mode by default.
+
+ *enable_color_blind*
+
+.. _tts_objects:
+
+Enable Test to Speech for Objects and Options
+ Uses TTS to read descriptions, if TTS is available.
-CHEWY
+ *tts_enabled_objects*
+
+.. _tts_speech:
+
+Enable Test to Speech for Subtitles
+ Uses TTS to read subtitles, if TTS is available.
+
+ *tts_enabled_speech*
+
+,,,,,,,,,,,
+
+.. _Chewy:
+
+Chewy
*********
+.. _originalmenu:
+
Use original save/load screen
Uses the original save/load screens instead of the ScummVM screens.
*original_menus*
-CINE
+,,,,,,,,,,
+
+.. _Cine:
+
+Cine
*********
Use original save/load screen
@@ -237,9 +333,9 @@ Use transparent dialog boxes in 16 color scenes
,,,,,,,,,
-.. _DRASCULA:
+.. _Drascula:
-DRASCULA
+Drascula
*************
Use original save/load screens
@@ -249,9 +345,9 @@ Use original save/load screens
,,,,,,,,,,
-.. _DREAMWEB:
+.. _Dreamweb:
-DREAMWEB
+Dreamweb
**********
Use original save/load screens
@@ -266,8 +362,128 @@ Use bright palette mode
*bright_palette*
+Enable Text to Speech for Objects, Options, and the Bible Quote
+ Uses TTS to read descriptions (if TTS is available).
+
+ *tts_enabled_objects*
+
+Enable Text to Speech for Subtitles
+ Use TTS to read subtitles (if TTS is available)
+
+ *tts_enabled_speech*
+
,,,,,,,,,,
+.. FREESCAPE:
+ FREESCAPE
+ **********
+
+ Prerecorded sounds
+ Use high-quality pre-recorded sounds instead of pc speaker emulation
+
+ *prerecorded_sounds*
+
+ Extended timer
+ Starts the game timer at 99:59:59.
+
+ *extended_timer*
+
+ Automatic drilling
+ Allows successful drilling in any area in Driller.
+
+ *automatic_drilling*
+
+ Disable demo mode
+ Ensures demo mode is never activated.
+
+ *disable_demo_mode*
+
+ Disable sensors
+ Sensors will not shoot the player.
+
+ *disable_sensors*
+
+ Disable falling
+ Player cannot fall over edges.
+
+ *disable_falling*
+
+
+.. _Griffon:
+
+Griffon
+***********
+
+Enable Text to Speech
+ Uses TTS to read descriptions (if TTS is available)
+
+ *tts_enabled*
+
+,,,,,,,,,,,,,,
+
+.. _GrimE:
+
+GrimE
+*****
+
+.. _datausr:
+
+Load user patch (unsupported)
+ Loads a user patch. Please note that the ScummVM team doesn't provide support for using such patches.
+
+ *datausr_load*
+
+Show FPS
+ Shows the current FPS-rate while playing.
+
+ *show_fps*
+
+.. _Groovie:
+
+Groovie
+********
+.. _fastmovie:
+
+Fast movie speed
+ Plays movies at an increased speed.
+
+ *fast_movie_speed*
+
+Use original save/load screens
+ Uses the original save/load screens instead of the ScummVM ones.
+
+ *originalsaveload*
+
+.. _ai:
+
+Easier AI
+ Decreases the difficulty of AI puzzles.
+
+ *easier_ai*
+
+.. _creditsmusic:
+
+Updated Credits Music
+ Play the song The Final Hour during the credits instead of reusing MIDI songs
+
+ *credits_music*
+
+.. _hotspots:
+
+Slim Left/Right Hotspots
+ Shrinks the hotspots on the left and right sides for exiting puzzles.
+
+ *slim_hotspots*
+
+.. _speedrun:
+
+Speedrun Mode
+ Affects the controls for fast forwarding the game.
+
+ *speedrun_mode*
+
+,,,,,,,,,
+
.. _HDB:
HDB
@@ -282,9 +498,9 @@ Enable cheat mode
,,,,,,,,,,
-.. _HOPKINS:
+.. _Hopkins:
-HOPKINS
+Hopkins
*************
.. _gore:
@@ -296,9 +512,50 @@ Gore Mode
,,,,,,,,,,
-.. _KYRA:
+.. _Hypno:
-KYRA
+Hypno
+********
+.. _cheats:
+
+Enable original cheats
+ Allows cheats by using the C key.
+
+ *cheats*
+
+.. _infH:
+
+Enable infinite health cheat
+ Player health will never decrease (except for game over scenes).
+
+ *infiniteHealth*
+
+.. _infA:
+
+Enable infinite ammo cheat
+ Player ammo will never decrease.
+
+ *infiniteAmmo*
+
+.. _unlock:
+
+Unlock all levels
+ All levels are available to play.
+
+ *unlockAllLevels*
+
+.. _restored:
+
+Enable restored content
+ Adds additional content that is not enabled the original implementation.
+
+ *restored*
+
+,,,,,,,,,,,,,
+
+.. _Kyra:
+
+Kyra
********
.. _studio:
@@ -324,8 +581,8 @@ Enable helium mode
.. _smooth:
-Enable smooth scrolling when walking
- Makes scrolling smoother when changing from one screen to another.
+Smooth scrolling
+ Makes scrolling smoother when walking.
*smooth_scrolling*
@@ -336,6 +593,8 @@ Enable floating cursors
*floating_cursors*
+.. _autoname:
+
Suggest save names
Fills in an autogenerated save game description into the input prompt.
@@ -357,9 +616,9 @@ Fight Button L/R Swap
,,,,,,,,,,
-.. _LURE:
+.. _Lure:
-LURE
+Lure
******
@@ -372,6 +631,20 @@ TTS Narrator
,,,,,,,,,,
+.. _MADE:
+
+MADE
+******
+
+.. _digitalmusic:
+
+Play a digital soundtrack during the opening movie
+ Uses a digital soundtrack during the introduction, instead of MIDI music.
+
+ *intro_music_digital*
+
+,,,,,,,,,,
+
.. _MADS:
MADS
@@ -405,60 +678,140 @@ Naughty game mode
*NaughtyMode*
-.. _gdither:
+TTS Narrator
+ Use TTS to read the descriptions (if TTS is available).
+
+ *tts_narrator*
-Graphics dithering
- Enables graphics dithering.
- *GraphicsDithering*
,,,,,,,,,,
-.. _MTROPOLIS:
+.. _Mohawk:
-MTROPOLIS
-*******
+Mohawk
+*********
-.. _widescreen:
+.. _zip:
-16:9 widescreen mod
- Removes letterboxing and moves some display elements, improving coverage on widescreen displays.
+Zip Mode activated
+ When activated, clicking on an item or area with the lightning bolt cursor takes you directly there, skipping intermediate screens. You can only 'Zip' to a precise area you've already been.
- *mtropolis_mod_obsidian_widescreen*
+ *zip_mode*
-.. _dynamicmidi:
+.. _tmode:
-Improved music mixing
- Enables dynamic MIDI mixer, improving music quality.
+Transitions enabled
+ Toggle screen transitions on or off. Turning off screen transitions will enable you to navigate more quickly through the game.
- *mtropolis_mod_dynamic_midi*
+ *transition_mode*
-.. _saveatcheckpoints:
+.. _flyby:
-Autosave at progress points
- Automatically saves the game at major progress points.
+Play the Myst fly by movie
+ The Myst fly by movie was not played by the original engine.
- *mtropolis_mod_auto_save_at_checkpoints*
+ *playmystflyby*
-.. _shorttransitions:
+.. _fuzzy:
-Enable short transitions
- Plays short transitions that would normally be skipped on fast CPUs.
+Improve Selenitic Age puzzle accessibility
+ Allows solving Selenitic Age audio puzzles with more error margin.
- *mtropolis_mod_minimum_transition_duration*
+ *fuzzy_logic*
-.. _debugger:
+.. _cdrom:
-Start with debugger
- Starts the game with the debug overlay active.
+Simulate loading times of old CD drives
+ Simulate loading times of old CD-ROM drives by adding a random delay during scene transitions.
- *mtropolis_debug_at_start*
+ *cdromdelay*
-,,,,,,,,,,
+.. _water:
+
+Water Effect Enabled
+ Toggles the use of QuickTime videos for visual effects related to water surfaces (ripples, waves, etc.).
+
+ *water_effects*
+
+.. _tspeed:
+
+Transitions (Riven only)
+ Adjusts the speed of screen transitions. Disabling screen transitions will enable you to navigate more quickly through the game.
+
+ Options:
+ - Disabled
+ - Fastest
+ - Normal
+ - Best
+
+ *transition_mode*
+
+
+,,,,,,,,
+
+..
+ .. _MTROPOLIS:
+
+ MTROPOLIS
+ ************
+
+ .. _widescreen:
+
+ 16:9 widescreen mod
+ Removes letterboxing and moves some display elements, improving coverage on widescreen displays.
+
+ *mtropolis_mod_obsidian_widescreen*
+
+ .. _dynamicmidi:
+
+ Improved music mixing
+ Enables dynamic MIDI mixer, improving music quality.
+
+ *mtropolis_mod_dynamic_midi*
+
+ .. _saveatcheckpoints:
+
+ Autosave at progress points
+ Automatically saves the game at major progress points.
+
+ *mtropolis_mod_auto_save_at_checkpoints*
+
+ .. _shorttransitions:
+
+ Enable short transitions
+ Plays short transitions that would normally be skipped on fast CPUs.
+
+ *mtropolis_mod_minimum_transition_duration*
+
+ Enable subtitles for important sound effects
+ Enables subtitles for important sound effects. This may reduce the difficulty of sound recognition puzzles and minigames.
+
+ *mtropolis_mod_sound_gameplay_subtitles*
+
+ .. _debugger:
+
+ Start with debugger
+ Starts the game with the debug overlay active.
+
+ *mtropolis_debug_at_start*
+
+
+ .. _MYST3:
+
+ MYST3
+ *******
+
+ Widescreen mod
+ Enables widescreen rendering in fullscreen mode.
+
+ *widescreen_mod*
+
+
-.. _NEVERHOOD:
+.. _Neverhood:
-NEVERHOOD
+Neverhood
************
Use original save/load screens
@@ -480,12 +833,19 @@ Scale the making of videos to full screen
*scalemakingofvideos*
+.. _hint:
+
+Repeat useful Willie's hint
+ Repeats actual useful hint by Willie.
+
+ *repeatwilliehint*
+
,,,,,,,,,,
-.. _QUEEN:
+.. _Queen:
-QUEEN
-*****
+Queen
+*******
Alternate intro
Plays the alternate intro for Flight of the Amazon Queen.
@@ -537,7 +897,7 @@ Use high-quality "LarryScale" cel scaling
.. _dsfx:
Prefer digital sound effects
- Prefers digital (sampled) sound effects instead of synthesized ones.
+ Uses digital (sampled) sound effects instead of synthesized ones.
*prefer_digitalsfx*
@@ -546,12 +906,6 @@ Use original save/load screens
*originalsaveload*
-.. _fb01:
-
-Use IMF/Yamaha FB-01 for MIDI output
- Uses an IBM Music Feature card or a Yamaha FB-01 FM synth module for MIDI output.
-
- *native_fb01*
.. _cd:
@@ -588,6 +942,44 @@ Enable content censoring
*enable_censoring*
+.. _rgb:
+
+Use RGB rendering
+ Use RGB rendering to improve screen transitions.
+
+ *rgb_rendering*
+
+.. _palette:
+
+Use per-resource modified palettes
+ Use custom per-resource palettes to improve visuals
+
+ *palette_mods*
+
+.. _beard:
+
+Enable bearded musicians
+ Enable graphics that were disabled for legal reasons
+
+ *enable_bearded_musicians*
+
+.. _midimode:
+
+MIDI Mode
+ When using external MIDI devices, such as through USB-MIDI, select your device here.
+
+ *midi_mode*
+
+ Options:
+ - Standard - GM/MT-32
+ - *Standard*
+ - Roland D-110/D-10/D-20
+ - *D110*
+ - YamahaFB01
+ - *FB01*
+
+
+
,,,,,,,,,,
.. _SCUMM:
@@ -609,6 +1001,31 @@ Use NES Classic Palette
*mm_nes_classic_palette*
+.. _trim:
+
+Trim FM-TOWNS games to 200 pixels height
+ Cuts the extra 40 pixels at the bottom of the screen, to make it standard 200 pixels height, allowing the use of aspect ratio correction.
+ *trim_fmtowns_to_200_pixels*
+
+.. _macmusic:
+
+Play simplified music
+ This music was presumably intended for low-end Macs, and uses only one channel.
+
+ *mac_v3_low_quality_music*
+
+Enable smooth scrolling
+ Uses smooth scrolling instead of the normal 8-pixels steps scrolling.
+
+ *smooth_scroll*
+
+.. _semi:
+
+Allow semi-smooth scrolling
+ Allow scrolling to be less smooth during the fast camera movement in the intro
+
+ *semi_smooth_scroll*
+
.. _enhancements:
Enable game-specific enhancements
@@ -616,11 +1033,25 @@ Enable game-specific enhancements
*enable_enhancements*
+.. _aoverride:
+
+Load modded audio
+ Replaces music, sound effects, and speech clips with modded audio files, if available.
+
+ *audio_override*
+
+.. _originalgui:
+
+Enable the original GUI and Menu
+ Allows the game to use the in-engine graphical interface and the original save/load menu.
+
+ *original_gui*
+
,,,,,,,,,,
-.. _SHERLOCK:
+.. _Sherlock:
-SHERLOCK
+Sherlock
*********
Use original load/save screens
@@ -670,9 +1101,9 @@ TTS Narrator
,,,,,,,,,,
-.. _SKY:
+.. _Sky:
-SKY
+Sky
******
.. _altintro:
@@ -684,9 +1115,37 @@ Floppy intro
,,,,,,,,,,
-.. _SUPERNOVA:
+.. _Stark:
+
+Stark
+********
+
+.. _assets:
+
+Load modded assets
+ Enables loading of external replacement assets.
+
+ *enable_assets_mod*
+
+.. _linearfilter:
-SUPERNOVA
+Enable linear filtering of the backgrounds images
+ When linear filtering is enabled the background graphics are smoother in full screen mode, at the cost of some details.
+
+ *use_linear_filtering*
+
+.. _fontantialias:
+
+Enable font anti-aliasing
+ Creates smoother text.
+
+ *enable_font_antialiasing*
+
+,,,,,,,,,,,,
+
+.. _Supernova:
+
+Supernova
**********
.. _improved:
@@ -696,11 +1155,42 @@ Improved mode
*improved*
+Enable Text to Speech
+ Use TTS to read descriptions (if TTS is available).
+
+ *tts_enabled*
+
,,,,,,,,,,
-.. _TOLTECS:
+.. _Sword2:
+
+Sword2
+********
+
+Show object labels
+ Shows labels for objects on mouse hover
+
+ *object_labels*
+
+,,,,,,,,,,,
+
+.. _Sword25:
+
+Sword25
+**********
+
+.. _english:
+
+Use English speech
+ Use English speech instead of German for every language other than German.
+
+ *english_speech*
+
+,,,,,,,,,,,,,
-TOLTECS
+.. _Toltecs:
+
+Toltecs
**************
Use original save/load screens
@@ -710,9 +1200,181 @@ Use original save/load screens
,,,,,,,,,,
-.. _WINTERMUTE:
+.. _Trecision:
+
+Trecision
+***********
+
+Use original save/load screens
+ Use the original save/load screens instead of the ScummVM ones.
+
+ *originalsaveload*
+
+,,,,,,,,,,,,,,
+
+.. _TwinE:
+
+TwineE
+*******
+
+.. _wall:
+
+Enable wall collisions
+ Enables the original wall collision damage.
+
+ *wallcollision*
+
+.. _debugmode:
+
+Enable debug mode
+ Enables the debug mode.
+
+ *debug*
+
+.. _usecd:
+
+Enable audio CD
+ Enables the original audio cd track.
+
+ *usecd*
+
+.. _sound:
+
+Enable sound
+ Enable the sound for the game
-WINTERMUTE
+ *sound*
+
+.. _voice:
+
+Enable voices
+ Enable the voices for the game
+
+ *voice*
+
+.. _displaytext:
+
+Enable text
+ Enable the text for the game
+
+ *displaytext*
+
+.. _movie:
+
+Enable movies
+ Enable the cutscenes for the game.
+
+ *movie*
+
+.. _mouse:
+
+Enable mouse
+ Enables the mouse for the UI.
+
+ *mouse*
+
+.. _usa:
+
+Use the USA version
+ Enables the USA specific version flags.
+
+ *version*
+
+.. _highres:
+
+Enable high resolution
+ Enables a higher resolution for the game
+
+ *usehighres*
+
+TTS Narrator
+ Use TTS to read the descriptions (if TTS is available)
+
+ *tts_narrator*
+
+,,,,,,,,
+
+.. _Ultima:
+
+Ultima
+********
+
+Use original save/load screens
+ Use the original save/load screens instead of the ScummVM ones.
+
+ *originalsaveload*
+
+.. _frameskip:
+
+Enable frame skipping
+ Allow the game to skip animation frames when running too slow.
+
+ *frameSkip*
+
+.. _framelimit:
+
+Enable frame limiting
+ Limits the speed of the game to prevent running too fast.
+
+ *frameLimit*
+
+.. _cheat:
+
+Enable cheats
+ Allows cheats by commands and a menu when player is clicked.
+
+ *cheat*
+
+Enable high resolution
+ Enable a higher resolution for the game
+
+ *usehighres*
+
+.. _footsteps:
+
+Play foot step sounds
+ Plays a sound when the player moves.
+
+ *footsteps*
+
+.. _jump:
+
+Enable jump to mouse position
+ Jumping while not moving targets the mouse cursor instead of direction.
+
+ *targetedjump*
+
+.. _fontoverride:
+
+Enable font replacement
+ Replaces game fonts with rendered fonts
+
+ *font_override*
+
+Enable font anti-aliasing
+ Results in smoother text.
+
+ *font_antialiasing*
+
+.. _silencer:
+
+Camera moves with Silencer
+ Camera tracks the player movement rather than snapping to defined positions.
+
+ *camera_on_player*
+
+.. _christmas:
+
+Always enable Christmas easter-egg
+ Enables the Christmas music at any time of year.
+
+ *always_christmas*
+
+,,,,,,,
+
+.. _Wintermute:
+
+Wintermute
**************
.. _fps:
@@ -729,11 +1391,18 @@ Sprite bilinear filtering (SLOW)
*bilinear_filtering*
+.. _2d:
+
+Force to use 2D renderer (2D games only)
+ Forces ScummVM to use 2D renderer while running 2D games.
+
+ *force_2d_renderer*
+
,,,,,,,,,,
-.. _XEEN:
+.. _Xeen:
-XEEN
+Xeen
******
.. _cost:
@@ -749,3 +1418,43 @@ More durable armor
Armor won't break until character is at -80HP, instead of the default -10HP.
*DurableArmor*
+
+,,,,,,,,,,,,,
+
+.. _ZVision:
+
+ZVision
+*********
+
+Use original save/load screens
+ Use the original save/load screens instead of the ScummVM ones
+
+ *originalsaveload*
+
+.. _double:
+
+Double FPS
+ Increases framerate from 30 to 60 FPS.
+
+ *doublefps*
+
+.. _venus:
+
+Enable Venus
+ Enables the Venus help system.
+
+ *venusenabled*
+
+.. _noanim:
+
+Disable animation while turning
+ Disables animation while turning in panorama mode.
+
+ *noanimwhileturning*
+
+.. _mpeg:
+
+Use high resolution MPEG video
+ Use MPEG video from the DVD version instead of lower resolution AVI.
+
+ *mpegmovies*
\ No newline at end of file
Commit: 69d1603af5feab36aa5bdcafdc16a1b6059d8b30
https://github.com/scummvm/scummvm/commit/69d1603af5feab36aa5bdcafdc16a1b6059d8b30
Author: CadiH (cadihowley at gmail.com)
Date: 2023-01-18T06:33:47+11:00
Commit Message:
DOCS: updates requirements file
- mdinclude required for release notes
Changed paths:
doc/docportal/requirements.txt
diff --git a/doc/docportal/requirements.txt b/doc/docportal/requirements.txt
index 6c979964175..c18c1346698 100644
--- a/doc/docportal/requirements.txt
+++ b/doc/docportal/requirements.txt
@@ -2,4 +2,5 @@ sphinx-tabs==3.3.1
sphinx-panels==0.6.0
sphinx<5
docutils==0.17
-sphinx_rtd_theme==1.0.0
\ No newline at end of file
+sphinx_rtd_theme==1.0.0
+sphinx-mdinclude==0.5.3
\ No newline at end of file
Commit: 871b2933e7a07c49582b896c3a39a70ab686ab62
https://github.com/scummvm/scummvm/commit/871b2933e7a07c49582b896c3a39a70ab686ab62
Author: CadiH (cadihowley at gmail.com)
Date: 2023-01-18T06:33:47+11:00
Commit Message:
DOCS: adds GUI page and updates Misc settings page
Changed paths:
A doc/docportal/images/settings/gui.png
A doc/docportal/settings/gui.rst
doc/docportal/images/settings/misc.png
doc/docportal/index.rst
doc/docportal/settings/misc.rst
diff --git a/doc/docportal/images/settings/gui.png b/doc/docportal/images/settings/gui.png
new file mode 100644
index 00000000000..7ec4dbe25a0
Binary files /dev/null and b/doc/docportal/images/settings/gui.png differ
diff --git a/doc/docportal/images/settings/misc.png b/doc/docportal/images/settings/misc.png
index 46c14e6e5b5..2c5b207db32 100755
Binary files a/doc/docportal/images/settings/misc.png and b/doc/docportal/images/settings/misc.png differ
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index a365dd9a290..c732078e05a 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -29,17 +29,22 @@
:glob:
:hidden:
- settings/game
+ settings/accessibility
+ settings/audio
settings/backend
- settings/graphics
+ settings/cloud
settings/control
+ settings/game
+ settings/gui
+ settings/graphics
settings/keymaps
- settings/audio
- settings/paths
- settings/misc
- settings/cloud
settings/lan
- settings/accessibility
+ settings/misc
+ settings/paths
+
+
+
+
.. toctree::
diff --git a/doc/docportal/settings/gui.rst b/doc/docportal/settings/gui.rst
new file mode 100644
index 00000000000..c593cb1e222
--- /dev/null
+++ b/doc/docportal/settings/gui.rst
@@ -0,0 +1,77 @@
+=====================
+GUI
+=====================
+
+Use this tab to the GUI tab to change the look and feel of the ScummVM graphical user interface.
+
+From the Launcher, select **Global Options**, if necessary click the **>** scroll arrow until the GUI tab is visible, and then select the **GUI** tab.
+
+
+.. figure:: ../images/settings/gui.png
+
+ The GUI 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.
+
+,,,,,,,,,,,,,,
+
+.. _theme:
+
+Theme
+ Changes the visual appearance of the ScummVM Launcher
+
+ *gui_theme*
+
+GUI scale
+ Scale the ScummVM GUI to be bigger or smaller. Using a larger scale can help to make the text easier to read when using ScummVM on a big screen.
+
+ *gui_scale*
+
+GUI renderer
+ Defines how the ScummVM GUI is rendered; normal or antialiased.
+
+ *gui_renderer*
+
+GUI language
+ Chooses the language of the ScummVM Launcher.
+
+ *gui_language*
+
+.. _guilanguage:
+
+Switch the ScummVM GUI language to the game language
+ If ticked, the Launcher language is the same as the game language.
+
+ *gui_use_game_language*
+
+.. _guibrowser:
+
+Use native system file browser
+ Uses the system file browser instead of the ScummVM browser.
+
+ *gui_browser_native*
+
+.. _guireturn:
+
+Always return to the launcher when leaving a game
+ If ticked, removes the **Quit** option from the Global Main Menu. Only the **Return to Launcher** option remains.
+
+ *gui_return_to_launcher_at_exit*
+
+.. _guiconfirm:
+
+Ask for confirmation on exit
+ If ticked, a confirmation dialog appears when you choose **Quit** or **Return to Launcher** from the Global Main Menu.
+
+ *confirm_exit*
+
+.. _updateicons:
+
+Update Icons
+ Click on the Update Icons button to download new or updated artwork for game icons. ScummVM will scan to find applicable icons; once these have been found, click on the **Download** button in the pop up window to start the download. Click the **Hide** button to close the window and continue the download in the background. Use the **Cancel download** button to cancel the download.
+
+.. figure:: ../images/settings/update_icons.png
+
+ The Update Icons window
+
+ The icon packs can also be downloaded manually from https://downloads.scummvm.org/frs/icons/ and must be placed in the :ref:`Icon Path <iconspath>`. The packs are incremental and you need all of them to have all the available icons and not just the most recent pack.
diff --git a/doc/docportal/settings/misc.rst b/doc/docportal/settings/misc.rst
index 7637b241d9f..a356129375c 100644
--- a/doc/docportal/settings/misc.rst
+++ b/doc/docportal/settings/misc.rst
@@ -14,23 +14,6 @@ All settings can also be changed in the :doc:`../advanced_topics/configuration_f
,,,,,,,,,,,,,,,,,
-.. _theme:
-
-Theme
- Changes the visual appearance of the ScummVM Launcher
-
- *gui_theme*
-
-GUI scale
- Scale the ScummVM GUI to be bigger or smaller. Using a larger scale can help to make the text easier to read when using ScummVM on a big screen.
-
- *gui_scale*
-
-GUI renderer
- Defines how the ScummVM GUI is rendered; normal or antialiased.
-
- *gui_renderer*
-
.. _autosave:
Autosave
@@ -38,50 +21,10 @@ Autosave
*autosave_period*
+Random seed
+ Every time you start ScummVM, a random seed is generated. Use this option to set a fixed seed, which ensures that random events in games play out the same way every time.
-GUI language
- Chooses the language of the ScummVM Launcher.
-
- *gui_language*
-
-.. _guilanguage:
-
-Switch the ScummVM GUI language to the game language
- If ticked, the Launcher language is the same as the game language.
-
- *gui_use_game_language*
-
-.. _guibrowser:
-
-Use native system file browser
- Uses the system file browser instead of the ScummVM browser.
-
- *gui_browser_native*
-
-.. _guireturn:
-
-Always return to the launcher when leaving a game
- If ticked, removes the **Quit** option from the Global Main Menu. Only the **Return to Launcher** option remains.
-
- *gui_return_to_launcher_at_exit*
-
-.. _guiconfirm:
-
-Ask for confirmation on exit
- If ticked, a confirmation dialog appears when you choose **Quit** or **Return to Launcher** from the Global Main Menu.
-
- *confirm_exit*
-
-.. _updateicons:
-
-Update Icons
- Click on the Update Icons button to download new or updated artwork for game icons. ScummVM will scan to find applicable icons; once these have been found, click on the **Download** button in the pop up window to start the download. Click the **Hide** button to close the window and continue the download in the background. Use the **Cancel download** button to cancel the download.
-
-.. figure:: ../images/settings/update_icons.png
-
- The Update Icons window
-
- The icon packs can also be downloaded manually from https://downloads.scummvm.org/frs/icons/ and must be placed in the :ref:`Icon Path <iconspath>`. The packs are incremental and you need all of them to have all the available icons and not just the most recent pack.
-
+ *random_seed*
+
Enable Discord Integration
Use this option to automatically check for updates to ScummVM. Click the Check now button to manually check for updates.
\ No newline at end of file
Commit: 92a4311844167c330e57ee877074a93a1f76e76c
https://github.com/scummvm/scummvm/commit/92a4311844167c330e57ee877074a93a1f76e76c
Author: CadiH (cadihowley at gmail.com)
Date: 2023-01-18T06:33:47+11:00
Commit Message:
DOCS: updates Game page to include missing engines
Changed paths:
doc/docportal/advanced_topics/configuration_file.rst
doc/docportal/settings/game.rst
diff --git a/doc/docportal/advanced_topics/configuration_file.rst b/doc/docportal/advanced_topics/configuration_file.rst
index 4ea36361eb1..671c34b9f69 100755
--- a/doc/docportal/advanced_topics/configuration_file.rst
+++ b/doc/docportal/advanced_topics/configuration_file.rst
@@ -131,6 +131,7 @@ There are many recognized configuration keys. In the table below, each key is ei
- 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
@@ -156,7 +157,10 @@ There are many recognized configuration keys. In the table below, each key is ei
":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."
@@ -179,6 +183,7 @@ There are many recognized configuration keys. In the table below, each key is ei
":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.
+ ":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,
@@ -326,6 +331,12 @@ There are many recognized configuration keys. In the table below, each key is ei
- 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
@@ -394,6 +405,7 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`platform <platform>`",string,,
":ref:`portaits_on <portraits>`",boolean,true,
":ref:`prefer_digitalsfx <dsfx>`",boolean,true,
+ ":ref:`prerecorded_sounds <prerecorded>`",boolean,true,
":ref:`renderer <renderer>`",string,default,"
- opengl
- opengl_shaders
@@ -489,6 +501,7 @@ There are many recognized configuration keys. In the table below, each key is ei
":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,,
diff --git a/doc/docportal/settings/game.rst b/doc/docportal/settings/game.rst
index 2d3ffe0154a..3e81119a775 100644
--- a/doc/docportal/settings/game.rst
+++ b/doc/docportal/settings/game.rst
@@ -50,7 +50,7 @@ The Game tab also shows settings unique to the game engine for the selected game
To find out which engine powers your game, have a look at the ScummVM Supported Games `wiki page
<https://wiki.scummvm.org/index.php?title=Category:Supported_Games>`_ or :ref:`group <group>` games by Engine in the Launcher.
-Engines: ADL_ | AGI_ | AGOS_ | Bladerunner_ | Buried_ | CGE_ | CGE2_ | Chewy_ | Cine_ | Drascula_ | Dreamweb_ | FREESCAPE_ | Griffon_ | GrimE_ | HDB_ | Hopkins_ | Hypno_ | Kyra_ | Lure_ | MADE_ | MADS_ | MTROPOLIS_ | MYST3_ | Neverhood_ | SCI_ | SCUMM_ | Sherlock_ | Sky_ | Stark_ | Supernova_ | Sword2_ | Sword25_ | Toltecs_ | Trecision_ | Ultima_ | Wintermute_ | Xeen_ | ZVision_
+Engines: ADL_ | AGI_ | AGOS_ | Bladerunner_ | Buried_ | CGE_ | CGE2_ | Chewy_ | Cine_ | Drascula_ | Dreamweb_ | Freescape_ | Griffon_ | GrimE_ | HDB_ | Hopkins_ | Hypno_ | Kyra_ | Lure_ | MADE_ | MADS_ | mTropolis_ | Myst3_ | Neverhood_ | SCI_ | SCUMM_ | Sherlock_ | Sky_ | Stark_ | Supernova_ | Sword2_ | Sword25_ | Toltecs_ | Trecision_ | Ultima_ | Wintermute_ | Xeen_ | ZVision_
@@ -374,40 +374,54 @@ Enable Text to Speech for Subtitles
,,,,,,,,,,
-.. FREESCAPE:
- FREESCAPE
- **********
+.. _Freescape:
- Prerecorded sounds
- Use high-quality pre-recorded sounds instead of pc speaker emulation
+Freescape
+**********
+
+.. _prerecorded:
+
+Prerecorded sounds
+ Uses high-quality pre-recorded sounds instead of PC speaker emulation.
+
+ *prerecorded_sounds*
+
+.. _extended:
+
+Extended timer
+ Starts the game timer at 99:59:59.
+
+ *extended_timer*
+
+.. _drill:
- *prerecorded_sounds*
+Automatic drilling
+ Allows successful drilling in any area in Driller.
- Extended timer
- Starts the game timer at 99:59:59.
+ *automatic_drilling*
- *extended_timer*
+.. _demo:
- Automatic drilling
- Allows successful drilling in any area in Driller.
+Disable demo mode
+ Ensures demo mode is never activated.
- *automatic_drilling*
+ *disable_demo_mode*
- Disable demo mode
- Ensures demo mode is never activated.
+.. _sensors:
- *disable_demo_mode*
+Disable sensors
+ Ensures sensors do not shoot the player.
- Disable sensors
- Sensors will not shoot the player.
+ *disable_sensors*
- *disable_sensors*
+.. _falling:
- Disable falling
- Player cannot fall over edges.
+Disable falling
+ Stops player from falling over edges.
- *disable_falling*
+ *disable_falling*
+,,,,,,,,,
.. _Griffon:
@@ -438,6 +452,8 @@ Show FPS
*show_fps*
+,,,,,,,,,,,
+
.. _Groovie:
Groovie
@@ -750,64 +766,68 @@ Transitions (Riven only)
,,,,,,,,
-..
- .. _MTROPOLIS:
+.. _mTropolis:
+
+mTropolis
+************
- MTROPOLIS
- ************
+.. _widescreen:
- .. _widescreen:
+16:9 widescreen mod
+ Removes letterboxing and moves some display elements, improving coverage on widescreen displays.
- 16:9 widescreen mod
- Removes letterboxing and moves some display elements, improving coverage on widescreen displays.
+ *mtropolis_mod_obsidian_widescreen*
- *mtropolis_mod_obsidian_widescreen*
+.. _dynamicmidi:
- .. _dynamicmidi:
+Improved music mixing
+ Enables dynamic MIDI mixer, improving music quality.
- Improved music mixing
- Enables dynamic MIDI mixer, improving music quality.
+ *mtropolis_mod_dynamic_midi*
- *mtropolis_mod_dynamic_midi*
+.. _saveatcheckpoints:
- .. _saveatcheckpoints:
+Autosave at progress points
+ Automatically saves the game at major progress points.
- Autosave at progress points
- Automatically saves the game at major progress points.
+ *mtropolis_mod_auto_save_at_checkpoints*
- *mtropolis_mod_auto_save_at_checkpoints*
+.. _shorttransitions:
- .. _shorttransitions:
+Enable short transitions
+ Plays short transitions that would normally be skipped on fast CPUs.
- Enable short transitions
- Plays short transitions that would normally be skipped on fast CPUs.
+ *mtropolis_mod_minimum_transition_duration*
- *mtropolis_mod_minimum_transition_duration*
+.. _sfxsubs:
- Enable subtitles for important sound effects
- Enables subtitles for important sound effects. This may reduce the difficulty of sound recognition puzzles and minigames.
+Enable subtitles for important sound effects
+ Enables subtitles for important sound effects. This may reduce the difficulty of sound recognition puzzles and minigames.
- *mtropolis_mod_sound_gameplay_subtitles*
+ *mtropolis_mod_sound_gameplay_subtitles*
- .. _debugger:
+.. _debugger:
- Start with debugger
- Starts the game with the debug overlay active.
+Start with debugger
+ Starts the game with the debug overlay active.
- *mtropolis_debug_at_start*
+ *mtropolis_debug_at_start*
+,,,,,,,,,,,,,,
- .. _MYST3:
+.. _Myst3:
- MYST3
+ Myst3
*******
+.. _widescreen_mod:
+
Widescreen mod
Enables widescreen rendering in fullscreen mode.
*widescreen_mod*
-
+,,,,,,,,,,,,,,,,
.. _Neverhood:
Commit: f64992022137704f20d3edb1f5b2a50588525017
https://github.com/scummvm/scummvm/commit/f64992022137704f20d3edb1f5b2a50588525017
Author: CadiH (cadihowley at gmail.com)
Date: 2023-01-18T06:33:47+11:00
Commit Message:
DOCS: Adds GUI tab to settings description
Changed paths:
doc/docportal/use_scummvm/how_to_settings.rst
diff --git a/doc/docportal/use_scummvm/how_to_settings.rst b/doc/docportal/use_scummvm/how_to_settings.rst
index 2975ccf921f..884a0bbce6d 100644
--- a/doc/docportal/use_scummvm/how_to_settings.rst
+++ b/doc/docportal/use_scummvm/how_to_settings.rst
@@ -6,7 +6,7 @@ From the Launcher
==================
The settings are arranged by subject, on different tabs:
-:doc:`Game tab <../settings/game>` | :doc:`Graphics tab <../settings/graphics>` | :doc:`Control tab <../settings/control>` | :doc:`Keymaps tab <../settings/keymaps>` | :doc:`Audio tab <../settings/audio>` | :doc:`Volume tab <../settings/audio>` | :doc:`Midi tab <../settings/audio>` | :doc:`MT-32 tab <../settings/audio>` | :doc:`Paths tab <../settings/paths>` | :doc:`Misc tab <../settings/misc>` | :doc:`Cloud tab <../settings/cloud>` | :doc:`LAN tab <../settings/lan>` | :doc:`Accessibility tab <../settings/accessibility>`
+:doc:`Game tab <../settings/game>` | :doc:`Graphics tab <../settings/graphics>` | :doc:`Control tab <../settings/control>` | :doc:`Keymaps tab <../settings/keymaps>` | :doc:`Audio tab <../settings/audio>` | :doc:`Volume tab <../settings/audio>` | :doc:`Midi tab <../settings/audio>` | :doc:`MT-32 tab <../settings/audio>` | :doc:`Paths tab <../settings/paths>` | :doc:`GUI tab <../settings/gui>` | :doc:`Misc tab <../settings/misc>` | :doc:`Cloud tab <../settings/cloud>` | :doc:`LAN tab <../settings/lan>` | :doc:`Accessibility tab <../settings/accessibility>`
To change a setting globally, so that it affects all games, select the **Global Options** button to open the menu, and then select the tab containing the setting you would like to change.
Commit: 9ae5aceae53aee7516578f25d555c20aee1684bb
https://github.com/scummvm/scummvm/commit/9ae5aceae53aee7516578f25d555c20aee1684bb
Author: CadiH (cadihowley at gmail.com)
Date: 2023-01-18T06:33:47+11:00
Commit Message:
DOCS: Adds information about shaders
Changed paths:
A doc/docportal/images/settings/shader_picker.png
A doc/docportal/images/settings/test_pattern.png
doc/docportal/advanced_topics/understand_graphics.rst
doc/docportal/images/settings/graphics.png
doc/docportal/settings/graphics.rst
diff --git a/doc/docportal/advanced_topics/understand_graphics.rst b/doc/docportal/advanced_topics/understand_graphics.rst
index ba3a9d17fe2..30e00bc925f 100644
--- a/doc/docportal/advanced_topics/understand_graphics.rst
+++ b/doc/docportal/advanced_topics/understand_graphics.rst
@@ -205,6 +205,15 @@ Below are some of the common render modes, to illustrate how the render mode set
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 Gameboy 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
----------------
diff --git a/doc/docportal/images/settings/graphics.png b/doc/docportal/images/settings/graphics.png
index a250c09f242..56f2192406a 100755
Binary files a/doc/docportal/images/settings/graphics.png and b/doc/docportal/images/settings/graphics.png differ
diff --git a/doc/docportal/images/settings/shader_picker.png b/doc/docportal/images/settings/shader_picker.png
new file mode 100644
index 00000000000..6c63c333738
Binary files /dev/null and b/doc/docportal/images/settings/shader_picker.png differ
diff --git a/doc/docportal/images/settings/test_pattern.png b/doc/docportal/images/settings/test_pattern.png
new file mode 100644
index 00000000000..5840d405350
Binary files /dev/null and b/doc/docportal/images/settings/test_pattern.png differ
diff --git a/doc/docportal/settings/graphics.rst b/doc/docportal/settings/graphics.rst
index 248cc5a6cee..23d641a6741 100644
--- a/doc/docportal/settings/graphics.rst
+++ b/doc/docportal/settings/graphics.rst
@@ -2,8 +2,7 @@
Graphics
===============
-Use the Graphics tab to change how games look when they are played.
-
+Use the Graphics tab to change how games look when they are played.
**To change settings globally:**
@@ -26,15 +25,14 @@ All settings can also be changed in the :doc:`../advanced_topics/configuration_f
.. _gfxmode:
Graphics mode
- Change the graphics backend used to render the ScummVM window on the screen. Different graphics modes have different options available (such as scalers and stretch modes).
+ Changes the graphics backend used to render the ScummVM window on the screen. Different graphics modes have different options available (such as scalers and stretch modes).
*gfx_mode*
-
.. _render:
Render mode
- Changes how the game is rendered.
+ Changes how the game is rendered. This is only applicable to certain games which were released on multiple systems, and will reproduce what the game looked like on that system.
*render_mode*
@@ -47,11 +45,29 @@ Stretch mode
.. _scalers:
-Scalers
+Scaler
Changes the resolution of the game, while also selecting which filter is used to scale up the resolution. For example, a 2x scaler will take a 320x200 resolution game and scale it up to 640x400.
*scaler* and *scale_factor*
+Shaders
+ Similar to render mode, but applicable to all games, shaders are graphics filters that change the way a game looks. Select the **Shader** button, select a shader from the list and then select **Choose**. Alternatively, select **Pick file instead...** to browse your computer for shaders to use. ScummVM only accepts GLSL files in the .glslp format.
+
+.. figure:: ../images/settings/shader_picker.png
+
+ The shader picker
+
+ Once back in the Graphics tab, select **Apply** to apply the chosen shader. A test pattern pops up to preview the chosen shader, along with a confirmation dialog. Choose **Yes** to keep the new shader, or **No** to revert to previous settings. ScummVM reverts to the previous setting in 10 seconds if no action is taken; this is a safety feature.
+
+.. figure:: ../images/settings/test_pattern.png
+
+ The shader test pattern
+
+Update Shaders
+ Click on the Update Shaders button to download new or updated shaders. ScummVM will scan to find applicable shader packs; once these have been found, click on the **Download** button in the pop up window to start the download. Click the **Hide** button to close the window and continue the download in the background. Use the **Cancel download** button to cancel the download. Select **Clear Cache** to delete downloaded shaders.
+
+ The shader packs can also be downloaded manually from https://downloads.scummvm.org/frs/icons/ and must be placed in the :ref:`Icon Path <iconspath>`.
+
.. _ratio:
Aspect ratio correction
Commit: de151ea3fddd6a2d36a41400a55366bd2a6a94de
https://github.com/scummvm/scummvm/commit/de151ea3fddd6a2d36a41400a55366bd2a6a94de
Author: CadiH (cadihowley at gmail.com)
Date: 2023-01-18T06:33:47+11:00
Commit Message:
DOCS: Replaces test pattern screenshot
Changed paths:
doc/docportal/images/settings/test_pattern.png
diff --git a/doc/docportal/images/settings/test_pattern.png b/doc/docportal/images/settings/test_pattern.png
index 5840d405350..62f8d55f7d0 100644
Binary files a/doc/docportal/images/settings/test_pattern.png and b/doc/docportal/images/settings/test_pattern.png differ
Commit: 4305d5777153123ad9a307cb6d355870558ff9db
https://github.com/scummvm/scummvm/commit/4305d5777153123ad9a307cb6d355870558ff9db
Author: CadiH (cadihowley at gmail.com)
Date: 2023-01-18T06:33:47+11:00
Commit Message:
DOCS: Adds description of initial config file
Changed paths:
doc/docportal/advanced_topics/configuration_file.rst
diff --git a/doc/docportal/advanced_topics/configuration_file.rst b/doc/docportal/advanced_topics/configuration_file.rst
index 671c34b9f69..ff87ba66500 100755
--- a/doc/docportal/advanced_topics/configuration_file.rst
+++ b/doc/docportal/advanced_topics/configuration_file.rst
@@ -101,6 +101,15 @@ Example of a configuration file
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
@@ -390,11 +399,7 @@ There are many recognized configuration keys. In the table below, each key is ei
":ref:`original_gui <originalgui>`",boolean,true,
":ref:`original_menus <originalmenu>`",boolean,false,
":ref:`originalsaveload <osl>`",boolean,false,
- ":ref:`output_channels <outputchannels>`",integer,,"
- Supported values are:
-
- - 1
- - 2"
+ 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:
@@ -511,6 +516,7 @@ There are many recognized configuration keys. In the table below, each key is ei
.. _screenshotpath:
Screenshot path
+====================
The default location for the screenshotpath depends on your system.
Commit: ce288d0bbdb04277686fe378628eabc8e9cdca07
https://github.com/scummvm/scummvm/commit/ce288d0bbdb04277686fe378628eabc8e9cdca07
Author: CadiH (cadihowley at gmail.com)
Date: 2023-01-18T06:33:47+11:00
Commit Message:
DOCS: Updates command line options
Changed paths:
doc/docportal/advanced_topics/command_line.rst
doc/docportal/settings/misc.rst
diff --git a/doc/docportal/advanced_topics/command_line.rst b/doc/docportal/advanced_topics/command_line.rst
index f8c7c125594..954e326a849 100755
--- a/doc/docportal/advanced_topics/command_line.rst
+++ b/doc/docportal/advanced_topics/command_line.rst
@@ -5,7 +5,6 @@ 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.
-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.
Usage
=========
@@ -14,7 +13,9 @@ Usage
scummvm [option] [game]
-By default executing `scummvm` on the command line starts the launcher. But if a game is specified, or if ``--auto-detect`` is used, this starts the game directly. And otherwise if a command option such as ``--list-games`` or ``--detect`` is specified, the result will be printed and ScummVM will quit immediately without starting a game or the launcher.
+- 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
@@ -28,7 +29,7 @@ For games that have previously been added to ScummVM:
scummvm <target>
-For any supported games (it does not need to be added to ScummVM beforehand):
+For any supported games, even if they have not been added to ScummVM:
.. code::
@@ -40,25 +41,25 @@ or
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 a save game to load.
+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 can be seen and changed in the :ref:`Game Options<id>`. If the same game is added twice to ScummVM, it will be given two different `target` names, and they can be configured differently. The list of configured targets can be obtained with:
+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. You can get a list of all supported games for your ScummVM release by using:
+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
-When using a `target` name on the command line to start a game, it will be using the settings configured for this target, unless overwritten by settings specified on the command line. There is also no need to specify the path for the game files since this is already part of the target configuration.
+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.
-On the other hand using the `game id` or ``--auto-detect`` will start the games with default settings for any settings not specified on the command line, and the path to the game file needs to be specified.
+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, the engine name can be omitted 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` needs to 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`.
+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``.
.. tabbed:: Windows
@@ -147,80 +148,231 @@ Option parameters are shown below in capitals, and need to be replaced with real
Short options are listed where they are available.
.. csv-table::
- :widths: 35 15 50
+ :widths: 25 10 45 15
:class: command
:header-rows: 1
- Option,Short,Description
- ``--add``,``-a``,"Adds all games from current or specified directory.
-
- If ``--game=NAME`` is passed, only the game with id NAME 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>`"
- ``--aspect-ratio``,,":ref:`Enables aspect ratio correction <ratio>`"
- ``--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>`_)."
- ``--cdrom=DRIVE``,,"Sets the CD drive to play CD audio from. This can be a drive, path, or numeric index (default: 0)"
- ``--config=FILE``,``-c``,"Uses alternate configuration file path"
- ``--initial-cfg=FILE``,``-i``,"Loads an initial configuration file if no configuration file has been saved yet."
- ``--console``,,"Enables the console window (default: enabled). Win32 and Symbian32 only."
- ``--copy-protection``,,"Enables copy protection"
- ``--debug-channels-only``,,"Shows only the specified debug channels"
- ``--debugflags=FLAGS``,,"Enables engine specific debug flags"
- ``--debuglevel=NUM``,``-d``,"Sets debug verbosity level"
- ``--demo-mode``,,"Starts demo mode of Maniac Mansion or The 7th Guest"
- ``--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."
- ``--dimuse-tempo=NUM``,,"Sets internal Digital iMuse tempo (10 - 100) per second (default: 10)"
- ``--engine-speed=NUM``,,"Sets frames per second limit (0 - 100) for Grim Fandango or Escape from Monkey Island (default: 60)."
- ``--dump-scripts``,``-u``,"Enables script dumping if a directory called 'dumps' exists in the current directory"
- ``--enable-gs``,,":ref:`Enables Roland GS mode for MIDI playback <gs>`"
- ``--engine=ID``,,"In combination with ``--list-games`` or ``--list-all-games`` only lists games for this engine"
- ``--extrapath=PATH``,,":ref:`Extra path to additional game data <extra>`"
- ``--iconspath=PATH``,,":ref:`Path to additional icons for the launcher grid view <iconspath>`"
- ``--filtering``,,":ref:`Forces filtered graphics mode <filtering>`"
- ``--fullscreen``,``-f``,":ref:`Forces full-screen mode <fullscreen>`"
- ``--game=NAME``,,"In combination with ``--add`` or ``--detect`` only adds or attempts to detect the game with id NAME."
- ``--gfx-mode``,``-g``,":ref:`Selects graphics mode <gfxmode>`"
- ``--gui-theme=THEME``,,":ref:`Selects GUI theme <theme>`"
- ``--help``,``-h``,"Displays a brief help text and exit"
- ``--joystick=NUM``,,"Enables joystick input (default: 0 = first joystick)"
- ``--language``,``-q``,":ref:`Selects language <lang>` (en, de, fr, it, pt, es, jp, zh, kr, se, gb, hb, ru, cz)"
- ``--list-audio-devices``,,"Lists all available audio devices"
- ``--list-engines``,,"Display list of supported engines and exit"
- ``--list-all-engines``,,"Display list of all detection engines and exit"
- ``--list-debugflags=engine``,,"Display list of engine specified debugflags. If ``engine=global`` or engine is not specified, then it will list global debugflags."
- ``--list-all-debugflags``,,"Display list of all engine specified debugflags"
- ``--list-saves --game=TARGET``,,"Displays a list of saved games for the game (TARGET) specified"
- ``--list-targets``,``-t``,"Displays list of configured targets and exits"
- ``--list-themes``,,"Displays list of all usable GUI themes"
- ``--logfile=PATH``,``-l``,"Uses alternate path for log file (SDL backend only)."
- ``--midi-gain=NUM``,,":ref:`Sets the gain for MIDI playback <gain>`. 0-1000 (default: 100). Only supported by some MIDI drivers"
- ``--multi-midi``,,":ref:`Enables combination AdLib and native MIDI <multi>`"
- ``--music-driver=MODE``,``-e``,":ref:`Selects preferred music device <device>`"
- ``--music-volume=NUM``,``-m``,":ref:`Sets the music volume <music>`, 0-255 (default: 192)"
- ``--native-mt32``,,":ref:`True Roland MT-32 (disables GM emulation) <mt32>`"
- ``--no-filtering``,,"Forces unfiltered graphics mode"
- ``--no-fullscreen``,``-F``,"Forces windowed mode"
- ``--opl-driver=DRIVER``,,":ref:`Selects AdLib (OPL) emulator <opl>`"
- ``--output-channels=CHANNELS``,,"Select output channel count"
- ``--output-rate=RATE``,,"Selects output sample rate in Hz"
- ``--path=PATH``,``-p``,"Sets path to where the game is installed"
- ``--platform=STRING``,,":ref:`Specifes 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:`Set the random seed used to initialize entropy`"
- ``--recursive``,,"In combination with ``--add or ``--detect`` recurses down all subdirectories"
- ``--render-mode=MODE``,,":ref:`Enables additional render modes <render>`"
- ``--save-slot=NUM``,``-x``,"Specifies the saved game slot to load (default: autosave)"
- ``--savepath=PATH``,,":ref:`Specifies path to where saved games are stored <savepath>`"
- ``--screenshotpath=PATH``,,"Specify path where screenshot files are created (SDL backend only)"
- ``--sfx-volume=NUM``,``-s``,":ref:`Sets the sfx volume <sfx>`, 0-255 (default: 192)"
- ``--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 (default: 192)"
- ``--subtitles``,``-n``,":ref:`Enables subtitles <speechmute>`"
- ``--talkspeed=NUM``,,":ref:`Sets talk speed for games <talkspeed>` (default: 60)"
- ``--tempo=NUM``,,"Sets music tempo (in percent, 50-200) for SCUMM games (default: 100)"
- ``--themepath=PATH``,,":ref:`Specifies path to where GUI themes are stored <themepath>`"
- ``--version``,``-v``,"Displays ScummVM version information and exits"
- ``--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-path=PATH``,,"Used with ``--md5`` or ```--md5mac`` to specify path of file to calculate MD5 hash of (default: ./scummvm)"
- ``--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. Of ``NUM`` is negative, the MD5 hash is calculated from the tail. Is overriden if passed with ``--md5-engine`` option. (default: 0)"
- ``--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 engineIds."
+ 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, se, 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-games``,``-z``, "Lists supported games, then exits.",
+ ``--list-records=TARGET``,, "Lists recordings 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-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 overriden 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, 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
+ - tv2x",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 bysome MIDI drivers.",
+ ``--speech-volume=NUM``,``-r``,":ref:`Sets the speech volume <speechvol>`, 0-255",192
+ ``--start-movie=NAME at 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.",
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/docportal/settings/misc.rst b/doc/docportal/settings/misc.rst
index a356129375c..45c79cb2483 100644
--- a/doc/docportal/settings/misc.rst
+++ b/doc/docportal/settings/misc.rst
@@ -21,6 +21,8 @@ Autosave
*autosave_period*
+.. _seed:
+
Random seed
Every time you start ScummVM, a random seed is generated. Use this option to set a fixed seed, which ensures that random events in games play out the same way every time.
Commit: e2f730074d5c0af2172ccfadd78beb66e2c72652
https://github.com/scummvm/scummvm/commit/e2f730074d5c0af2172ccfadd78beb66e2c72652
Author: CadiH (cadihowley at gmail.com)
Date: 2023-01-18T06:33:47+11:00
Commit Message:
DOCS: Fixes minor mistakes
- Reorders navigation headings
- Fixes indentation issue
Changed paths:
doc/docportal/index.rst
doc/docportal/settings/game.rst
diff --git a/doc/docportal/index.rst b/doc/docportal/index.rst
index c732078e05a..97bdd17e7f8 100644
--- a/doc/docportal/index.rst
+++ b/doc/docportal/index.rst
@@ -35,8 +35,8 @@
settings/cloud
settings/control
settings/game
- settings/gui
settings/graphics
+ settings/gui
settings/keymaps
settings/lan
settings/misc
diff --git a/doc/docportal/settings/game.rst b/doc/docportal/settings/game.rst
index 3e81119a775..a101f2e7aba 100644
--- a/doc/docportal/settings/game.rst
+++ b/doc/docportal/settings/game.rst
@@ -817,8 +817,8 @@ Start with debugger
.. _Myst3:
- Myst3
- *******
+Myst3
+*******
.. _widescreen_mod:
More information about the Scummvm-git-logs
mailing list