Read game information from gameinfo.conf file, fix Unvanquished/Unvanquished#817

Co-authored-by: Sebastian Schmidt <schro.sb@gmail.com>
Co-authored-by: Thomas “illwieckz” Debesse <dev@illwieckz.net>

Author: DefaultUser

src.cmake

@@ -248,6 +248,8 @@ set(ENGINELIST
     ${ENGINE_DIR}/sys/con_common.h
     ${ENGINE_DIR}/sys/con_common.cpp
     ${ENGINE_DIR}/sys/sys_events.h
+    ${ENGINE_DIR}/qcommon/gameinfo.h
+    ${ENGINE_DIR}/qcommon/gameinfo.cpp
 )
 
 if (WIN32)

src/common/Defs.h

@@ -31,38 +31,26 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #ifndef COMMON_DEFS_H_
 #define COMMON_DEFS_H_
 
-#define PRODUCT_NAME        "Unvanquished"
-/** Case, No spaces */
-#define PRODUCT_NAME_UPPER  "UNVANQUISHED"
-/** No case, No spaces */
-#define PRODUCT_NAME_LOWER  "unvanquished"
+#ifndef ENGINE_NAME
+#define ENGINE_NAME "Daemon Engine"
+#endif
 
-#define PRODUCT_VERSION     "0.52.1"
+#ifndef ENGINE_VERSION
+#define ENGINE_VERSION "0.52.1"
+#endif
 
-/** Default base package */
-#define DEFAULT_BASE_PAK    PRODUCT_NAME_LOWER
-
-/** URI scheme and server browser filter */
-#define GAMENAME_STRING     "unv"
-#define GAMENAME_FOR_MASTER PRODUCT_NAME_UPPER
+#ifndef ENGINE_DATE
+#define ENGINE_DATE __DATE__
+#endif
 
 #define MAX_MASTER_SERVERS  5
-#define MASTER1_SERVER_NAME "master.unvanquished.net"
-#define MASTER2_SERVER_NAME "master2.unvanquished.net"
-#define MASTER3_SERVER_NAME ""
-#define MASTER4_SERVER_NAME ""
-#define MASTER5_SERVER_NAME ""
-
-#define WWW_BASEURL         "dl.unvanquished.net/pkg"
-
 #define AUTOEXEC_NAME       "autoexec.cfg"
 
 #define CONFIG_NAME         "autogen.cfg"
 #define KEYBINDINGS_NAME    "keybindings.cfg"
 #define TEAMCONFIG_NAME     "teamconfig.cfg"
 
 #define UNNAMED_PLAYER      "UnnamedPlayer"
-#define UNNAMED_SERVER      PRODUCT_NAME " " PRODUCT_VERSION " Server"
 
 /** file containing our RSA public and private keys */
 #define RSAKEY_FILE        "pubkey"

src/common/FileSystem.cpp

@@ -2332,19 +2332,19 @@ std::string DefaultHomePath()
 	wchar_t buffer[MAX_PATH];
 	if (!SUCCEEDED(SHGetFolderPathW(nullptr, CSIDL_PERSONAL, nullptr, SHGFP_TYPE_CURRENT, buffer)))
 		return "";
-	return Str::UTF16To8(buffer) + "\\My Games\\" PRODUCT_NAME;
+	return Str::UTF16To8(buffer) + "\\My Games\\" + Gameinfo::getInstance().name();
 #else
 	const char* home = getenv("HOME");
 	if (!home)
 		return "";
 #ifdef __APPLE__
-	return std::string(home) + "/Library/Application Support/" PRODUCT_NAME;
+	return std::string(home) + "/Library/Application Support/" + Gameinfo::getInstance().name();
 #else
 	const char* _xdgDataHome = getenv("XDG_DATA_HOME");
 	std::string xdgDataHome = _xdgDataHome == nullptr ? Path::Build(Path::Build(std::string(home), ".local") ,"share") : std::string(_xdgDataHome);
 	std::string xdgHomePath;
 
-	xdgHomePath = Path::Build(xdgDataHome, PRODUCT_NAME_LOWER);
+	xdgHomePath = Path::Build(xdgDataHome, Gameinfo::getInstance().name_lower());
 
 	return xdgHomePath;
 #endif

src/engine/client/ClientApplication.cpp

@@ -98,7 +98,7 @@ class ClientApplication : public Application {
         void Shutdown(bool error, Str::StringRef message) override {
             #if defined(_WIN32) || defined(BUILD_GRAPHICAL_CLIENT)
                 if (error) {
-                    SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, PRODUCT_NAME, message.c_str(), nullptr);
+                    SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, ENGINE_NAME, message.c_str(), nullptr);
                 }
             #endif
 

src/engine/client/cl_console.cpp

@@ -688,8 +688,8 @@ void Con_DrawAboutText()
 	//ANIMATION_TYPE_FADE but also ANIMATION_TYPE_SCROLL_DOWN needs this, latter, since it might otherwise scroll out the console
 	color.SetAlpha( 0.66f * consoleState.currentAnimationFraction );
 
-	Con_DrawRightFloatingTextLine( 0, color, Q3_VERSION );
-	Con_DrawRightFloatingTextLine( 1, color, Q3_ENGINE );
+	Con_DrawRightFloatingTextLine( 0, color, GAME_NAME_VERSION );
+	Con_DrawRightFloatingTextLine( 1, color, ENGINE_NAME_VERSION );
 }
 
 /*

src/engine/client/cl_main.cpp

@@ -1018,9 +1018,10 @@ void CL_Connect_f()
 	}
 
 	// Skip the URI scheme.
-	if ( !Q_strnicmp( server, URI_SCHEME, URI_SCHEME_LENGTH ) )
+	std::string uri_scheme = Str::Format("%s://", Gameinfo::getInstance().uriprotocol());
+	if ( !Q_strnicmp( server, uri_scheme.c_str(), uri_scheme.length() ) )
 	{
-		server += URI_SCHEME_LENGTH;
+		server += uri_scheme.length();
 	}
 
 	// Set and skip the password.
@@ -2894,7 +2895,7 @@ void CL_Init()
 
 	p_team = Cvar_Get("p_team", "0", CVAR_ROM );
 
-	cl_gamename = Cvar_Get( "cl_gamename", GAMENAME_FOR_MASTER, CVAR_TEMP );
+	cl_gamename = Cvar_Get( "cl_gamename", Gameinfo::getInstance().name_upper().c_str(), CVAR_TEMP );
 	cl_altTab = Cvar_Get( "cl_altTab", "1", 0 );
 
 	//bani
@@ -3112,7 +3113,7 @@ void CL_ServerInfoPacket( const netadr_t& from, msg_t *msg )
 	// Arnout: if this isn't the correct game, ignore it
 	gameName = Info_ValueForKey( infoString, "gamename" );
 
-	if ( !gameName[ 0 ] || Q_stricmp( gameName, GAMENAME_STRING ) )
+	if ( !gameName[ 0 ] || Q_stricmp( gameName, Gameinfo::getInstance().gamename().c_str() ) )
 	{
 		Log::Debug( "Different game info packet: %s", infoString );
 		return;

src/engine/client/dl_main.cpp

@@ -169,8 +169,8 @@ if (curl_easy_setopt(request_, option, value) != CURLE_OK) { \
 	return false; \
 }
 
-		SETOPT( CURLOPT_USERAGENT, Str::Format( "%s %s", PRODUCT_NAME "/" PRODUCT_VERSION, curl_version() ).c_str() )
-		SETOPT( CURLOPT_REFERER, Str::Format("%s%s", URI_SCHEME, Cvar::GetValue("cl_currentServerIP")).c_str() )
+		SETOPT( CURLOPT_USERAGENT, Str::Format( "%s %s", ENGINE_NAME "/" ENGINE_VERSION, curl_version() ).c_str() )
+		SETOPT( CURLOPT_REFERER, Str::Format("%s://%s", Gameinfo::getInstance().uriprotocol().c_str(), Cvar::GetValue("cl_currentServerIP")).c_str() )
 		SETOPT( CURLOPT_URL, url.c_str() )
 		SETOPT( CURLOPT_PROTOCOLS, long(CURLPROTO_HTTP) )
 		SETOPT( CURLOPT_WRITEFUNCTION, curl_write_callback(LibcurlWriteCallback) )

src/engine/framework/System.cpp

@@ -71,12 +71,12 @@ std::string GetSingletonSocketPath()
 	char homePathHash[33] = "";
 	Com_MD5Buffer(homePath.data(), homePath.size(), homePathHash, sizeof(homePathHash));
 #ifdef _WIN32
-	return std::string("\\\\.\\pipe\\" PRODUCT_NAME) + suffix + "-" + homePathHash;
+	return std::string("\\\\.\\pipe\\") + Gameinfo::getInstance().name() + suffix + "-" + homePathHash;
 #else
 	// We use a temporary directory rather that using the homepath because
 	// socket paths are limited to about 100 characters. This also avoids issues
 	// when the homepath is on a network filesystem.
-	return std::string("/tmp/." PRODUCT_NAME_LOWER) +  suffix + "-" + homePathHash + "/socket";
+	return std::string("/tmp/.") + Gameinfo::getInstance().name_lower() +  suffix + "-" + homePathHash + "/socket";
 #endif
 }
 
@@ -408,7 +408,7 @@ static void StartSignalThread()
 // Command line arguments
 struct cmdlineArgs_t {
 	cmdlineArgs_t()
-		: homePath(FS::DefaultHomePath()), libPath(FS::DefaultBasePath()), reset_config(false), use_curses(Application::GetTraits().useCurses) {}
+		: homePath(""), libPath(FS::DefaultBasePath()), reset_config(false), use_curses(Application::GetTraits().useCurses) {}
 
 	std::string homePath;
 	std::string libPath;
@@ -467,7 +467,7 @@ static void ParseCmdline(int argc, char** argv, cmdlineArgs_t& cmdlineArgs)
 		}
 
 		if (!strcmp(argv[i], "--help") || !strcmp(argv[i], "-help")) {
-			std::string helpUrl = Application::GetTraits().supportsUri ? " | -connect " URI_SCHEME "ADDRESS[:PORT]" : "";
+			std::string helpUrl = Application::GetTraits().supportsUri ? Str::Format(" [%s://ADDRESS[:PORT]]", Gameinfo::getInstance().uriprotocol()) : "";
 			printf("Usage: %s [-OPTION]... [+COMMAND...%s]\n", argv[0], helpUrl.c_str());
 			printf("Possible options are:\n"
 			       "  -homepath <path>         set the path used for user-specific configuration files and downloaded dpk files\n"
@@ -482,7 +482,7 @@ static void ParseCmdline(int argc, char** argv, cmdlineArgs_t& cmdlineArgs)
 			);
 			OSExit(0);
 		} else if (!strcmp(argv[i], "--version") || !strcmp(argv[i], "-version")) {
-			printf(PRODUCT_NAME " " PRODUCT_VERSION "\n");
+			printf(ENGINE_NAME_VERSION "\n");
 			OSExit(0);
 		} else if (!strcmp(argv[i], "-set")) {
 			if (i >= argc - 2) {
@@ -549,16 +549,21 @@ static void Init(int argc, char** argv)
 #endif
 
 	// Print a banner and a copy of the command-line arguments
-	Log::Notice(Q3_VERSION " " PLATFORM_STRING " " ARCH_STRING " " __DATE__);
 	std::string argsString = "cmdline:";
 	for (int i = 1; i < argc; i++) {
 		argsString.push_back(' ');
 		argsString.append(argv[i]);
 	}
-	Log::Notice(argsString);
 
 	Sys::SetupCrashHandler(); // If Breakpad is enabled, this handler will soon be replaced.
 	Sys::ParseCmdline(argc, argv, cmdlineArgs);
+	Gameinfo::getInstance().parse(FS::Path::Build(cmdlineArgs.libPath, "gameinfo.conf"));
+	Log::Notice("%s", GAME_NAME_VERSION);
+	Log::Notice("%s %s %s %s", ENGINE_NAME_VERSION, PLATFORM_STRING, ARCH_STRING, ENGINE_DATE);
+	Log::Notice(argsString);
+	if (cmdlineArgs.homePath.empty()) {
+		cmdlineArgs.homePath = FS::DefaultHomePath();
+	}
 
 	// Platform-specific initialization
 #ifdef _WIN32

src/engine/qcommon/common.cpp

@@ -651,7 +651,7 @@ void Com_Init()
 	Cmd_AddCommand( "writebindings", Com_WriteBindings_f );
 #endif
 
-	s = va( "%s %s %s %s", Q3_VERSION, PLATFORM_STRING, ARCH_STRING, __DATE__ );
+	s = va( "%s %s %s %s %s", GAME_NAME_VERSION, ENGINE_NAME_VERSION, PLATFORM_STRING, ARCH_STRING, ENGINE_DATE );
 	com_version = Cvar_Get( "version", s, CVAR_ROM | CVAR_SERVERINFO );
 
 	Cmd_AddCommand( "in_restart", Com_In_Restart_f );
@@ -695,7 +695,7 @@ void Com_WriteConfigToFile( const char *filename, void (*writeConfig)( fileHandl
 		return;
 	}
 
-	FS_Printf( f, "// generated by " PRODUCT_NAME ", do not modify\n" );
+	FS_Printf( f, "// generated by %s, do not modify\n", Gameinfo::getInstance().name().c_str() );
 	writeConfig( f );
 	FS_FCloseFile( f );
 }

src/engine/qcommon/files.cpp

@@ -36,7 +36,7 @@ constexpr FS::offset_t MAX_FILE_LENGTH = 1000 * 1000 * 1000;
 const char TEMP_SUFFIX[] = ".tmp";
 
 // Cvars to select the base and extra packages to use
-static Cvar::Cvar<std::string> fs_basepak("fs_basepak", "base pak to load", 0, DEFAULT_BASE_PAK);
+static Cvar::Cvar<std::string> fs_basepak( "fs_basepak", "base pak to load", 0, "" );
 static Cvar::Cvar<std::string> fs_extrapaks("fs_extrapaks", "space-seperated list of paks to load in addition to the base pak", 0, "");
 
 struct handleData_t {
@@ -673,14 +673,16 @@ void FS_LoadBasePak()
 		return; // success
 	}
 
-	if (fs_basepak.Get() != DEFAULT_BASE_PAK) {
-		Log::Notice("Could not load base pak '%s', falling back to default: '%s'", fs_basepak.Get().c_str(), DEFAULT_BASE_PAK);
-		if (FS_LoadPak(DEFAULT_BASE_PAK)) {
+	if (fs_basepak.Get().c_str() != Gameinfo::getInstance().basepak().c_str()) {
+		Log::Notice("Could not load base pak '%s', falling back to default: '%s'",
+			fs_basepak.Get().c_str(), Gameinfo::getInstance().basepak().c_str());
+
+		if (FS_LoadPak(Gameinfo::getInstance().basepak().c_str())) {
 			return; // success
 		}
 	}
 
-	Sys::Error("Could not load default base pak '%s'", DEFAULT_BASE_PAK);
+	Sys::Error("Could not load default base pak '%s'", Gameinfo::getInstance().basepak().c_str());
 }
 
 void FS_LoadAllMapMetadata()