FactorioScenarioMultiplayerSpawn/lib/config_parser.lua

-- This file is used to validate the config.lua file and handle any mod settings conflicts.

---Provides a way to look up the config settings key from the mod settings key.
---@alias OarcSettingsLookup { mod_key: string, ocfg_keys: table<integer, string>, type: string }

---@type table<string, OarcSettingsLookup>
OCFG_KEYS =
{
    ["Server Info"] = {mod_key = "" , ocfg_keys = {""}, type = "header"},
    ["server_info.welcome_msg_title"] = {mod_key = "oarc-mod-welcome-msg-title" , ocfg_keys = {"server_info", "welcome_msg_title"}, type = "string"},
    ["server_info.welcome_msg"] = {mod_key = "oarc-mod-welcome-msg" , ocfg_keys = {"server_info", "welcome_msg"}, type = "string"},
    ["server_info.discord_invite"] = {mod_key = "oarc-mod-discord-invite" , ocfg_keys = {"server_info", "discord_invite"}, type = "string"},

    ["Gameplay"] = {mod_key = "" , ocfg_keys = {""}, type = "header"},
    ["gameplay.enable_main_team"] = {mod_key = "oarc-mod-enable-main-team" , ocfg_keys = {"gameplay", "enable_main_team"}, type = "boolean"},
    ["gameplay.enable_separate_teams"] = {mod_key = "oarc-mod-enable-separate-teams" , ocfg_keys = {"gameplay", "enable_separate_teams"}, type = "boolean"},
    -- STARTUP ["gameplay.enable_spawning_on_other_surfaces"] = {mod_key = "oarc-mod-default-allow-spawning-on-other-surfaces" , ocfg_keys = {"gameplay", "enable_spawning_on_other_surfaces"}, type = "boolean"},
    ["gameplay.allow_moats_around_spawns"] = {mod_key = "oarc-mod-allow-moats-around-spawns" , ocfg_keys = {"gameplay", "allow_moats_around_spawns"}, type = "boolean"},
    ["gameplay.enable_moat_bridging"] = {mod_key = "oarc-mod-enable-moat-bridging" , ocfg_keys = {"gameplay", "enable_moat_bridging"}, type = "boolean"},
    ["gameplay.minimum_distance_to_existing_chunks"] = {mod_key = "oarc-mod-minimum-distance-to-existing-chunks" , ocfg_keys = {"gameplay", "minimum_distance_to_existing_chunks"}, type = "integer"},
    ["gameplay.near_spawn_distance"] = {mod_key = "oarc-mod-near-spawn-distance" , ocfg_keys = {"gameplay", "near_spawn_distance"}, type = "integer"},
    ["gameplay.far_spawn_distance"] = {mod_key = "oarc-mod-far-spawn-distance" , ocfg_keys = {"gameplay", "far_spawn_distance"}, type = "integer"},

    ["gameplay.enable_buddy_spawn"] = {mod_key = "oarc-mod-enable-buddy-spawn" , ocfg_keys = {"gameplay", "enable_buddy_spawn"}, type = "boolean"},
    ["gameplay.enable_offline_protection"] = {mod_key = "oarc-mod-enable-offline-protection" , ocfg_keys = {"gameplay", "enable_offline_protection"}, type = "boolean"},
    ["gameplay.enable_shared_team_vision"] = {mod_key = "oarc-mod-enable-shared-team-vision" , ocfg_keys = {"gameplay", "enable_shared_team_vision"}, type = "boolean"},
    ["gameplay.enable_shared_team_chat"] = {mod_key = "oarc-mod-enable-shared-team-chat" , ocfg_keys = {"gameplay", "enable_shared_team_chat"}, type = "boolean"},
    ["gameplay.enable_shared_spawns"] = {mod_key = "oarc-mod-enable-shared-spawns" , ocfg_keys = {"gameplay", "enable_shared_spawns"}, type = "boolean"},
    ["gameplay.number_of_players_per_shared_spawn"] = {mod_key = "oarc-mod-number-of-players-per-shared-spawn" , ocfg_keys = {"gameplay", "number_of_players_per_shared_spawn"}, type = "integer"},
    ["gameplay.enable_friendly_fire"] = {mod_key = "oarc-mod-enable-friendly-fire" , ocfg_keys = {"gameplay", "enable_friendly_fire"}, type = "boolean"},

    -- ["gameplay.main_force_name"] = {mod_key = "oarc-mod-main-force-name" , ocfg_keys = {"gameplay", "main_force_name"}, type = "string"},
    ["gameplay.default_surface"] = {mod_key = "oarc-mod-default-surface" , ocfg_keys = {"gameplay", "default_surface"}, type = "string"},

    ["gameplay.scale_resources_around_spawns"] = {mod_key = "oarc-mod-scale-resources-around-spawns" , ocfg_keys = {"gameplay", "scale_resources_around_spawns"}, type = "boolean"},
    ["gameplay.modified_enemy_spawning"] = {mod_key = "oarc-mod-modified-enemy-spawning" , ocfg_keys = {"gameplay", "modified_enemy_spawning"}, type = "boolean"},

    ["gameplay.minimum_online_time"] = {mod_key = "oarc-mod-minimum-online-time" , ocfg_keys = {"gameplay", "minimum_online_time"}, type = "integer"},
    ["gameplay.respawn_cooldown_min"] = {mod_key = "oarc-mod-respawn-cooldown-min" , ocfg_keys = {"gameplay", "respawn_cooldown_min"}, type = "integer"},

    ["Regrowth"] = {mod_key = "" , ocfg_keys = {""}, type = "header"},
    ["regrowth.enable_regrowth"] = {mod_key = "oarc-mod-enable-regrowth" , ocfg_keys = {"regrowth", "enable_regrowth"}, type = "boolean"},
    ["regrowth.enable_world_eater"] = {mod_key = "oarc-mod-enable-world-eater" , ocfg_keys = {"regrowth", "enable_world_eater"}, type = "boolean"},
    ["regrowth.enable_abandoned_base_cleanup"] = {mod_key = "oarc-mod-enable-abandoned-base-cleanup" , ocfg_keys = {"regrowth", "enable_abandoned_base_cleanup"}, type = "boolean"},
    ["regrowth.cleanup_interval"] = {mod_key = "oarc-mod-regrowth-cleanup-interval-min" , ocfg_keys = {"regrowth", "cleanup_interval"}, type = "integer"},
}

---Easy reverse lookup for mod settings keys.
---@type table<string, string>
OCFG_MOD_KEYS =
{
    ["oarc-mod-welcome-msg-title"] = "server_info.welcome_msg_title",
    ["oarc-mod-welcome-msg"] = "server_info.welcome_msg",
    ["oarc-mod-discord-invite"] = "server_info.discord_invite",

    ["oarc-mod-enable-main-team"] = "gameplay.enable_main_team",
    ["oarc-mod-enable-separate-teams"] = "gameplay.enable_separate_teams",
    --oarc-mod-default-allow-spawning-on-other-surfaces"] = " ["gameplay.enable_spawning_on_other_surfaces",
    ["oarc-mod-allow-moats-around-spawns"] = "gameplay.allow_moats_around_spawns",
    ["oarc-mod-enable-moat-bridging"] = "gameplay.enable_moat_bridging",
    ["oarc-mod-minimum-distance-to-existing-chunks"] = "gameplay.minimum_distance_to_existing_chunks",
    ["oarc-mod-near-spawn-distance"] = "gameplay.near_spawn_distance",
    ["oarc-mod-far-spawn-distance"] = "gameplay.far_spawn_distance",

    ["oarc-mod-enable-buddy-spawn"] = "gameplay.enable_buddy_spawn",
    ["oarc-mod-enable-offline-protection"] = "gameplay.enable_offline_protection",
    ["oarc-mod-enable-shared-team-vision"] = "gameplay.enable_shared_team_vision",
    ["oarc-mod-enable-shared-team-chat"] = "gameplay.enable_shared_team_chat",
    ["oarc-mod-enable-shared-spawns"] = "gameplay.enable_shared_spawns",
    ["oarc-mod-number-of-players-per-shared-spawn"] = "gameplay.number_of_players_per_shared_spawn",
    ["oarc-mod-enable-friendly-fire"] = "gameplay.enable_friendly_fire",

    -- STARTUP ["oarc-mod-main-force-name"] = "gameplay.main_force_name",
    ["oarc-mod-default-surface"] = "gameplay.default_surface",

    ["oarc-mod-scale-resources-around-spawns"] = "gameplay.scale_resources_around_spawns",
    ["oarc-mod-modified-enemy-spawning"] = "gameplay.modified_enemy_spawning",

    ["oarc-mod-minimum-online-time"] = "gameplay.minimum_online_time",
    ["oarc-mod-respawn-cooldown-min"] = "gameplay.respawn_cooldown_min",

    ["oarc-mod-enable-regrowth"] = "regrowth.enable_regrowth",
    ["oarc-mod-enable-world-eater"] = "regrowth.enable_world_eater",
    ["oarc-mod-enable-abandoned-base-cleanup"] = "regrowth.enable_abandoned_base_cleanup",
    ["oarc-mod-regrowth-cleanup-interval-min"] = "regrowth.cleanup_interval",
}


function ValidateAndLoadConfig()

    -- Check that each of the OCFG_MOD_KEYS has a corresponding OCFG_KEYS entry.
    for mod_key,ocfg_key in pairs(OCFG_MOD_KEYS) do
        if (OCFG_KEYS[ocfg_key] == nil) then
            error("OCFG_MOD_KEYS entry does not have a corresponding OCFG_KEYS entry: " .. mod_key .. " -> " .. ocfg_key)
        end
    end
    -- And check the opposite.
    for ocfg_key,entry in pairs(OCFG_KEYS) do
        if (entry.type ~= "header") and (OCFG_MOD_KEYS[entry.mod_key] == nil) then
            error("OCFG_KEYS entry does not have a corresponding OCFG_MOD_KEYS entry: " .. ocfg_key .. " -> " .. entry.mod_key)
        end
    end

    -- Save the config into the global table.
    ---@class OarcConfig
    global.ocfg = OCFG

    CacheModSettings()

    GetScenarioOverrideSettings()

    ValidateSettings()
end

function ValidateSettings()

    -- Validate enable_main_team and enable_separate_teams.
    -- Force enable_main_team if both are disabled.
    if (not global.ocfg.gameplay.enable_main_team and not global.ocfg.gameplay.enable_separate_teams) then
        log("Both main force and separate teams are disabled! Enabling main force. Please check your mod settings or config!")
        global.ocfg.gameplay.enable_main_team = true
        settings.global["oarc-mod-enable-main-team"] = { value = true }
        SendBroadcastMsg("Invalid setting! Both main force and separate teams are disabled! Enabling main force.")
    end

    -- Validate minimum is less than maximums
    if (global.ocfg.gameplay.near_spawn_distance >= global.ocfg.gameplay.far_spawn_distance) then
        log("Near spawn min distance is greater than or equal to near spawn max distance! Please check your mod settings or config!")
        global.ocfg.gameplay.far_spawn_distance = global.ocfg.gameplay.near_spawn_distance + 1
        settings.global["oarc-mod-far-spawn-distance"] = { value = global.ocfg.gameplay.far_spawn_distance }
        SendBroadcastMsg("Invalid setting! Near spawn min distance is greater than or equal to near spawn max distance!")
    end

    -- Validate that regrowth is enabled if world eater is enabled.
    if (global.ocfg.regrowth.enable_world_eater and not global.ocfg.regrowth.enable_regrowth) then
        log("World eater is enabled but regrowth is not! Disabling world eater. Please check your mod settings or config!")
        global.ocfg.regrowth.enable_world_eater = false
        settings.global["oarc-mod-enable-world-eater"] = { value = false }
        SendBroadcastMsg("Invalid setting! World eater is enabled but regrowth is not! Disabling world eater.")
    end

    -- Validate that default surface exists.
    if (game.surfaces[global.ocfg.gameplay.default_surface] == nil) then
        log("Default surface does not exist! Please check your mod settings or config!")
        global.ocfg.gameplay.default_surface = "nauvis"
        settings.global["oarc-mod-default-surface"] = { value = "nauvis" }
        SendBroadcastMsg("Invalid setting! Default surface does not exist! Setting to nauvis.")
    end

    -- Validate that a "nauvis" surface config exists (nauvis is the default config fallback)
    -- This should only break with a bad scenario custom config.
    if (global.ocfg.surfaces_config["nauvis"] == nil) then
        error("nauvis surface config does not exist! Please check your mod settings or config!")
    end
end

-- Read in the mod settings and copy them to the OARC_CFG table, overwriting the defaults in config.lua.
function CacheModSettings()
    
    log("Copying mod settings to OCFG table...")

    -- Copy the global settings from the mod settings.
    -- Find the matching OARC setting and update it.
    for _,entry in pairs(OCFG_KEYS) do
        if (entry.type ~= "header") then
            SetGlobalOarcConfigUsingKeyTable(entry.ocfg_keys, settings.global[entry.mod_key].value)
        end
    end

    -- Special case for startup settings
    global.ocfg.gameplay.default_allow_spawning_on_other_surfaces = settings.startup["oarc-mod-default-allow-spawning-on-other-surfaces"].value  --[[@as boolean]]
    global.ocfg.gameplay.main_force_name = settings.startup["oarc-mod-main-force-name"].value --[[@as string]]
end

function GetScenarioOverrideSettings()

    if remote.interfaces["oarc_scenario"] then

        log("Getting scenario ode settings...")
        local scenario_settings = remote.call("oarc_scenario", "get_scenario_settings")

        -- Overwrite the non mod settings with the scenario settings.
        global.ocfg = scenario_settings

    else
        log("No scenario settings found.")
    end

end

---Handles the event when a mod setting is changed in the mod settings menu.
---@param event EventData.on_runtime_mod_setting_changed
---@return nil
function RuntimeModSettingChanged(event)

    if (event.setting_type ~= "runtime-global") then
        return
    end

    log("on_runtime_mod_setting_changed: " .. event.setting .. " = " .. tostring(settings.global[event.setting].value))

    -- Find the matching OARC setting and update it.
    local found_setting = false

    if (OCFG_MOD_KEYS[event.setting] ~= nil) then
        local oarc_setting_index = OCFG_MOD_KEYS[event.setting]
        local oarc_setting_table = OCFG_KEYS[oarc_setting_index]
        SetGlobalOarcConfigUsingKeyTable(oarc_setting_table.ocfg_keys, settings.global[event.setting].value)
        found_setting = true
    end

    if (not found_setting) then
        error("Unknown oarc-mod setting changed: " .. event.setting)
    else
        ValidateSettings()
        ApplyRuntimeChanges(OCFG_MOD_KEYS[event.setting])
    end
end

---A probably quit stupid function to let me lookup and set the global.ocfg entries using a key table.
---@param key_table table<integer, string>
---@param value any
function SetGlobalOarcConfigUsingKeyTable(key_table, value)
    local number_of_keys = #key_table

    if (number_of_keys == 1) then
        global.ocfg[key_table[1]] = value
    elseif (number_of_keys == 2) then
        global.ocfg[key_table[1]][key_table[2]] = value
    elseif (number_of_keys == 3) then
        global.ocfg[key_table[1]][key_table[2]][key_table[3]] = value
    else
        error("Invalid key_table length: " .. number_of_keys .. "\n" .. serpent.block(key_table))
    end
end

---An equally stupid function to let me lookup the global.ocfg entries using a key table.
---@param key_table table<integer, string>
---@return any
function GetGlobalOarcConfigUsingKeyTable(key_table)
    local number_of_keys = #key_table

    if (number_of_keys == 1) then
        return global.ocfg[key_table[1]]
    elseif (number_of_keys == 2) then
        return global.ocfg[key_table[1]][key_table[2]]
    elseif (number_of_keys == 3) then
        return global.ocfg[key_table[1]][key_table[2]][key_table[3]]
    else
        error("Invalid key_table length: " .. number_of_keys .. "\n" .. serpent.block(key_table))
    end
end

---Handles any runtime changes that need more than just the setting change.
---@param oarc_setting_index string
---@return nil
function ApplyRuntimeChanges(oarc_setting_index)

    ---Handle changing enable_shared_team_vision
    if (oarc_setting_index == "gameplay.enable_shared_team_vision") then
        for _,force in pairs(game.forces) do
            if (force.name ~= "neutral") and (force.name ~= "enemy") and (force.name ~= "enemy-easy") then
                force.share_chart = global.ocfg.gameplay.enable_shared_team_vision
            end
        end

    ---Handle changing enable_friendly_fire
    elseif (oarc_setting_index == "gameplay.enable_friendly_fire") then
        for _,force in pairs(game.forces) do
            if (force.name ~= "neutral") and (force.name ~= "enemy") and (force.name ~= "enemy-easy") then
                force.friendly_fire = global.ocfg.gameplay.enable_friendly_fire
            end
        end

    end
end