]> git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/commitdiff
Merge branch 'bones_was_here/mapinfo' into 'master'
authorbones_was_here <bones_was_here@xonotic.au>
Fri, 10 May 2024 08:14:52 +0000 (08:14 +0000)
committerbones_was_here <bones_was_here@xonotic.au>
Fri, 10 May 2024 08:14:52 +0000 (08:14 +0000)
More consistent and visible map metadata

See merge request xonotic/xonotic-data.pk3dir!1271

qcsrc/client/main.qc
qcsrc/common/mapinfo.qc
qcsrc/server/client.qc
xonotic-common.cfg

index 40cb19f74057e249202a916f3fb156ff245826cf..015e9be076592a07f56ede0c4d1c6ef7280e5fc7 100644 (file)
@@ -1420,7 +1420,9 @@ string GetVersionMessage(string hostversion, bool version_mismatch, bool version
 
 bool net_handle_ServerWelcome()
 {
-       campaign = ReadByte();
+       int flags = ReadByte();
+
+       campaign = flags & 1;
        if (campaign)
        {
                int campaign_level = ReadByte();
@@ -1441,8 +1443,10 @@ bool net_handle_ServerWelcome()
 
        strcpy(hostname, ReadString());
        string hostversion = ReadString();
-       bool version_mismatch = ReadByte();
-       bool version_check = ReadByte();
+       bool version_mismatch = flags & 2;
+       bool version_check = flags & 4;
+       MapInfo_Map_titlestring = ReadString();
+       MapInfo_Map_author = flags & 8 ? ReadString() : "";
        srv_minplayers = ReadByte();
        srv_maxplayers = ReadByte();
        string modifications = translate_modifications(ReadString());
@@ -1454,15 +1458,9 @@ bool net_handle_ServerWelcome()
 
        msg = strcat(msg, "\n\n", _("Gametype:"), " ^1", MapInfo_Type_ToText(gametype), "\n");
 
-       msg = strcat(msg, "\n", _("Map:"), " ^2");
-       if (world.message == "")
-               msg = strcat(msg, mi_shortname, "\n");
-       else
-       {
-               int i = strstrofs(world.message, " by ", 0); // matches _MapInfo_Generate()
-               string longname = i >= 0 ? substring(world.message, 0, i) : world.message;
-               msg = strcat(msg, (strcasecmp(longname, mi_shortname) ? strcat(mi_shortname, " ^7// ^2") : ""), longname, "\n");
-       }
+       msg = strcat(msg, "\n", _("Map:"), " ", MapInfo_Map_titlestring, "\n");
+       if (flags & 8)
+               msg = strcat(msg, "^9", _("by:"), " ", MapInfo_Map_author, "\n");
 
        if (srv_minplayers || srv_maxplayers)
        {
index e66ebb7671d4b85e9dc832d690d9e11e67392b44..c1cdd7a90cd0b22d4dd940931caf2f6f1d7c485e 100644 (file)
 
 int autocvar_g_mapinfo_q3compat = 1;
 
-#ifdef MENUQC
-#define WARN_COND false
+#ifdef SVQC
+       bool autocvar_g_mapinfo_ignore_warnings;
+       #define WARN_COND (!autocvar_g_mapinfo_ignore_warnings && MapInfo_Map_bspname == mi_shortname)
 #else
-bool autocvar_g_mapinfo_ignore_warnings;
-#define WARN_COND (!autocvar_g_mapinfo_ignore_warnings && MapInfo_Map_bspname == mi_shortname)
+       #define WARN_COND false
 #endif
 
 // generic string stuff
@@ -274,9 +274,30 @@ float _MapInfo_Generate(string pFilename) // 0: failure, 1: ok ent, 2: ok bsp
        float diameter, spawnpoints;
        float spawnplaces;
        bool is_q3df_map = false;
-
        vector mapMins, mapMaxs;
 
+       if(autocvar_g_mapinfo_q3compat >= 2) // generate mapinfo using arena data
+       {
+               // try for .arena or .defi files, as they may have more accurate information
+               // supporting .arena AND .defi for the same map
+               bool success = false;
+               fh = -1;
+               fn = _MapInfo_FindArenaFile(pFilename, ".arena");
+               if(fn != "" && (fh = fopen(fn, FILE_READ)) >= 0)
+               {
+                       success = _MapInfo_ParseArena(fn, fh, pFilename, NULL, false, true);
+                       fclose(fh);
+               }
+               fn = _MapInfo_FindArenaFile(pFilename, ".defi");
+               if(fn != "" && (fh = fopen(fn, FILE_READ)) >= 0)
+               {
+                       success |= _MapInfo_ParseArena(fn, fh, pFilename, NULL, true, true);
+                       fclose(fh);
+               }
+               if (success && autocvar_g_mapinfo_q3compat == 3)
+                       return 3; // skip entity analysis
+       }
+
        r = 1;
        fn = strcat("maps/", pFilename, ".ent");
        fh = fopen(fn, FILE_READ);
@@ -288,39 +309,15 @@ float _MapInfo_Generate(string pFilename) // 0: failure, 1: ok ent, 2: ok bsp
        }
        if(fh < 0)
                return 0;
-       LOG_INFO("Analyzing ", fn, " to generate initial mapinfo");
+       LOG_INFO("Generating ", pFilename, ".mapinfo: analyzing ", fn);
 
        inWorldspawn = 2;
-       MapInfo_Map_flags = 0;
-       MapInfo_Map_supportedGametypes = 0;
        spawnpoints = 0;
        spawnplaces = 0;
        _MapInfo_Map_worldspawn_music = "";
        mapMins = '0 0 0';
        mapMaxs = '0 0 0';
 
-       if(autocvar_g_mapinfo_q3compat == 2) // generate mapinfo using arena data
-       {
-               // try for .arena or .defi files, as they may have more accurate information
-               bool isdefi = false;
-               float arena_fh = -1;
-               string arena_fn = _MapInfo_FindArenaFile(pFilename, ".arena");
-               if(arena_fn != "")
-                       arena_fh = fopen(arena_fn, FILE_READ);
-               if(arena_fh < 0)
-               {
-                       isdefi = true;
-                       arena_fn = _MapInfo_FindArenaFile(pFilename, ".defi");
-                       if(arena_fn != "")
-                               arena_fh = fopen(arena_fn, FILE_READ);
-               }
-               if(arena_fh >= 0)
-               {
-                       _MapInfo_ParseArena(arena_fn, arena_fh, pFilename, NULL, isdefi, true);
-                       fclose(arena_fh);
-               }
-       }
-
        for (;;)
        {
                if (!((s = fgets(fh))))
@@ -342,17 +339,8 @@ float _MapInfo_Generate(string pFilename) // 0: failure, 1: ok ent, 2: ok bsp
                                _MapInfo_Map_worldspawn_music = v;
                        else if(k == "noise")
                                _MapInfo_Map_worldspawn_music = v;
-                       else if(k == "message" && (!MapInfo_Map_title || MapInfo_Map_title == "<TITLE>"))
-                       {
-                               i = strstrofs(v, " by ", 0);
-                               if(MapInfo_Map_author == "<AUTHOR>" && i >= 0)
-                               {
-                                       MapInfo_Map_title = substring(v, 0, i);
-                                       MapInfo_Map_author = substring(v, i + 4, strlen(v) - (i + 4));
-                               }
-                               else
-                                       MapInfo_Map_title = v;
-                       }
+                       else if(k == "message" && (!MapInfo_Map_title || MapInfo_Map_title == "<TITLE>") && v != "")
+                               MapInfo_Map_title = v;
                }
                else
                {
@@ -396,7 +384,7 @@ float _MapInfo_Generate(string pFilename) // 0: failure, 1: ok ent, 2: ok bsp
                                else if(v == "target_music" || v == "trigger_music")
                                        _MapInfo_Map_worldspawn_music = string_null; // don't use regular BGM
                                else if(v == "target_stopTimer")
-                                       is_q3df_map = true; // don't support standard gamemodes
+                                       is_q3df_map = true; // don't support standard gametypes UNLESS we found them in .arena
                                else
                                        FOREACH(Gametypes, true, it.m_generate_mapinfo(it, v));
                        }
@@ -616,7 +604,7 @@ void _MapInfo_Map_ApplyGametypeEx(string s, Gametype pWantedType, Gametype pThis
 Gametype MapInfo_Type_FromString(string gtype, bool dowarn, bool is_q3compat)
 {
        string replacement = "";
-       bool do_warn = true;
+
        switch (gtype)
        {
                case "nexball":   replacement = "nb"; break;
@@ -625,13 +613,13 @@ Gametype MapInfo_Type_FromString(string gtype, bool dowarn, bool is_q3compat)
                case "invasion":  replacement = "inv"; break;
                case "assault":   replacement = "as"; break;
                case "race":      replacement = "rc"; break;
-               // quake 3 compat
-               case "ffa":       replacement = "dm"; do_warn = false; break;
-               case "cctf":
-               case "oneflag":   replacement = "ctf"; do_warn = false; break;
-               case "tournament":
-               case "tourney":   replacement = "duel"; do_warn = false; break;
-               case "arena":     if(is_q3compat) { replacement = "ca"; do_warn = false; } break;
+               // Q3/QL compat, see DoesQ3ARemoveThisEntity() in quake3.qc for complete lists
+               case "ffa":       replacement = "dm"; break;
+               case "cctf": // from ThreeWave, maps with this should all have "ctf" too
+               case "oneflag":   replacement = "ctf"; break;
+               case "tourney":   replacement = "duel"; break;
+               case "arena": // which Q3 mod is this from? In Nexuiz it was 'duel with rounds'.
+                       if(is_q3compat) { replacement = "ca"; } break;
        }
        if (replacement != "")
        {
@@ -768,7 +756,35 @@ void _MapInfo_Parse_Settemp(string pFilename, string acl, float type, string s,
        }
 }
 
-float MapInfo_isRedundant(string fn, string t)
+/// Removes author string from title (if found)
+/// and copies it to MapInfo_Map_author if that wasn't set.
+string MapInfo_title_sans_author(string title)
+{
+       int offset;
+
+       if ((offset = strstrofs(title, " by ", 0)) >= 0)
+       {
+               if (MapInfo_Map_author == "<AUTHOR>")
+                       MapInfo_Map_author = substring(title, offset + 4, strlen(title) - (offset + 4));
+               title = substring(title, 0, offset);
+       }
+       else if ((offset = strstrofs(title, " (by ", 0)) >= 0 || (offset = strstrofs(title, " [by ", 0)) >= 0)
+       {
+               if (MapInfo_Map_author == "<AUTHOR>")
+                       MapInfo_Map_author = substring(title, offset + 5, strlen(title) - (offset + 5) - 1);
+               title = substring(title, 0, offset);
+       }
+       else if ((offset = strstrofs(title, "Made By ", 0)) >= 0) // often at the start of the string
+       {
+               if (MapInfo_Map_author == "<AUTHOR>")
+                       MapInfo_Map_author = substring(title, offset + 8, strlen(title) - (offset + 8));
+               title = substring(title, 0, offset);
+       }
+
+       return title != "" ? title : "<TITLE>";
+}
+
+bool MapInfo_isRedundant(string fn, string t)
 {
        // normalize file name
        fn = strreplace("_", "", fn);
@@ -803,6 +819,10 @@ bool _MapInfo_ParseArena(string arena_filename, int fh, string pFilename, Gamety
        int stored_supportedFeatures = 0;
        int stored_flags = 0;
        string t, s;
+
+       if (isgenerator)
+               LOG_INFO("Generating ", pFilename, ".mapinfo: analyzing ", arena_filename);
+
        for (;;)
        {
                if (!((s = fgets(fh))))
@@ -835,9 +855,11 @@ bool _MapInfo_ParseArena(string arena_filename, int fh, string pFilename, Gamety
                                MapInfo_Map_description = stored_Map_description;
                                if(stored_Map_title != "")
                                        MapInfo_Map_title = stored_Map_title;
-                               MapInfo_Map_author = stored_Map_author;
+                               if(stored_Map_author != "") // write the usual "<AUTHOR>" if we have nothing better
+                                       MapInfo_Map_author = stored_Map_author;
+                               // might have .arena AND .defi for the same map so these bitfields are OR'd
                                if(isgenerator)
-                                       MapInfo_Map_supportedGametypes = stored_supportedGametypes;
+                                       MapInfo_Map_supportedGametypes |= stored_supportedGametypes;
                                else
                                {
                                        FOREACH(Gametypes, it.m_flags & stored_supportedGametypes,
@@ -845,8 +867,8 @@ bool _MapInfo_ParseArena(string arena_filename, int fh, string pFilename, Gamety
                                                _MapInfo_Map_ApplyGametype ("", pGametypeToSet, it, true);
                                        });
                                }
-                               MapInfo_Map_supportedFeatures = stored_supportedFeatures;
-                               MapInfo_Map_flags = stored_flags;
+                               MapInfo_Map_supportedFeatures |= stored_supportedFeatures;
+                               MapInfo_Map_flags |= stored_flags;
                                return true; // no need to continue through the file, we have our map!
                        }
                        else
@@ -906,7 +928,8 @@ bool _MapInfo_ParseArena(string arena_filename, int fh, string pFilename, Gamety
                        string types = s;
                        types = strreplace("team", "tdm ft", types);
                        types = strreplace("ffa", "dm lms ka", types);
-                       if(strstrofs(types, "tournament", 0) < 0 && strstrofs(types, "tdm", 0) >= 0) // larger team map, support additional gamemodes!
+                       types = strreplace("tourney", "duel", types); // QL used duel so the following check must support it
+                       if(strstrofs(types, "duel", 0) < 0 && strstrofs(types, "tdm", 0) >= 0) // larger team map, support additional gamemodes!
                                types = cons(types, "ca kh");
                        FOREACH_WORD(types, true,
                        {
@@ -1023,28 +1046,27 @@ float MapInfo_Get_ByName_NoFallbacks(string pFilename, int pAllowGenerate, Gamet
        fh = fopen(fn, FILE_READ);
        if(fh < 0)
        {
-               if(autocvar_g_mapinfo_q3compat) // use arena data instead of generating a mapinfo file
+               if(autocvar_g_mapinfo_q3compat == 1) // use arena data instead of generating a mapinfo file
                {
-                       bool isdefi = false;
-                       if(autocvar_g_mapinfo_q3compat == 1) // only parse .arena files in mode 1
-                       {
-                               fn = _MapInfo_FindArenaFile(pFilename, ".arena");
-                               if(fn != "")
-                                       fh = fopen(fn, FILE_READ);
-                       }
-                       if(fh < 0 || autocvar_g_mapinfo_q3compat == 2)
+                       // supporting .arena AND .defi for the same map
+                       bool success = false;
+                       fn = _MapInfo_FindArenaFile(pFilename, ".arena");
+                       if(fn != "" && (fh = fopen(fn, FILE_READ)) >= 0)
                        {
-                               isdefi = true;
-                               fn = _MapInfo_FindArenaFile(pFilename, ".defi");
-                               if(fn != "")
-                                       fh = fopen(fn, FILE_READ);
+                               _MapInfo_Map_Reset();
+                               success = _MapInfo_ParseArena(fn, fh, pFilename, pGametypeToSet, false, false);
+                               fclose(fh);
                        }
-                       if(fh >= 0)
+                       fn = _MapInfo_FindArenaFile(pFilename, ".defi");
+                       if(fn != "" && (fh = fopen(fn, FILE_READ)) >= 0)
                        {
-                               _MapInfo_Map_Reset();
-                               if(_MapInfo_ParseArena(fn, fh, pFilename, pGametypeToSet, isdefi, false))
-                                       goto mapinfo_handled; // skip generation
+                               if(!success)
+                                       _MapInfo_Map_Reset();
+                               success |= _MapInfo_ParseArena(fn, fh, pFilename, pGametypeToSet, true, false);
+                               fclose(fh);
                        }
+                       if(success)
+                               goto mapinfo_handled; // skip generation
                }
 
                fn = strcat("maps/autogenerated/", pFilename, ".mapinfo");
@@ -1057,6 +1079,7 @@ float MapInfo_Get_ByName_NoFallbacks(string pFilename, int pAllowGenerate, Gamet
                        r = _MapInfo_Generate(pFilename);
                        if(!r)
                                return 0;
+                       MapInfo_Map_title = MapInfo_title_sans_author(MapInfo_Map_title);
                        fh = fopen(fn, FILE_WRITE);
                        fputs(fh, strcat("title ", MapInfo_Map_title, "\n"));
                        fputs(fh, strcat("description ", MapInfo_Map_description, "\n"));
@@ -1305,15 +1328,35 @@ float MapInfo_Get_ByName_NoFallbacks(string pFilename, int pAllowGenerate, Gamet
                else if(WARN_COND)
                        LOG_WARN("Map ", pFilename, " provides unknown info item ", t, ", ignored");
        }
-       LABEL(mapinfo_handled)
        fclose(fh);
 
+LABEL(mapinfo_handled)
+#ifdef SVQC
+       // if the map is currently loaded we can read worldspawn fields directly
+       if (pFilename == mi_shortname)
+       {
+               if (MapInfo_Map_title == "<TITLE>")
+                       if (world.message != "")
+                               MapInfo_Map_title = world.message;
+               if (MapInfo_Map_author == "<AUTHOR>")
+                       if ((s = GetField_fullspawndata(world, "author")) != "")
+                               MapInfo_Map_author = s;
+       }
+#endif
+       // Could skip removing author from title when it's source is .mapinfo
+       // but must always do it for world.message and .arena/.defi as VQ3 didn't support author
+       // so mappers tended to put it in world.message and/or longname.
+       MapInfo_Map_title = MapInfo_title_sans_author(MapInfo_Map_title); // may set author if not set
+
        if(MapInfo_Map_title == "<TITLE>")
-               MapInfo_Map_titlestring = MapInfo_Map_bspname;
+               MapInfo_Map_titlestring = strcat("^2", MapInfo_Map_bspname);
        else if(MapInfo_isRedundant(MapInfo_Map_bspname, MapInfo_Map_title))
-               MapInfo_Map_titlestring = MapInfo_Map_title;
+               MapInfo_Map_titlestring = strcat("^2", MapInfo_Map_title);
        else
-               MapInfo_Map_titlestring = sprintf("%s: %s", MapInfo_Map_bspname, MapInfo_Map_title);
+               MapInfo_Map_titlestring = sprintf("^2%s ^7// ^2%s", MapInfo_Map_bspname, MapInfo_Map_title);
+
+       if (MapInfo_Map_author == "<AUTHOR>")
+               MapInfo_Map_author = ""; // don't display "<AUTHOR>" in the UI (we do write it to .mapinfo files)
 
        MapInfo_Cache_Store();
        if(MapInfo_Map_supportedGametypes != 0)
index c1ee3aceb39780f2b3ede953fd45ff0aac798c60..1d62feffa2858ea3bbc689fa8da8b1059f3a215a 100644 (file)
@@ -1041,16 +1041,31 @@ void ClientPreConnect(entity this)
 // also note that they aren't all registered mutators, e.g. jetpack, low gravity
 void SendWelcomeMessage(entity this, int msg_type)
 {
-       WriteByte(msg_type, boolean(autocvar_g_campaign));
        if (boolean(autocvar_g_campaign))
        {
+               WriteByte(msg_type, 1);
                WriteByte(msg_type, Campaign_GetLevelNum());
                return;
        }
+
+       int flags = 0;
+       if (CS(this).version_mismatch)
+               flags |= 2;
+       if (CS(this).version < autocvar_gameversion)
+               flags |= 4;
+       MapInfo_Get_ByName(mi_shortname, 0, NULL);
+       if (MapInfo_Map_author != "")
+               flags |= 8;
+       WriteByte(msg_type, flags);
+
        WriteString(msg_type, autocvar_hostname);
        WriteString(msg_type, autocvar_g_xonoticversion);
-       WriteByte(msg_type, CS(this).version_mismatch);
-       WriteByte(msg_type, (CS(this).version < autocvar_gameversion));
+
+       WriteString(msg_type, MapInfo_Map_titlestring);
+       if (flags & 8)
+               WriteString(msg_type, MapInfo_Map_author);
+       MapInfo_ClearTemps();
+
        WriteByte(msg_type, autocvar_g_warmup > 1 ? autocvar_g_warmup : map_minplayers);
        WriteByte(msg_type, GetPlayerLimit());
 
index d8a1f1c20b2ba84ffb5ccbb9682a591d341ab0f0..d20a675c7cfc9c42e2ef1d561ca0ad0ed6151fb3 100644 (file)
@@ -154,7 +154,7 @@ set debug_deglobalization_clear 0 "make the new wrappers set globals to NaN afte
 // disabling until it's complete
 set prvm_garbagecollection_enable 0
 
-set g_mapinfo_q3compat 1 "0: generate .mapinfo if none exists, ignoring .arena and .defi files. 1: read .arena and .defi files, don't generate .mapinfo. 2: generate .mapinfo if none exists using data from .arena files instead of reading them, .defi files continue to be used directly"
+set g_mapinfo_q3compat 1 "If no .mapinfo file exists:: 0: generate .mapinfo using entities only. 1: read .arena and .defi files directly, don't generate .mapinfo. 2: generate .mapinfo using .arena and .defi files, and entities. 3: generate .mapinfo using .arena and .defi files only."
 
 // load console command aliases and settings
 exec commands.cfg