Add per-game archived cvars

Keep engine-level archived cvars in the global user config while writing controls and game-specific settings to the current game config.

Introduce CVAR_ARCHIVE_GAME as a mutually exclusive archive domain and load the global config before the game config when executing the legacy config entry point.

Author: Novum

Quake/bgmusic.c

@@ -29,7 +29,7 @@
 #define MUSIC_DIRNAME "music"
 
 static qboolean bgmloop;
-cvar_t			bgm_extmusic = {"bgm_extmusic", "1", CVAR_ARCHIVE};
+cvar_t			bgm_extmusic = {"bgm_extmusic", "1", CVAR_ARCHIVE_GAME};
 
 static qboolean no_extmusic = false;
 static float	old_volume = -1.0f;

Quake/cl_input.c

@@ -321,8 +321,8 @@ float CL_KeyState (kbutton_t *key)
 //==========================================================================
 
 cvar_t cl_upspeed = {"cl_upspeed", "200", CVAR_NONE};
-cvar_t cl_forwardspeed = {"cl_forwardspeed", "200", CVAR_ARCHIVE};
-cvar_t cl_backspeed = {"cl_backspeed", "200", CVAR_ARCHIVE};
+cvar_t cl_forwardspeed = {"cl_forwardspeed", "200", CVAR_ARCHIVE_GAME};
+cvar_t cl_backspeed = {"cl_backspeed", "200", CVAR_ARCHIVE_GAME};
 cvar_t cl_sidespeed = {"cl_sidespeed", "350", CVAR_NONE};
 
 cvar_t cl_movespeedkey = {"cl_movespeedkey", "2.0", CVAR_NONE};
@@ -332,7 +332,7 @@ cvar_t cl_pitchspeed = {"cl_pitchspeed", "150", CVAR_NONE};
 
 cvar_t cl_anglespeedkey = {"cl_anglespeedkey", "1.5", CVAR_NONE};
 
-cvar_t cl_alwaysrun = {"cl_alwaysrun", "1", CVAR_ARCHIVE}; // QuakeSpasm -- new always run
+cvar_t cl_alwaysrun = {"cl_alwaysrun", "1", CVAR_ARCHIVE_GAME}; // QuakeSpasm -- new always run
 
 /*
 ==============

Quake/cl_main.c

@@ -28,27 +28,27 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 // references them even when on a unix system.
 
 // these two are not intended to be set directly
-cvar_t cl_name = {"_cl_name", "player", CVAR_ARCHIVE | CVAR_USERINFO};
+cvar_t cl_name = {"_cl_name", "player", CVAR_ARCHIVE_GAME | CVAR_USERINFO};
 
-cvar_t cl_topcolor = {"topcolor", "0", CVAR_ARCHIVE | CVAR_USERINFO};
-cvar_t cl_bottomcolor = {"bottomcolor", "0", CVAR_ARCHIVE | CVAR_USERINFO};
+cvar_t cl_topcolor = {"topcolor", "0", CVAR_ARCHIVE_GAME | CVAR_USERINFO};
+cvar_t cl_bottomcolor = {"bottomcolor", "0", CVAR_ARCHIVE_GAME | CVAR_USERINFO};
 
 cvar_t cl_shownet = {"cl_shownet", "0", CVAR_NONE}; // can be 0, 1, or 2
 cvar_t cl_nolerp = {"cl_nolerp", "0", CVAR_NONE};
 
-cvar_t cfg_unbindall = {"cfg_unbindall", "1", CVAR_ARCHIVE};
+cvar_t cfg_unbindall = {"cfg_unbindall", "1", CVAR_ARCHIVE_GAME};
 
 cvar_t lookspring = {"lookspring", "0", CVAR_NONE};
 cvar_t lookstrafe = {"lookstrafe", "0", CVAR_NONE};
-cvar_t sensitivity = {"sensitivity", "3", CVAR_ARCHIVE};
+cvar_t sensitivity = {"sensitivity", "3", CVAR_ARCHIVE_GAME};
 
-cvar_t m_pitch = {"m_pitch", "0.022", CVAR_ARCHIVE};
-cvar_t m_yaw = {"m_yaw", "0.022", CVAR_ARCHIVE};
-cvar_t m_forward = {"m_forward", "1", CVAR_ARCHIVE};
-cvar_t m_side = {"m_side", "0.8", CVAR_ARCHIVE};
+cvar_t m_pitch = {"m_pitch", "0.022", CVAR_ARCHIVE_GAME};
+cvar_t m_yaw = {"m_yaw", "0.022", CVAR_ARCHIVE_GAME};
+cvar_t m_forward = {"m_forward", "1", CVAR_ARCHIVE_GAME};
+cvar_t m_side = {"m_side", "0.8", CVAR_ARCHIVE_GAME};
 
-cvar_t cl_maxpitch = {"cl_maxpitch", "90", CVAR_ARCHIVE};  // johnfitz -- variable pitch clamping
-cvar_t cl_minpitch = {"cl_minpitch", "-90", CVAR_ARCHIVE}; // johnfitz -- variable pitch clamping
+cvar_t cl_maxpitch = {"cl_maxpitch", "90", CVAR_ARCHIVE_GAME};	// johnfitz -- variable pitch clamping
+cvar_t cl_minpitch = {"cl_minpitch", "-90", CVAR_ARCHIVE_GAME}; // johnfitz -- variable pitch clamping
 
 cvar_t cl_startdemos = {"cl_startdemos", "1", CVAR_ARCHIVE};
 cvar_t cl_confirmquit = {"cl_confirmquit", "0", CVAR_ARCHIVE};

Quake/cmd.c

@@ -263,11 +263,6 @@ void Cmd_StuffCmds_f (void)
 	Cbuf_InsertText (cmds);
 }
 
-/*
-===============
-Cmd_Exec_f
-===============
-*/
 void Cmd_Exec_f (void)
 {
 	char	   *buf = NULL;
@@ -288,9 +283,9 @@ void Cmd_Exec_f (void)
 	if (legacy_config_alias)
 	{
 		FILE	   *f;
+		char	   *game_buf;
 		qfilesize_t length;
 
-		// "exec config.cfg" executes vkQuake.cfg from the user config directory.
 		f = COM_FOpenPrefFile (CONFIG_NAME, "rb");
 		if (f)
 		{
@@ -302,12 +297,34 @@ void Cmd_Exec_f (void)
 				buf = NULL;
 			}
 			else
-			{
 				buf[length] = 0;
-				display_path = CONFIG_NAME;
-			}
 			fclose (f);
 		}
+		game_buf = (char *)COM_LoadFile (path, NULL);
+		if (!buf && !game_buf)
+		{
+			if (cmd_warncmd.value)
+				Con_Printf ("couldn't exec %s\n", path);
+			return;
+		}
+
+		if (cmd_warncmd.value)
+		{
+			if (buf)
+				Con_Printf ("execing %s\n", CONFIG_NAME);
+			if (game_buf)
+				Con_Printf ("execing %s\n", path);
+		}
+
+		Cbuf_InsertText ("\n"); // just in case there was no trailing \n.
+		if (game_buf)
+			Cbuf_InsertText (game_buf);
+		if (buf)
+			Cbuf_InsertText (buf);
+
+		Mem_Free (game_buf);
+		Mem_Free (buf);
+		return;
 	}
 	else
 		buf = (char *)COM_LoadFile (path, NULL);

Quake/cvar.c

@@ -63,7 +63,9 @@ void Cvar_List_f (void)
 		{
 			continue;
 		}
-		Con_SafePrintf ("%s%s %s \"%s\"\n", (cvar->flags & CVAR_ARCHIVE) ? "*" : " ", (cvar->flags & CVAR_NOTIFY) ? "s" : " ", cvar->name, cvar->string);
+		Con_SafePrintf (
+			"%s%s %s \"%s\"\n", (cvar->flags & (CVAR_ARCHIVE | CVAR_ARCHIVE_GAME)) ? "*" : " ", (cvar->flags & CVAR_NOTIFY) ? "s" : " ", cvar->name,
+			cvar->string);
 		count++;
 	}
 
@@ -283,7 +285,7 @@ void Cvar_ResetCfg_f (void)
 	cvar_t *var;
 
 	for (var = cvar_vars; var; var = var->next)
-		if (var->flags & CVAR_ARCHIVE)
+		if (var->flags & (CVAR_ARCHIVE | CVAR_ARCHIVE_GAME))
 			Cvar_Reset (var->name);
 }
 
@@ -788,13 +790,13 @@ Writes lines containing "set variable value" for all variables
 with the archive flag set to true.
 ============
 */
-void Cvar_WriteVariables (FILE *f)
+void Cvar_WriteVariables (FILE *f, cvarflags_t archive_flag)
 {
 	cvar_t *var;
 
 	for (var = cvar_vars; var; var = var->next)
 	{
-		if (var->flags & CVAR_ARCHIVE)
+		if (var->flags & archive_flag)
 		{
 			if (var->flags & (CVAR_USERDEFINED | CVAR_SETA))
 				fprintf (f, "seta ");

Quake/cvar.h

@@ -66,11 +66,12 @@ interface from being ambiguous.
 typedef enum
 {
 	CVAR_NONE             = 0,
-	CVAR_ARCHIVE          = (1U << 0),	 // if set, causes it to be saved to config
-	CVAR_NOTIFY           = (1U << 1),	 // changes will be broadcasted to all players (q1)
-	CVAR_SERVERINFO       = (1U << 2),   // added to serverinfo will be sent to clients (q1/net_dgrm.c and qwsv)
-	CVAR_USERINFO         = (1U << 3),	 // added to userinfo, will be sent to server (qwcl)
-	CVAR_CHANGED          = (1U << 4),
+	CVAR_ARCHIVE          = (1U << 0),	 // saved to the global config
+	CVAR_ARCHIVE_GAME     = (1U << 1),	 // saved to the current game config
+	CVAR_NOTIFY           = (1U << 2),	 // changes will be broadcasted to all players (q1)
+	CVAR_SERVERINFO       = (1U << 3),   // added to serverinfo will be sent to clients (q1/net_dgrm.c and qwsv)
+	CVAR_USERINFO         = (1U << 4),	 // added to userinfo, will be sent to server (qwcl)
+	CVAR_CHANGED          = (1U << 5),
 	CVAR_ROM              = (1U << 6),
 	CVAR_LOCKED           = (1U << 8),	 // locked temporarily
 	CVAR_REGISTERED       = (1U << 10),  // the var is added to the list of variables
@@ -136,9 +137,9 @@ qboolean Cvar_Command (void);
 // command.  Returns true if the command was a variable reference that
 // was handled. (print or change)
 
-void Cvar_WriteVariables (FILE *f);
+void Cvar_WriteVariables (FILE *f, cvarflags_t archive_flag);
 // Writes lines containing "set variable value" for all variables
-// with the CVAR_ARCHIVE flag set
+// with the requested archive flag set
 
 cvar_t *Cvar_FindVar (const char *var_name);
 cvar_t *Cvar_FindVarAfter (const char *prev_name, unsigned int with_flags);

Quake/gl_model.c

@@ -34,8 +34,8 @@ static void		 Mod_LoadMD3Model (qmodel_t *mod, const void *buffer);
 static qmodel_t *Mod_LoadModel (qmodel_t *mod, qboolean crash);
 static void		 Mod_FreeModelMemory (qmodel_t *mod);
 
-cvar_t external_ents = {"external_ents", "1", CVAR_ARCHIVE};
-cvar_t external_vis = {"external_vis", "1", CVAR_ARCHIVE};
+cvar_t external_ents = {"external_ents", "1", CVAR_ARCHIVE_GAME};
+cvar_t external_vis = {"external_vis", "1", CVAR_ARCHIVE_GAME};
 
 // wad_external_textures = 1 enable loading of external WAD textures, 0 to forbid it for debug purposes.
 cvar_t wad_external_textures = {"wad_external_textures", "1", CVAR_NONE};
@@ -49,7 +49,7 @@ cvar_t r_allow_replacement_md5models = {"r_allow_replacement_md5models", "1", CV
 // r_allow_replacement_md3models = 1 allow loading of MD3 replacement models if available, 0 to forbid it for debug purposes.
 cvar_t r_allow_replacement_md3models = {"r_allow_replacement_md3models", "1", CVAR_NONE};
 
-cvar_t r_enhancedmodels = {"r_enhancedmodels", "1", CVAR_ARCHIVE}; // controlled in Menu with Models: enhanced (1) / classic (0)
+cvar_t r_enhancedmodels = {"r_enhancedmodels", "1", CVAR_ARCHIVE_GAME}; // controlled in Menu with Models: enhanced (1) / classic (0)
 
 static byte *mod_novis;
 static int	 mod_novis_capacity;

Quake/gl_screen.c

@@ -92,22 +92,22 @@ cvar_t scr_showfps = {"scr_showfps", "0", CVAR_ARCHIVE};
 cvar_t scr_clock = {"scr_clock", "0", CVAR_NONE};
 cvar_t scr_autoclock = {"scr_autoclock", "1", CVAR_ARCHIVE};
 cvar_t scr_usekfont = {"scr_usekfont", "0", CVAR_NONE}; // 2021 re-release
-cvar_t scr_style = {"scr_style", "0", CVAR_ARCHIVE};
-
-cvar_t scr_viewsize = {"viewsize", "100", CVAR_ARCHIVE};
-cvar_t scr_viewsize_allow_shrinking = {"viewsize_allow_shrinking", "0", CVAR_ARCHIVE};
-cvar_t scr_fov = {"fov", "90", CVAR_ARCHIVE}; // 10 - 170
-cvar_t scr_fov_adapt = {"fov_adapt", "1", CVAR_ARCHIVE};
-cvar_t scr_zoomfov = {"zoom_fov", "30", CVAR_ARCHIVE}; // 10 - 170
-cvar_t scr_zoomspeed = {"zoom_speed", "8", CVAR_ARCHIVE};
+cvar_t scr_style = {"scr_style", "0", CVAR_ARCHIVE_GAME};
+
+cvar_t scr_viewsize = {"viewsize", "100", CVAR_ARCHIVE_GAME};
+cvar_t scr_viewsize_allow_shrinking = {"viewsize_allow_shrinking", "0", CVAR_ARCHIVE_GAME};
+cvar_t scr_fov = {"fov", "90", CVAR_ARCHIVE_GAME}; // 10 - 170
+cvar_t scr_fov_adapt = {"fov_adapt", "1", CVAR_ARCHIVE_GAME};
+cvar_t scr_zoomfov = {"zoom_fov", "30", CVAR_ARCHIVE_GAME}; // 10 - 170
+cvar_t scr_zoomspeed = {"zoom_speed", "8", CVAR_ARCHIVE_GAME};
 cvar_t scr_conspeed = {"scr_conspeed", "500", CVAR_ARCHIVE};
 cvar_t scr_conanim = {"scr_conanim", "0", CVAR_ARCHIVE};
 cvar_t scr_centertime = {"scr_centertime", "2", CVAR_NONE};
 cvar_t scr_showturtle = {"showturtle", "0", CVAR_NONE};
 cvar_t scr_showpause = {"showpause", "1", CVAR_NONE};
 cvar_t scr_printspeed = {"scr_printspeed", "8", CVAR_NONE};
 
-cvar_t cl_gun_fovscale = {"cl_gun_fovscale", "1", CVAR_ARCHIVE}; // Qrack
+cvar_t cl_gun_fovscale = {"cl_gun_fovscale", "1", CVAR_ARCHIVE_GAME}; // Qrack
 
 // All scaling is done relative to resolution with scr_relativescale
 cvar_t scr_relativescale = {"scr_relativescale", "2", CVAR_ARCHIVE};

Quake/host.c

@@ -87,8 +87,8 @@ cvar_t coop = {"coop", "0", CVAR_NONE};				// 0 or 1
 
 cvar_t pausable = {"pausable", "1", CVAR_NONE};
 
-cvar_t autoload = {"autoload", "1", CVAR_ARCHIVE};
-cvar_t autofastload = {"autofastload", "0", CVAR_ARCHIVE};
+cvar_t autoload = {"autoload", "1", CVAR_ARCHIVE_GAME};
+cvar_t autofastload = {"autofastload", "0", CVAR_ARCHIVE_GAME};
 
 cvar_t developer = {"developer", "0", CVAR_NONE};
 cvar_t map_checks = {"map_checks", "0", CVAR_NONE};
@@ -409,33 +409,40 @@ void Host_InitLocal (void)
 ===============
 Host_WriteConfiguration
 
-Writes key bindings and archived cvars to the user config
+Writes archived cvars to the global config and game-local state to the
+current game config
 ===============
 */
 void Host_WriteConfiguration (void)
 {
-	FILE *f = NULL;
+	FILE *f;
 
 	// dedicated servers initialize the host but don't parse and set the config cvars
 	if (host_initialized && !isDedicated && !host_parms->errstate)
 	{
 		f = COM_FOpenPrefFile (CONFIG_NAME, "w");
 		if (!f)
 		{
-			Con_Printf ("Couldn't write " CONFIG_NAME ".\n");
+			Con_Printf ("Couldn't write global " CONFIG_NAME ".\n");
 			return;
 		}
 
 		// VID_SyncCvars (); //johnfitz -- write actual current mode to config file, in case cvars were messed with
 
-		Key_WriteBindings (f);
-		Cvar_WriteVariables (f);
-
-		// johnfitz -- extra commands to preserve state
+		Cvar_WriteVariables (f, CVAR_ARCHIVE);
 		fprintf (f, "vid_restart\n");
-		fprintf (f, "+mlook\n"); // always enable mouse look on config, can be overriden by -mlook in autoexec.cfg
-		// johnfitz
+		fclose (f);
 
+		f = Sys_fopen (va ("%s/" CONFIG_NAME, com_gamedir), "w");
+		if (!f)
+		{
+			Con_Printf ("Couldn't write game " CONFIG_NAME ".\n");
+			return;
+		}
+
+		Key_WriteBindings (f);
+		Cvar_WriteVariables (f, CVAR_ARCHIVE_GAME);
+		fprintf (f, "+mlook\n"); // always enable mouse look on config, can be overriden by -mlook in autoexec.cfg
 		fclose (f);
 	}
 }

Quake/in_sdl.c

@@ -29,18 +29,18 @@ static qboolean textmode;
 cvar_t in_debugkeys = {"in_debugkeys", "0", CVAR_NONE};
 
 // SDL Game Controller cvars
-static cvar_t joy_deadzone_look = {"joy_deadzone_look", "0.175", CVAR_ARCHIVE};
-static cvar_t joy_deadzone_move = {"joy_deadzone_move", "0.175", CVAR_ARCHIVE};
-static cvar_t joy_outer_threshold_look = {"joy_outer_threshold_look", "0.02", CVAR_ARCHIVE};
-static cvar_t joy_outer_threshold_move = {"joy_outer_threshold_move", "0.02", CVAR_ARCHIVE};
-static cvar_t joy_deadzone_trigger = {"joy_deadzone_trigger", "0.2", CVAR_ARCHIVE};
-static cvar_t joy_sensitivity_yaw = {"joy_sensitivity_yaw", "240", CVAR_ARCHIVE};
-static cvar_t joy_sensitivity_pitch = {"joy_sensitivity_pitch", "130", CVAR_ARCHIVE};
-static cvar_t joy_invert = {"joy_invert", "0", CVAR_ARCHIVE};
-static cvar_t joy_exponent = {"joy_exponent", "2", CVAR_ARCHIVE};
-static cvar_t joy_exponent_move = {"joy_exponent_move", "2", CVAR_ARCHIVE};
-static cvar_t joy_swapmovelook = {"joy_swapmovelook", "0", CVAR_ARCHIVE};
-static cvar_t joy_enable = {"joy_enable", "1", CVAR_ARCHIVE};
+static cvar_t joy_deadzone_look = {"joy_deadzone_look", "0.175", CVAR_ARCHIVE_GAME};
+static cvar_t joy_deadzone_move = {"joy_deadzone_move", "0.175", CVAR_ARCHIVE_GAME};
+static cvar_t joy_outer_threshold_look = {"joy_outer_threshold_look", "0.02", CVAR_ARCHIVE_GAME};
+static cvar_t joy_outer_threshold_move = {"joy_outer_threshold_move", "0.02", CVAR_ARCHIVE_GAME};
+static cvar_t joy_deadzone_trigger = {"joy_deadzone_trigger", "0.2", CVAR_ARCHIVE_GAME};
+static cvar_t joy_sensitivity_yaw = {"joy_sensitivity_yaw", "240", CVAR_ARCHIVE_GAME};
+static cvar_t joy_sensitivity_pitch = {"joy_sensitivity_pitch", "130", CVAR_ARCHIVE_GAME};
+static cvar_t joy_invert = {"joy_invert", "0", CVAR_ARCHIVE_GAME};
+static cvar_t joy_exponent = {"joy_exponent", "2", CVAR_ARCHIVE_GAME};
+static cvar_t joy_exponent_move = {"joy_exponent_move", "2", CVAR_ARCHIVE_GAME};
+static cvar_t joy_swapmovelook = {"joy_swapmovelook", "0", CVAR_ARCHIVE_GAME};
+static cvar_t joy_enable = {"joy_enable", "1", CVAR_ARCHIVE_GAME};
 
 #ifdef USE_SDL3
 #define SDL3_GET_WINDOW (SDL_Window *)VID_GetWindow ()