Merge branch 'release/3.8.0' into main

devtools/release.py

@@ -28,7 +28,7 @@
 RELEASE_FOLDER = "release." + str(os.getpid())
 QUAKE_FOLDER = os.path.join(RELEASE_FOLDER, "Quake")
 ENGINE_STAGING_FOLDER = "engine-staging"
-VKQ_VERSION = "1.20.3"
+VKQ_VERSION = "1.22.3"
 IW_VERSION = "0.6.0"
 SQL_VERSION = "2.5"
 VKQ_URL = "https://github.com/Novum/vkQuake/releases/download/{0}/vkquake-{0}_win64.zip".format(VKQ_VERSION)
@@ -175,10 +175,18 @@ def extracted_files(source_dir):
         if os.path.exists(f_dest):
             if filecmp.cmp(f, f_dest, shallow=False):
                 continue
-            if os.stat(f).st_mtime < os.stat(f_dest).st_mtime:
-                print("NOTE: file {} taken from {} since it is newer".format(f_base, source_a_name))
-                continue
-            print("NOTE: file {} taken from {} since it is newer".format(f_base, source_b_name))
+            # For now, privilege the OLDER version of SDL2.dll.
+            # Cf. https://github.com/neogeographica/quakestarter/issues/91
+            if f_base == "SDL2.dll":
+                if os.stat(f).st_mtime > os.stat(f_dest).st_mtime:
+                    print("NOTE: file {} taken from {} since it is older".format(f_base, source_a_name))
+                    continue
+                print("NOTE: file {} taken from {} since it is same or older".format(f_base, source_b_name))
+            else:
+                if os.stat(f).st_mtime < os.stat(f_dest).st_mtime:
+                    print("NOTE: file {} taken from {} since it is newer".format(f_base, source_a_name))
+                    continue
+                print("NOTE: file {} taken from {} since it is same or newer".format(f_base, source_b_name))
         shutil.copy2(f, QUAKE_FOLDER)
     source_a_set = set([os.path.basename(f) for f in source_a_files])
     source_b_set = set([os.path.basename(f) for f in source_b_files])

docsource/conf.py

@@ -51,15 +51,15 @@
 
 # General information about the project.
 project = 'Quakestarter'
-copyright = '2022, Joel Baxter'
+copyright = 'Joel Baxter'
 author = 'Joel Baxter'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The full version, including any pre-release tag.
-release = '3.7.0'
+release = '3.8.0'
 # And without that tag.
 version = release.split('-')[0]
 

docsource/other_stuff/auto_setup_logic.rst

@@ -15,9 +15,9 @@ If you just want to know how Quake installations from various stores can help th
 
 |br|
 
-* Quake soundtrack files (from the Quake rerelease) are provided by Steam, Xbox Game Pass, and the Epic Games Store. And although the Bethesda store has been shut down, existing Quake installations from the Bethesda store can also provide the soundtrack files.
+* Quake soundtrack files (from the Quake rerelease) are provided by Steam, GOG, Xbox Game Pass, and the Epic Games Store. And although the Bethesda store has been shut down, existing Quake installations from the Bethesda store can also provide the soundtrack files.
 
-So for example if you don't have any other Quake installations on your computer and don't have any Quake paks or soundtrack files on hand, doing an installation of Quake from Steam is the simplest one-shot way to fetch everything you need. After doing the Steam install you could then run Quakestarter and auto-setup the pak files and soundtrack into your new modern Quake singleplayer installation.
+So for example if you don't have any other Quake installations on your computer and don't have any Quake paks or soundtrack files on hand, doing an installation of Quake from Steam is a simple one-shot way to fetch everything you need. Another option would be to install both Quake and "Quake Enhanced" from GOG... the former gets you the paks, the latter the soundtrack. After doing the Steam or GOG install you could then run Quakestarter and auto-setup the pak files and soundtrack into your new modern Quake singleplayer installation.
 
 
 How Quakestarter knows where to look
@@ -45,6 +45,8 @@ The paths checked under each of those folders are:
 * Steam\\steamapps\\common\\Quake\\rerelease
 * GOG Games\\Quake
 * GOG Galaxy\\Games\\Quake
+* GOG Games\\Quake Enhanced
+* GOG Galaxy\\Games\\Quake Enhanced
 * XboxGames\\QUAKE\\Content
 * Epic Games\\Quake
 * Bethesda.net Launcher\\games\\Quake

docsource/other_stuff/changelog.rst

@@ -1,6 +1,23 @@
 Changelog
 =========
 
+.. rubric:: v3.8.0 (Jan 2023)
+
+New year, new stuff!
+
+One major part of this release is bumping the bundled vkQuake engine from version 1.20.3 to 1.22.3. This may not sound like a large difference, but check out the `vkQuake changelog`_ for the 1.22.x releases. Some cool stuff in there.
+
+This release also adds the recent GOG release of "Quake Enhanced" to the list of sources that the auto-setup assistant will use when trying to find soundtrack files for you.
+
+The main new addition to the installables is `Twisted Christmas Jam 2022`_, a sort of melding of the Halloween and Xmas map jams this time. Along with appearing in the Latest Greatest menu, it has also already qualified for the Next Generation episodes/hubs menu.
+
+`Empire of Disorder`_ has had a new version (2.4) released, with the previous version getting bumped into the legacies.
+
+The Copper_ gameplay mod has also had a version update to 1.20, so new installations of Copper-dependent releases will now use that version. And Copper 1.17 has aged out of the legacies menu.
+
+Finally, since several installables have been hovering under the ratings threshold for a while now, they get dropped into legacies: `Quake Condensed`_, `A Roman Wilderness Of Pain`_, `Deathmatch Classics Vol. 3`_, `768^2`_, `January Jump Jam 2`_, and `In The Shadows [Demo v1.1]`_.
+
+
 .. rubric:: v3.7.0 (Nov 2022)
 
 Your Quakestarter updates for November (drumroll)...
@@ -405,6 +422,10 @@ For older changelog entries, see the `1.x changelog`_ archived on GitHub.
 
 
 .. _quakestarter.com: http://quakestarter.com
+.. _vkQuake changelog: https://github.com/Novum/vkQuake/releases
+.. _Twisted Christmas Jam 2022: https://www.quaddicted.com/reviews/tcj_r3.html
+.. _768^2: https://www.quaddicted.com/reviews/sm198.html
+.. _In The Shadows [Demo v1.1]: https://www.quaddicted.com/reviews/its_demo_v1_1.html
 .. _Empire of Disorder: https://www.quaddicted.com/reviews/toneodspmp3_2_2.html
 .. _Sewer Jam 2: https://www.slipseer.com/index.php?resources/sewer-jam-2.149/
 .. _Rubicondom: https://www.quaddicted.com/reviews/sm82.html

docsource/other_stuff/pak_files.rst

@@ -29,7 +29,7 @@ If that process can't find your Quake pak files, you can go look for them yourse
 If you're manually copying pak files into a Quakestarter-managed Quake installation, you should also be careful to get the pak files from the original Quake and not the rerelease. You can easily tell the difference since the "id1" folder in the rerelease only contains "pak0.pak" and does not have a "pak1.pak". As of the last update to this part of the docs (April 2022), various stores provide original and/or rereleased Quake as follows:
 
 * Steam provides the original Quake and also the rerelease (in a "rerelease" subfolder)
-* GOG provides only the original
+* GOG provides the original Quake and also the rerelease (as a separate "Quake Enhanced" game)
 * Xbox Game Pass provides only the rerelease
 * Epic Games Store provides only the rerelease
 * Bethesda (store now shut down) provided only the rerelease

quakestarter_scripts/_install_quakefiles.cmd

@@ -52,8 +52,12 @@ call :reg_query_path_root_and_copy "HKCU\SOFTWARE\Valve\Steam" SteamPath "steama
 if exist "%dest%" goto :eof
 call :reg_query_and_copy "HKLM\SOFTWARE\WOW6432Node\GOG.com\Games\1435828198" PATH
 if exist "%dest%" goto :eof
+call :reg_query_and_copy "HKLM\SOFTWARE\WOW6432Node\GOG.com\Games\1739637082" PATH
+if exist "%dest%" goto :eof
 call :reg_query_and_copy "HKLM\SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\Uninstall\1435828198_is1" InstallLocation
 if exist "%dest%" goto :eof
+call :reg_query_and_copy "HKLM\SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\Uninstall\1739637082_is1" InstallLocation
+if exist "%dest%" goto :eof
 call :reg_query_path_root_and_copy "HKLM\SOFTWARE\WOW6432Node\Bethesda Softworks\Bethesda.net" installLocation "games\Quake"
 if exist "%dest%" goto :eof
 
@@ -108,6 +112,10 @@ call :search_common_paths "GOG Games\Quake"
 if exist "%dest%" goto :eof
 call :search_common_paths "GOG Galaxy\Games\Quake"
 if exist "%dest%" goto :eof
+call :search_common_paths "GOG Games\Quake Enhanced"
+if exist "%dest%" goto :eof
+call :search_common_paths "GOG Galaxy\Games\Quake Enhanced"
+if exist "%dest%" goto :eof
 call :search_common_paths "XboxGames\QUAKE\Content"
 if exist "%dest%" goto :eof
 call :search_common_paths "Epic Games\Quake"

quakestarter_scripts/_quakestarter_cfg_defaults.cmd

@@ -88,7 +88,7 @@ REM slow to update and a new version of AD/Copper has been released. Note that
 REM this must match the basename of a zip file in the Quaddicted filebase.
 
 set latest_ad=ad_v1_80p1final
-set latest_copper=copper_v1_19
+set latest_copper=copper_v1_20
 
 
 REM Whether to check for updates when starting Quakestarter, and if so what

quakestarter_scripts/episodes_latest.cmd

@@ -59,12 +59,12 @@ call :installed_check pun
 call :installed_check alkjam
 call :installed_check alkaline1.1
 call :installed_check xmasjam2021
-call :installed_check jjj2
 call :installed_check sm215
 call :installed_check snack2
 call :installed_check sm_217
 call :installed_check ctsj2_1.2
-call :installed_check toneodspmp3_2_3
+call :installed_check toneodspmp3_2_4
+call :installed_check tcj_r3
 echo.
 echo Selected custom episodes/hubs released from 2020 through 2022:
 echo %is_ctsj_installed%  1: ctsj - Coppertone Summer Jam
@@ -79,12 +79,12 @@ echo %is_pun_installed%  9: pun - The Punishment Due
 echo %is_alkjam_installed% 10: alkjam - Alkaline Jam
 echo %is_alkaline1.1_installed% 11: alkaline1.1 - Alkaline 1.1
 echo %is_xmasjam2021_installed% 12: xmasjam2021 - Xmas Jam 2021
-echo %is_jjj2_installed% 13: jjj2 - January Jump Jam 2
-echo %is_sm215_installed% 14: sm215 - Quad Run
-echo %is_snack2_installed% 15: snack2 - Speedmap Snack Pack 2 - Cosmic Hunger
-echo %is_sm_217_installed% 16: sm_217 - Remaster Textures
-echo %is_ctsj2_1.2_installed% 17: ctsj2_1.2 - Coppertone Summer Jam 2 v1.2
-echo %is_toneodspmp3_2_3_installed% 18: toneodspmp3_2_3 - Empire of Disorder v2.3
+echo %is_sm215_installed% 13: sm215 - Quad Run
+echo %is_snack2_installed% 14: snack2 - Speedmap Snack Pack 2 - Cosmic Hunger
+echo %is_sm_217_installed% 15: sm_217 - Remaster Textures
+echo %is_ctsj2_1.2_installed% 16: ctsj2_1.2 - Coppertone Summer Jam 2 v1.2
+echo %is_toneodspmp3_2_4_installed% 17: toneodspmp3_2_4 - Empire of Disorder v2.4
+echo %is_tcj_r3_installed% 18: Twisted Christmas Jam 2022 ^(Release 3^)
 echo.
 echo Enter a number to install/launch/manage one of the releases above.
 echo.
@@ -171,39 +171,38 @@ call "%scriptspath%_handle_mod_choice.cmd" xmasjam2021
 goto :menu
 
 :13
-set patch_url=https://neogeographica-downloads.s3.amazonaws.com/tools/quakestarter/jjj2_ish.zip
 set start_map=start
-set skip_quakerc_gen=true
-call "%scriptspath%_handle_mod_choice.cmd" jjj2
+call "%scriptspath%_handle_mod_choice.cmd" sm215
 goto :menu
 
 :14
 set start_map=start
-call "%scriptspath%_handle_mod_choice.cmd" sm215
+set skip_quakerc_gen=true
+call "%scriptspath%_handle_mod_choice.cmd" snack2
 goto :menu
 
 :15
 set start_map=start
 set skip_quakerc_gen=true
-call "%scriptspath%_handle_mod_choice.cmd" snack2
+call "%scriptspath%_handle_mod_choice.cmd" sm_217
 goto :menu
 
 :16
 set start_map=start
 set skip_quakerc_gen=true
-call "%scriptspath%_handle_mod_choice.cmd" sm_217
+call "%scriptspath%_handle_mod_choice.cmd" ctsj2_1.2
 goto :menu
 
 :17
-set start_map=start
-set skip_quakerc_gen=true
-call "%scriptspath%_handle_mod_choice.cmd" ctsj2_1.2
+set review_page=https://www.quaddicted.com/reviews/toneodspmp3_2_2.html
+set start_map=eod0
+call "%scriptspath%_handle_mod_choice.cmd" toneodspmp3_2_4
 goto :menu
 
 :18
-set review_page=https://www.quaddicted.com/reviews/toneodspmp3_2_2.html
-set start_map=eod_intro
-call "%scriptspath%_handle_mod_choice.cmd" toneodspmp3_2_3
+set start_map=start
+set skip_quakerc_gen=true
+call "%scriptspath%_handle_mod_choice.cmd" tcj_r3
 goto :menu
 
 

quakestarter_scripts/episodes_modern.cmd

@@ -51,14 +51,12 @@ call :installed_check oum
 call :installed_check rapture
 call :installed_check soe_full
 call :installed_check contract
-call :installed_check rpgsmse
 call :installed_check terra
 call :installed_check warpspasm
 call :installed_check travail
 call :installed_check rmx-pack
 call :installed_check nsoe2
 call :installed_check arcanum
-call :installed_check dmc3
 call :installed_check unforgiven
 call :installed_check rrp
 call :installed_check mapjam6
@@ -68,17 +66,15 @@ echo %is_oum_installed%  1: oum - Operation: Urth Majik ^(2001^)
 echo %is_rapture_installed%  2: rapture - Rapture ^(2001^)
 echo %is_soe_full_installed%  3: soe_full - Soul of Evil ^(2002^)
 echo %is_contract_installed%  4: contract - Contract Revoked ^(2002^)
-echo %is_rpgsmse_installed%  5: rpgsmse - Quake Condensed ^(2004^)
-echo %is_terra_installed%  6: terra - Terra ^(2005^)
-echo %is_warpspasm_installed%  7: warpspasm - Warp Spasm ^(2007^)
-echo %is_travail_installed%  8: travail - Travail ^(2007^)
-echo %is_rmx-pack_installed%  9: rmx-pack - Remix Map Pack ^(2008^)
-echo %is_nsoe2_installed% 10: nsoe2 - Soul of Evil: Indian Summer ^(2008^)
-echo %is_arcanum_installed% 11: arcanum - Arcanum ^(2011^)
-echo %is_dmc3_installed% 12: dmc3 - Deathmatch Classics Vol. 3 ^(2011^)
-echo %is_unforgiven_installed% 13: unforgiven - Unforgiven ^(2011^)
-echo %is_rrp_installed% 14: rrp - Rubicon Rumble Pack ^(2014^)
-echo %is_mapjam6_installed% 15: mapjam6 - Func Map Jam 6 - Fire and Brimstone ^(2015^)
+echo %is_terra_installed%  5: terra - Terra ^(2005^)
+echo %is_warpspasm_installed%  6: warpspasm - Warp Spasm ^(2007^)
+echo %is_travail_installed%  7: travail - Travail ^(2007^)
+echo %is_rmx-pack_installed%  8: rmx-pack - Remix Map Pack ^(2008^)
+echo %is_nsoe2_installed%  9: nsoe2 - Soul of Evil: Indian Summer ^(2008^)
+echo %is_arcanum_installed% 10: arcanum - Arcanum ^(2011^)
+echo %is_unforgiven_installed% 11: unforgiven - Unforgiven ^(2011^)
+echo %is_rrp_installed% 12: rrp - Rubicon Rumble Pack ^(2014^)
+echo %is_mapjam6_installed% 13: mapjam6 - Func Map Jam 6 - Fire and Brimstone ^(2015^)
 echo.
 echo Enter a number to install/launch/manage one of the releases above.
 echo.
@@ -118,24 +114,19 @@ call "%scriptspath%_handle_mod_choice.cmd" contract
 goto :menu
 
 :5
-set start_map=rpgsmse1
-call "%scriptspath%_handle_mod_choice.cmd" rpgsmse
-goto :menu
-
-:6
 set start_map=terra1
 call "%scriptspath%_handle_mod_choice.cmd" terra
 goto :menu
 
-:7
+:6
 set base_game=quoth
 set start_map=start
 set skip_quakerc_gen=true
 set startdemos=demo1 demo2 demo3
 call "%scriptspath%_handle_mod_choice.cmd" warpspasm
 goto :menu
 
-:8
+:7
 set patch_url=https://neogeographica-downloads.s3.amazonaws.com/tools/quakestarter/quake_travail_soundtrack.zip
 set start_map=start
 set startdemos=demo1 demo2 demo3
@@ -145,43 +136,37 @@ set modsettings[2]=
 call "%scriptspath%_handle_mod_choice.cmd" travail
 goto :menu
 
-:9
+:8
 set start_map=start
 call "%scriptspath%_handle_mod_choice.cmd" rmx-pack
 goto :menu
 
-:10
+:9
 set start_map=start
 set startdemos=demo1 demo2
 call "%scriptspath%_handle_mod_choice.cmd" nsoe2
 goto :menu
 
-:11
+:10
 set patch_url=https://www.quaddicted.com/filebase/drake290111.zip
 REM unlike other patches the Drake mod is really truly always required here
 set patch_required=true
 set start_map=arcstart
 call "%scriptspath%_handle_mod_choice.cmd" arcanum
 goto :menu
 
-:12
-set patch_url=https://quaketastic.com/files/single_player/maps/dmc3m8_hotfix.zip
-set start_map=dmc3
-call "%scriptspath%_handle_mod_choice.cmd" dmc3
-goto :menu
-
-:13
+:11
 set start_map=unfstart
 call "%scriptspath%_handle_mod_choice.cmd" unforgiven
 goto :menu
 
-:14
+:12
 set start_map=start
 set skip_quakerc_gen=true
 call "%scriptspath%_handle_mod_choice.cmd" rrp
 goto :menu
 
-:15
+:13
 set start_map=start
 set startdemos=demo1
 set modsettings[0]=r_wateralpha 1