Darktide-Mod-Framework/scripts/mods/dmf/modules/dmf_mod_manager.lua

local dmf = nil

local _mods = {}
local _mods_unloading_order = {}

local ERRORS = {
  REGULAR = {
    -- create_mod:
    duplicate_mod_name = "[DMF Mod Manager] (new_mod) Creating mod object: you can't use name '%s' for your mod " ..
                          "because mod with the same name already exists.",
    -- new_mod:
    mod_name_wrong_type = "[DMF Mod Manager] (new_mod): first argument ('mod_name') should be a string, not %s.",
    mod_resources_wrong_type = "[DMF Mod Manager] (new_mod) '%s': second argument ('mod_resources') should be a " ..
                                "table, not %s.",
    too_late_for_mod_creation = "[DMF Mod Manager] (new_mod) '%s': you can't create mods after vanilla mod manager " ..
                                 "finishes loading mod bundles.",
    -- dmf.initialize_mod_data:
    mod_data_wrong_type = "[DMF Mod Manager] (new_mod) 'mod_data' initialization: mod_data file should return " ..
                           "table, not %s.",
    mod_options_initializing_failed = "[DMF Mod Manager] (new_mod) mod options initialization: could not initialize " ..
                                       "mod's options. %s",
  },
  PREFIX = {
    mod_localization_initialization = "[DMF Mod Manager] (new_mod) 'mod_localization' initialization",
    mod_data_initialization = "[DMF Mod Manager] (new_mod) 'mod_data' initialization",
    mod_script_initialization = "[DMF Mod Manager] (new_mod) 'mod_script' initialization",
  },
}

-- #####################################################################################################################
-- ##### Local functions ###############################################################################################
-- #####################################################################################################################

local function create_mod(mod_name)
  if _mods[mod_name] then
    dmf:error(ERRORS.REGULAR.duplicate_mod_name, mod_name)
    return
  end

  table.insert(_mods_unloading_order, 1, mod_name)

  local mod = DMFMod:new(mod_name)
  _mods[mod_name] = mod

  return mod
end

-- Resolves a value. If it's a function, executes it. If it's a string, loads the file at that path.
local function resolve_resource(mod, error_prefix_data, resource, resource_value)
  local type_value = type(resource_value)

  if type_value == "string" then
    if mod:get_internal_data("is_bundled") then
      return dmf.safe_call_dofile(mod, error_prefix_data, resource_value)
    else
      return dmf.safe_call_io_dofile(mod, error_prefix_data, resource_value)
    end
  elseif type_value == "function" then
    return dmf.safe_call(mod, error_prefix_data, resource_value, mod)
  elseif type_value == "table" then
    return true, type_value
  end

  mod:warning("%s: 'mod_%s' (optional) should be a string, function or table; not %s",
              error_prefix_data, resource, type_value)
  return false
end

local function load_mod_resource(mod, mod_resources, resource)
  local error_prefix_data = ERRORS.PREFIX["mod_" .. resource .. "_initialization"]
  local resource_value = mod_resources["mod_" .. resource]

  -- All resources can be optionally be nil.
  if resource_value == nil then
    return true
  end

  -- Resolve the value and obtain the result
  local success, return_value = resolve_resource(mod, error_prefix_data, resource, resource_value)

  -- Could not resolve the file. An error will already have been printed.
  if not success then
    return false
  end

  -- Check if there's a DMF initializator for this resource, and execute it if it exists.
  local dmf_initializator = dmf["initialize_mod_" .. resource]
  if not dmf_initializator then
    return true
  end

  return dmf_initializator(mod, return_value)
end

-- #####################################################################################################################
-- ##### Public functions ##############################################################################################
-- #####################################################################################################################

function new_mod(mod_name, mod_resources)
  if type(mod_name) ~= "string" then
    dmf:error(ERRORS.REGULAR.mod_name_wrong_type, type(mod_name))
    return
  end
  if type(mod_resources) ~= "table" then
    dmf:error(ERRORS.REGULAR.mod_resources_wrong_type, mod_name, type(mod_resources))
    return
  end

  if dmf.all_mods_were_loaded then
    dmf:error(ERRORS.REGULAR.too_late_for_mod_creation, mod_name)
    return
  end

  -- Create a mod object
  local mod = create_mod(mod_name)
  if not mod then
    return
  end

  -- Load mod components: localization, data and script. NOTE: Order here is important.
  if not (
    load_mod_resource(mod, mod_resources, "localization") and
    load_mod_resource(mod, mod_resources, "data") and
    load_mod_resource(mod, mod_resources, "script") -- @TODO: Check that this isn't a table.
  )
  then
    return
  end

  -- Initialize mod state
  if mod:get_internal_data("is_togglable") then
    dmf.initialize_mod_state(mod)
  end

  return mod
end

function get_mod(mod_name)
  return _mods[mod_name]
end

-- #####################################################################################################################
-- ##### DMF Initialization ############################################################################################
-- #####################################################################################################################

dmf = create_mod("DMF")

-- #####################################################################################################################
-- ##### DMF internal functions and variables ##########################################################################
-- #####################################################################################################################

-- MOD DATA INITIALIZATION

function dmf.initialize_mod_data(mod, mod_data)
  if type(mod_data) ~= "table" then
    mod:error(ERRORS.REGULAR.mod_data_wrong_type, type(mod_data))
    return
  end

  -- Set internal mod data
  if mod_data.name then
    dmf.set_internal_data(mod, "readable_name", mod_data.name)
  end
  dmf.set_internal_data(mod, "description",     mod_data.description)
  dmf.set_internal_data(mod, "is_togglable",    mod_data.is_togglable or mod_data.is_mutator)
  dmf.set_internal_data(mod, "is_mutator",      mod_data.is_mutator)
  dmf.set_internal_data(mod, "allow_rehooking", mod_data.allow_rehooking)

  -- Register mod as mutator @TODO: calling this after options initialization would be better, I guess?
  if mod_data.is_mutator then
    dmf.register_mod_as_mutator(mod, mod_data.mutator_settings)
  end

  -- Mod's options initialization
  if mod_data.options or (not mod_data.is_mutator and not mod_data.options_widgets) then
    dmf.safe_call(
        dmf,
        ERRORS.REGULAR.mod_options_initializing_failed,
        dmf.initialize_mod_options,
        mod,
        mod_data.options
    )
  end

  -- Textures initialization @TODO: move to a separate function
  if type(mod_data.custom_gui_textures) == "table" then
    -- @TODO: Not implemented
  end

  return true
end

-- VARIABLES

dmf.mods = _mods
dmf.mods_unloading_order = _mods_unloading_order