Merge branch 'release/3.9.0' into main

docsource/conf.py

@@ -59,7 +59,7 @@
 # built documents.
 #
 # The full version, including any pre-release tag.
-release = '3.8.0'
+release = '3.9.0'
 # And without that tag.
 version = release.split('-')[0]
 

docsource/other_stuff/changelog.rst

@@ -1,6 +1,17 @@
 Changelog
 =========
 
+.. rubric:: v3.9.0 (Feb 2023)
+
+A new version of Dwell_ has been released, not only updating its first episode extensively but also adding a whole new episode. One of the best ever Quake singleplayer releases is now better! So, of course we should update Quakestarter to get the new Dwell version into the Latest Greatest menu. This is that.
+
+Other minor changes:
+
+* The vkQuake feature list in the :doc:`Quake Engines<quake_engines>` chapter has been updated to reflect the newer vkQuake version. Should have done that last release!
+* Version 1.0 of `Coppertone Summer Jam 2`_ has aged out of the legacies menu. Version 1.2 has also aged out of the Latest Greatest menu, but is still ensconced in the Next Generation episodes/hubs menu.
+* And of course, the original Dwell release has dropped into the legacies menu.
+
+
 .. rubric:: v3.8.0 (Jan 2023)
 
 New year, new stuff!
@@ -422,6 +433,7 @@ For older changelog entries, see the `1.x changelog`_ archived on GitHub.
 
 
 .. _quakestarter.com: http://quakestarter.com
+.. _Dwell: https://www.slipseer.com/index.php?resources/dwell.21/
 .. _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

docsource/other_stuff/quake_engines.rst

@@ -18,38 +18,36 @@ Quakestarter is bundled with the vkQuake_ and Ironwail_ engines, with vkQuake se
 
 vkQuake uses the Vulkan API for rendering, while Ironwail uses some advanced features of OpenGL. It's possible that one will perform better than the other on your system, depending on your graphics drivers and the relative beefiness of your CPU vs your GPU. In all likelihood though, on a modern system both of these engines will crank out more frames-per-second than you will ever need, so the choice might come down to some other features.
 
-Here's a quick rundown of some of the most user-visible features that these engines have added on top of the Quakespasm baseline. 
+Below is a quick rundown of some of the most user-visible features that these engines have added on top of the Quakespasm baseline. Over time there has been a lot of feature-sharing between these two engines, so in broad strokes they now offer a lot of the same benefits.
 
 =================== =======   ========
 feature             vkQuake   Ironwail
 =================== =======   ========
 mod loading UI        yes        yes
-weapon binding UI      no        yes
-use mouse in UI        no        yes
+weapon binding UI     yes        yes
+use mouse in UI       yes        yes
 unlocked fps          yes        yes
 custom particles      yes         no
 HUD variants           no        yes
 custom HUDs           yes         no*
 8-bit emulation       yes        yes
-detect Steam paks      no        yes
 lit water support     yes        yes
 classic waterwarp     yes        yes
 multi game dirs       yes        yes
 drag-resize window    yes         no
 protocol extensions   yes         no
 =================== =======   ========
 
-And a blurb about each of these features:
+A blurb about each of those features:
 
 * mod loading UI: An in-game menu to activate a mod folder.
 * weapon binding UI: Support in the in-game controls menu for binding individual weapons to keys. (Otherwise these binds can be done with config file edits.)
 * use mouse in UI: Whether the mouse can be used to work the in-game menus.
 * unlocked fps: The ability to use framerate caps higher than 72 FPS without causing issues with the game physics.
 * custom particles: Support for mod-defined particle systems, such as found in Arcane Dimensions and Alkaline.
 * HUD variants: Support for a predefined selection of HUD layouts.
-* custom HUDs: Support for mod-defined HUD graphics, such as found in Arcane Dimensions and Alkaline. (Ironwail has this feature on its roadmap, but the version bundled with this release of Quakestarter does not yet support it.)
+* custom HUDs: Support for mod-defined HUD graphics, such as found in Arcane Dimensions and Alkaline. (Ironwail has this feature in its development branch, but the released version does not yet support it.)
 * 8-bit emulation: Optional setting to emulate the palettized rendering of original DOS/WinQuake.
-* detect Steam paks: The ability to run using the gamedata from an existing Steam installation of Quake, without needing to find and copy the pak files. This doesn't matter when using Quakestarter, which does its own method of pak-finding, but can be handy otherwise.
 * lit water support: Support for rendering shadows on the surfaces of liquids, for recent maps that have been compiled in a way that generates that shadow information.
 * classic waterwarp: Emulation for the underwater warping effect of original DOS/WinQuake (as opposed to the different GLQuake effect).
 * multi game dirs: The ability to activate more than one mod folder, beyond the hardcoded support for only Quoth and missionpacks found in some engines. Quakestarter depends on this feature for launching a few of the addons that depend on Copper or Arcane Dimensions.

quakestarter_scripts/episodes_latest.cmd

@@ -49,7 +49,6 @@ set junkdirs=
 cls
 call :installed_check ctsj
 call :installed_check dtintin_fixed
-call :installed_check dwellv1p2
 call :installed_check ad_v1_80p1final
 call :installed_check eoe
 call :installed_check hwjam3
@@ -69,22 +68,21 @@ echo.
 echo Selected custom episodes/hubs released from 2020 through 2022:
 echo %is_ctsj_installed%  1: ctsj - Coppertone Summer Jam
 echo %is_dtintin_fixed_installed%  2: dtintin_fixed - Doom Tintin Jam
-echo %is_dwellv1p2_installed%  3: dwellv1p2 - Dwell - Episode 1
-echo %is_ad_v1_80p1final_installed%  4: ad_v1_80p1final - Arcane Dimensions 1.81
-echo %is_eoe_installed%  5: eoe - Epochs of Enmity
-echo %is_hwjam3_installed%  6: hwjam3 - Halloween Jam 3
-echo %is_xmasjam2020_installed%  7: xmasjam2020 - Xmas Jam 2020
-echo %is_smej2_1.1_installed%  8: smej2_1.1 - Torrent of Impurities ^(Epaepuhtauksien Virta^)
-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_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 %is_ad_v1_80p1final_installed%  3: ad_v1_80p1final - Arcane Dimensions 1.81
+echo %is_eoe_installed%  4: eoe - Epochs of Enmity
+echo %is_hwjam3_installed%  5: hwjam3 - Halloween Jam 3
+echo %is_xmasjam2020_installed%  6: xmasjam2020 - Xmas Jam 2020
+echo %is_smej2_1.1_installed%  7: smej2_1.1 - Torrent of Impurities ^(Epaepuhtauksien Virta^)
+echo %is_pun_installed%  8: pun - The Punishment Due
+echo %is_alkjam_installed%  9: alkjam - Alkaline Jam
+echo %is_alkaline1.1_installed% 10: alkaline1.1 - Alkaline 1.1
+echo %is_xmasjam2021_installed% 11: xmasjam2021 - Xmas Jam 2021
+echo %is_sm215_installed% 12: sm215 - Quad Run
+echo %is_snack2_installed% 13: snack2 - Speedmap Snack Pack 2 - Cosmic Hunger
+echo %is_sm_217_installed% 14: sm_217 - Remaster Textures
+echo %is_ctsj2_1.2_installed% 15: ctsj2_1.2 - Coppertone Summer Jam 2 v1.2
+echo %is_toneodspmp3_2_4_installed% 16: toneodspmp3_2_4 - Empire of Disorder v2.4
+echo %is_tcj_r3_installed% 17: tcj_r3 - Twisted Christmas Jam 2022 ^(Release 3^)
 echo.
 echo Enter a number to install/launch/manage one of the releases above.
 echo.
@@ -112,94 +110,88 @@ goto :menu
 :3
 set start_map=start
 set skip_quakerc_gen=true
-call "%scriptspath%_handle_mod_choice.cmd" dwellv1p2
-goto :menu
-
-:4
-set start_map=start
-set skip_quakerc_gen=true
 call "%scriptspath%_handle_mod_choice.cmd" ad_v1_80p1final
 goto :menu
 
-:5
+:4
 set patch_url=https://neogeographica-downloads.s3.amazonaws.com/tools/quakestarter/eoem7_fix_pak.zip
 set start_map=start
 call "%scriptspath%_handle_mod_choice.cmd" eoe
 goto :menu
 
-:6
+:5
 set patch_url=https://neogeographica-downloads.s3.amazonaws.com/tools/quakestarter/hwjam3_fixes.zip
 set start_map=start
 set skip_quakerc_gen=true
 call "%scriptspath%_handle_mod_choice.cmd" hwjam3
 goto :menu
 
-:7
+:6
 set start_map=start
 set skip_quakerc_gen=true
 call "%scriptspath%_handle_mod_choice.cmd" xmasjam2020
 goto :menu
 
-:8
+:7
 set start_map=start
 set skip_quakerc_gen=true
 set startdemos=demo3 demo2 demo1
 call "%scriptspath%_handle_mod_choice.cmd" smej2_1.1
 goto :menu
 
-:9
+:8
 set start_map=start
 call "%scriptspath%_handle_mod_choice.cmd" pun
 goto :menu
 
-:10
+:9
 set start_map=start
 set skip_quakerc_gen=true
 call "%scriptspath%_handle_mod_choice.cmd" alkjam
 goto :menu
 
-:11
+:10
 set start_map=start
 set skip_quakerc_gen=true
 call "%scriptspath%_handle_mod_choice.cmd" alkaline1.1
 goto :menu
 
-:12
+:11
 set start_map=start
 set skip_quakerc_gen=true
 call "%scriptspath%_handle_mod_choice.cmd" xmasjam2021
 goto :menu
 
-:13
+:12
 set start_map=start
 call "%scriptspath%_handle_mod_choice.cmd" sm215
 goto :menu
 
-:14
+:13
 set start_map=start
 set skip_quakerc_gen=true
 call "%scriptspath%_handle_mod_choice.cmd" snack2
 goto :menu
 
-:15
+:14
 set start_map=start
 set skip_quakerc_gen=true
 call "%scriptspath%_handle_mod_choice.cmd" sm_217
 goto :menu
 
-:16
+:15
 set start_map=start
 set skip_quakerc_gen=true
 call "%scriptspath%_handle_mod_choice.cmd" ctsj2_1.2
 goto :menu
 
-:17
+:16
 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
+:17
 set start_map=start
 set skip_quakerc_gen=true
 call "%scriptspath%_handle_mod_choice.cmd" tcj_r3

quakestarter_scripts/legacies.cmd

@@ -47,8 +47,8 @@ call :installed_check sm198 rating
 call :installed_check jjj2 rating
 call :installed_check plaw02 rating
 call :installed_check markiesm1v2 rating
+call :installed_check dwellv1p2 version
 call :installed_check copper_v1_19 version
-call :installed_check ctsj2 version
 call :installed_check toneodspmp3_2_3 version
 
 REM if called with "check" arg just decide whether to show this menu at all
@@ -143,11 +143,11 @@ if "%show_rating%"=="true" (
 )
 if "%show_version%"=="true" (
   echo Dropped because superseded by a newer version:
-  if "%show_copper_v1_19%"=="true" (
-    echo %is_copper_v1_19_installed% 16: copper_v1_19 - Copper 1.19 ^(2022^)
+  if "%show_dwellv1p2%"=="true" (
+    echo %is_dwellv1p2_installed% 16: dwellv1p2 - Dwell - Episode 1 ^(2020^)
   )
-  if "%show_ctsj2%"=="true" (
-    echo %is_ctsj2_installed% 17: ctsj2 - Coppertone Summer Jam 2 v1.0 ^(2022^)
+  if "%show_copper_v1_19%"=="true" (
+    echo %is_copper_v1_19_installed% 17: copper_v1_19 - Copper 1.19 ^(2022^)
   )
   if "%show_toneodspmp3_2_3%"=="true" (
     echo %is_toneodspmp3_2_3_installed% 18: toneodspmp3_2_3 - Empire of Disorder v2.3 ^(2022^)
@@ -198,7 +198,7 @@ set start_map=czgtoxic
 call "%scriptspath%_handle_mod_choice.cmd" czgtoxic
 goto :menu
 
-REM Quake Condensed should age out six months after v3.8.0
+REM Quake Condensed should age out after 7/30/2023
 :4
 if not "%show_rpgsmse%"=="true" (
   goto :eof
@@ -234,7 +234,7 @@ set start_map=fmb_bdg1
 call "%scriptspath%_handle_mod_choice.cmd" fmb_bdg
 goto :menu
 
-REM A Roman Wilderness Of Pain should age out six months after v3.8.0
+REM A Roman Wilderness Of Pain should age out after 7/30/2023
 :8
 if not "%show_arwop%"=="true" (
   goto :eof
@@ -244,7 +244,7 @@ set startdemos=demo1
 call "%scriptspath%_handle_mod_choice.cmd" arwop
 goto :menu
 
-REM Deathmatch Classics Vol. 3 should age out six months after v3.8.0
+REM Deathmatch Classics Vol. 3 should age out after 7/30/2023
 :9
 if not "%show_dmc3%"=="true" (
   goto :eof
@@ -254,7 +254,7 @@ set start_map=dmc3
 call "%scriptspath%_handle_mod_choice.cmd" dmc3
 goto :menu
 
-REM In The Shadows [Demo v1.1] should age out six months after v3.8.0
+REM In The Shadows [Demo v1.1] should age out after 7/30/2023
 :10
 if not "%show_its_demo_v1_1%"=="true" (
   goto :eof
@@ -276,7 +276,7 @@ set start_map=retrojam4dlc_pulsar
 call "%scriptspath%_handle_mod_choice.cmd" retrojam4dlc_pulsar
 goto :menu
 
-REM 768^^2 should age out six months after v3.8.0
+REM 768^^2 should age out after 7/30/2023
 :12
 if not "%show_sm198%"=="true" (
   goto :eof
@@ -285,7 +285,7 @@ set start_map=start
 call "%scriptspath%_handle_mod_choice.cmd" sm198
 goto :menu
 
-REM January Jump Jam 2 should age out six months after v3.8.0
+REM January Jump Jam 2 should age out after 7/30/2023
 :13
 if not "%show_jjj2%"=="true" (
   goto :eof
@@ -321,27 +321,27 @@ set start_map=markiesm1
 call "%scriptspath%_handle_mod_choice.cmd" markiesm1v2
 goto :menu
 
-REM Copper 1.19 should age out six months after v3.8.0
+REM Dwell - Episode 1 should age out six months after v3.9.0
 :16
-if not "%show_copper_v1_19%"=="true" (
+if not "%show_dwellv1p2%"=="true" (
   goto :eof
 )
 set start_map=start
 set skip_quakerc_gen=true
-call "%scriptspath%_handle_mod_choice.cmd" copper_v1_19
+call "%scriptspath%_handle_mod_choice.cmd" dwellv1p2
 goto :menu
 
-REM Coppertone Summer Jam 2 v1.0 should age out after 2/11/2023
+REM Copper 1.19 should age out after 7/30/2023
 :17
-if not "%show_ctsj2%"=="true" (
+if not "%show_copper_v1_19%"=="true" (
   goto :eof
 )
 set start_map=start
 set skip_quakerc_gen=true
-call "%scriptspath%_handle_mod_choice.cmd" ctsj2
+call "%scriptspath%_handle_mod_choice.cmd" copper_v1_19
 goto :menu
 
-REM Empire of Disorder v2.3 should age out six months after v3.8.0
+REM Empire of Disorder v2.3 should age out after 7/30/2023
 :18
 if not "%show_toneodspmp3_2_3%"=="true" (
   goto :eof