WIP AF savegame format

common/include/common/utils/string-utils.h

@@ -30,6 +30,13 @@ inline std::string_view trim(std::string_view s)
     return rtrim(ltrim(s));
 }
 
+inline std::string_view unquote(std::string_view s)
+{
+    if (s.size() >= 2 && s.front() == '"' && s.back() == '"')
+        return s.substr(1, s.size() - 2);
+    return s;
+}
+
 inline std::pair<std::string_view, std::string_view> split_once_whitespace(std::string_view s)
 {
     s = trim(s);

common/include/common/version/version.h

@@ -34,6 +34,7 @@
 #define ADS_VERSION            2      // .toml dedicated server config files
 #define AFS_VERSION            14     // alpine_settings.ini
 #define AFCC_VERSION           2      // alpine_system.ini
+#define ASG_VERSION            2      // .asg savegame files
 
 // Increment only when absolutely necessary! Will break level compatibility for older clients.
 // Stock RF1 uses versions 156 - 200. RF2 uses version 295

docs/CHANGELOG.md

@@ -9,6 +9,19 @@ Version 1.4.0 (Lupin): Not yet released
   - Fine tuned texture animation without being subject to VBM format limitations
   - Accessible to event system via handle for level-driven behaviour scripting
 - Support PNG and JPG texture formats in game and level editor
+- Implement TOML-based `ASG` savegame file format for single player
+    - Support (theoretically) any number of each saved object type, removing specific limits
+    - Support tracking orientation for triggers and clutter (disabled when `sp_savespeedrunmode` is enabled)
+    - Support tracking trigger reset timestamps (disabled when `sp_savespeedrunmode` is enabled)
+    - Support tracking skins for clutter and entities
+    - Support tracking all event links
+    - Support tracking positions and rotations for relevant event types
+    - Support tracking dynamic lights
+    - Support Alpine events `Switch_Random`, `Sequence`, and `World_HUD_Sprite`
+    - Support persisting destroyed breakable detail brushes of all materials, and partial damage to non-glass breakable brushes
+    - Support persisting brush-based (RF2-style) geomod destruction
+    - Fix collision bugs resulting from compressed position/orientation values (disabled when `sp_savespeedrunmode` is enabled)
+    - Add support for `Require Alpine Savegame Format` in `af_game.tbl` for TC mods that want to force the modern format
 - Add Bagman (`BM`) and Team Bagman (`TBM`) game types
 
 ### Minor features, changes, and enhancements

game_patch/CMakeLists.txt

@@ -282,6 +282,8 @@ set(SRCS
     misc/alpine_options.cpp
     misc/alpine_settings.h
     misc/alpine_settings.cpp
+    misc/alpine_savegame.h
+    misc/alpine_savegame.cpp
     sound/sound.cpp
     sound/sound.h
     sound/sound_ds.cpp
@@ -316,6 +318,7 @@ target_include_directories(AlpineFaction PRIVATE
     ${CMAKE_SOURCE_DIR}/vendor/stb
     ${CMAKE_SOURCE_DIR}/vendor/freetype/include
     ${CMAKE_SOURCE_DIR}/vendor/nlohmann
+    ${CMAKE_SOURCE_DIR}/vendor/toml++
 )
 
 if(NOT MSVC)

game_patch/bmpman/atx.cpp

@@ -117,7 +117,16 @@ namespace
     // Single registry keyed by lowercase basename. With ATX supercede in effect a caller may
     // load the same file under any extension (foo.tga, foo.dds, foo.atx, foo) — they all
     // resolve to the same controller, so basename is the right key.
-    std::unordered_map<std::string, std::unique_ptr<AtxController>> g_controllers;
+    //
+    // Intentionally heap-allocated and never destructed. AtxController's destructor calls
+    // rf::bm::release() on its child handles, which is only valid while RF.exe's bitmap manager
+    // is alive. Controllers are torn down at level transitions (atx_level_reset, below) — the
+    // correct time. If this container instead destructed at process exit (it would, as a normal
+    // static object when the user quits with a level still loaded), those AtxController dtors
+    // would run AFTER RF.exe has shut down its bitmap manager, double-freeing bm slots and
+    // crashing on quit.
+    std::unordered_map<std::string, std::unique_ptr<AtxController>>& g_controllers =
+        *new std::unordered_map<std::string, std::unique_ptr<AtxController>>();
 
     // Basenames whose .atx file has been seen this level and failed to parse/validate. Cached so
     // we don't re-run the failing parse on every subsequent load of any extension that supercedes
@@ -484,10 +493,20 @@ rf::bm::Format lock_atx_bitmap(rf::bm::BitmapEntry& bm_entry, void** pixels_out,
     *pixels_out = nullptr;
     *palette_out = nullptr;
 
-    auto it = g_controllers.find(key_from_bm_name(bm_entry.name));
+    const std::string key = key_from_bm_name(bm_entry.name);
+    auto it = g_controllers.find(key);
     if (it == g_controllers.end()) {
-        xlog::warn("ATX: lock for unknown '{}'", bm_entry.name);
-        return rf::bm::FORMAT_NONE;
+        // Safely handle cache.
+        if (!g_failed.contains(key)) {
+            int w = 0, h = 0, levels = 0, frames = 0;
+            rf::bm::Format fmt = rf::bm::FORMAT_NONE;
+            read_atx_header((key + ".atx").c_str(), &w, &h, &fmt, &levels, &frames);
+            it = g_controllers.find(key);
+        }
+        if (it == g_controllers.end()) {
+            xlog::warn("ATX: lock for unknown '{}'", bm_entry.name);
+            return rf::bm::FORMAT_NONE;
+        }
     }
     AtxController& c = *it->second;
     // Insertions are idempotent. We track every bm_handle that locks this controller so

game_patch/misc/alpine_options.cpp

@@ -1,4 +1,5 @@
 #include "alpine_options.h"
+#include <common/utils/string-utils.h>
 #include <patch_common/CallHook.h>
 #include <patch_common/FunHook.h>
 #include <patch_common/CodeInjection.h>
@@ -69,37 +70,19 @@ bool is_known_run_level(const std::string& filename)
     return g_known_run_levels.contains(string_to_lower(level_name));
 }
 
-// trim leading and trailing whitespace
-std::string trim(const std::string& str, bool remove_quotes = false)
-{
-    auto start = str.find_first_not_of(" \t\n\r");
-    auto end = str.find_last_not_of(" \t\n\r");
-    if (start == std::string::npos) {
-        return "";
-    }        
-
-    std::string trimmed = str.substr(start, end - start + 1);
-
-    // extract quoted value
-    if (remove_quotes && trimmed.size() >= 2 && trimmed.front() == '"' && trimmed.back() == '"') {
-        trimmed = trimmed.substr(1, trimmed.size() - 2);
-    }
-
-    return trimmed;
-}
 
 // ===== Parsers for AlpineOptions =====
 
 // strings can be provided in quotation marks or not
 std::optional<OptionValue> parse_string(const std::string& value)
 {
-    return trim(value, true);
+    return std::string{unquote(trim(value))};
 }
 
 // colors can be provided in quotation marks or not, and can be hex formatted or RF-style
 std::optional<OptionValue> parse_color(const std::string& value)
 {
-    std::string trimmed_value = trim(value, true);
+    std::string trimmed_value{unquote(trim(value))};
 
     try {
         // Check if it's a valid hex string (6 or 8 characters)
@@ -186,6 +169,7 @@ const std::unordered_map<std::string, OptionMetadata> option_metadata = {
     {"$Multi Timer Y Offset", {AlpineOptionID::MultiTimerYOffset, "af_client.tbl", parse_int}},
     {"$Multi Timer Color", {AlpineOptionID::MultiTimerColor, "af_client.tbl", parse_color}},
     {"$Default Third Person", {AlpineOptionID::DefaultThirdPerson, "af_game.tbl", parse_bool}},
+    {"$Require Alpine Savegame Format", {AlpineOptionID::RequireAlpineSavegameFormat, "af_game.tbl", parse_bool}},
 };
 
 // ===== Parsers for Alpine level info =====
@@ -214,12 +198,12 @@ std::optional<LevelInfoValue> parse_bool_level(const std::string& value)
 }
 std::optional<LevelInfoValue> parse_string_level(const std::string& value)
 {
-    return trim(value, true);
+    return std::string{unquote(trim(value))};
 }
 
 std::optional<LevelInfoValue> parse_color_level(const std::string& value)
 {
-    std::string trimmed_value = trim(value, true);
+    std::string trimmed_value{unquote(trim(value))};
 
     try {
         // Check if it's a valid hex string (6 or 8 characters)
@@ -261,13 +245,13 @@ std::optional<LevelInfoValue> parse_color_level(const std::string& value)
 
 std::optional<std::pair<std::string, std::string>> parse_mesh_replacement(const std::string& value)
 {
-    std::string trimmed_value = trim(value, true);
+    std::string trimmed_value{unquote(trim(value))};
     std::regex mesh_replacement_pattern("\\{\\s*\"([^\"]+)\"\\s*,\\s*\"([^\"]+)\"\\s*\\}");
     std::smatch matches;
 
     if (std::regex_match(trimmed_value, matches, mesh_replacement_pattern)) {
         if (matches.size() == 3) { // Full match and 2 filename captures
-            return std::make_pair(trim(matches[1].str(), true), trim(matches[2].str(), true));
+            return std::make_pair(std::string{unquote(trim(matches[1].str()))}, std::string{unquote(trim(matches[2].str()))});
         }
     }
     return std::nullopt;
@@ -340,7 +324,7 @@ void load_level_info_config(const std::string& level_filename)
 
     // Search for #Start marker
     while (std::getline(file_stream, line)) {
-        line = trim(line, false);
+        line = std::string{trim(line)};
         if (line == "#Start") {
             found_start = true;
             break;
@@ -355,7 +339,7 @@ void load_level_info_config(const std::string& level_filename)
     // Process options until #End marker is found
     bool found_end = false;
     while (std::getline(file_stream, line)) {
-        line = trim(line, false);
+        line = std::string{trim(line)};
 
         if (line == "#End") {
             found_end = true;
@@ -370,8 +354,8 @@ void load_level_info_config(const std::string& level_filename)
             continue;
         }
 
-        std::string option_name = trim(line.substr(0, delimiter_pos), false);
-        std::string option_value = trim(line.substr(delimiter_pos + 1), false);
+        std::string option_name{trim(line.substr(0, delimiter_pos))};
+        std::string option_value{trim(line.substr(delimiter_pos + 1))};
 
         // handle mesh replacements
         if (option_name == "$Mesh Replacement") {
@@ -787,7 +771,7 @@ void load_single_af_options_file(const std::string& file_name)
 
     // Search for #Start marker
     while (std::getline(file_stream, line)) {
-        line = trim(line, false);
+        line = std::string{trim(line)};
         if (line == "#Start") {
             found_start = true;
             break;
@@ -802,7 +786,7 @@ void load_single_af_options_file(const std::string& file_name)
     // Process options until #End marker is found
     bool found_end = false;
     while (std::getline(file_stream, line)) {
-        line = trim(line, false);
+        line = std::string{trim(line)};
 
         if (line == "#End") {
             found_end = true;
@@ -817,8 +801,8 @@ void load_single_af_options_file(const std::string& file_name)
             continue;
         }
 
-        std::string option_name = trim(line.substr(0, delimiter_pos), false);
-        std::string option_value = trim(line.substr(delimiter_pos + 1), false);
+        std::string option_name{trim(line.substr(0, delimiter_pos))};
+        std::string option_value{trim(line.substr(delimiter_pos + 1))};
 
         // Handle af_level_quirks.tbl
         if (file_name == "af_level_quirks.tbl" &&

game_patch/misc/alpine_options.h

@@ -51,6 +51,7 @@ enum class AlpineOptionID
     MultiTimerYOffset,
     MultiTimerColor,
     DefaultThirdPerson,
+    RequireAlpineSavegameFormat,
     _optioncount // dummy for total count
 };