feat: 🚧 wip: configs loading

Author: KANAjetzt

addons/mod_loader/api/config.gd

@@ -23,11 +23,6 @@ static func get_mod_config(mod_id: String) -> Dictionary:
 	return config_data
 
 
-static func is_mod_config_data_valid(config_data: ModConfig):
-	var json_schema := JSONSchema.new()
-	var error := json_schema.validate(config_data.get_data_as_string(), config_data.get_schema_as_string())
-
-
 static func update_mod_config(mod_id: String, data: Dictionary) -> void:
 	# Update the config held in memory
 	ModLoaderStore.mod_data[mod_id].config.merge(data, true)

addons/mod_loader/classes/mod_config.gd

@@ -2,6 +2,8 @@ class_name ModConfig
 extends Resource
 
 
+const LOG_NAME := "ModLoader:ModConfig"
+
 var mod_id: String
 var schema: Dictionary
 var data: Dictionary
@@ -14,3 +16,14 @@ func get_data_as_string() -> String:
 
 func get_schema_as_string() -> String:
 	return JSON.print(schema)
+
+
+func is_valid() -> bool:
+	var json_schema := JSONSchema.new()
+	var error := json_schema.validate(get_data_as_string(), get_schema_as_string())
+
+	if not error == "":
+		ModLoaderLog.fatal(error, LOG_NAME)
+		return false
+
+	return true

addons/mod_loader/classes/mod_manifest.gd

@@ -195,15 +195,52 @@ func to_json() -> String:
 	}, "\t")
 
 
-func is_config_valid(config_data: String, config_schema: String) -> bool:
-	var json_schema := JSONSchema.new()
-	var error := json_schema.validate(config_data, config_schema)
-
-	if not error == "":
-		ModLoaderLog.fatal(error, LOG_NAME)
-		return false
-
-	return true
+func load_mod_config_defaults() -> void:
+	var config := ModConfig.new()
+	config.save_path = _ModLoaderPath.get_path_to_configs().plus_file("%s.json" % get_mod_id())
+	config.schema = config_schema
+	config.mod_id = get_mod_id()
+
+	# Check if there is no default.json file in the mods config directory
+	if not _ModLoaderFile.file_exists(config.save_path):
+		# Generate config_default based on the default values in config_schema
+		config.data = _generate_default_config_from_schema(config.schema.properties)
+		# Save the default config to disk
+		_ModLoaderFile.save_dictionary_to_json_file(config.data, config.save_path)
+	else:
+		# If there is a default.json just load that
+		config.data = _ModLoaderFile.get_json_as_dict(config.save_path)
+
+	# Validate the config defaults
+	config.is_valid()
+
+
+# Recursively searches for default values
+func _generate_default_config_from_schema(property: Dictionary, current_prop := {}) -> Dictionary:
+	# Exit function if property is empty
+	if property.empty():
+		return current_prop
+
+	for property_key in property.keys():
+		var prop = property[property_key]
+
+		# If this property contains nested properties, we recursively call this function
+		if "properties" in prop:
+			current_prop[property_key] = {}
+			_generate_default_config_from_schema(prop.properties, current_prop[property_key])
+			# Return early here because a object will not have a "default" key
+			return current_prop
+
+		# If this property contains a default value, add it to the global config_defaults dictionary
+		if "default" in prop:
+			# Initialize the current_key if it is missing in config_defaults
+			if not current_prop.has(property_key):
+				current_prop[property_key] = {}
+
+			# Add the default value to the config_defaults
+			current_prop[property_key] = prop.default
+
+	return current_prop
 
 
 # Handles deprecation of the single string value in the compatible_mod_loader_version.

addons/mod_loader/mod_loader.gd

@@ -99,7 +99,7 @@ func _load_mods() -> void:
 		var mod: ModData = ModLoaderStore.mod_data[dir_name]
 		mod.load_manifest()
 		if mod.manifest.get("config_schema") and not mod.manifest.config_schema.empty():
-			mod.load_mod_config()
+			mod.load_configs()
 
 	ModLoaderLog.success("DONE: Loaded all meta data", LOG_NAME)
 
@@ -360,48 +360,6 @@ func _setup_mods() -> int:
 	return unpacked_mods_count
 
 
-# Load mod config JSONs from res://configs
-func _load_mod_configs() -> void:
-	var found_configs_count := 0
-	var configs_path := _ModLoaderPath.get_path_to_configs()
-
-	for dir_name in ModLoaderStore.mod_data:
-		var json_path := configs_path.plus_file(dir_name + ".json")
-		var mod_config := _ModLoaderFile.get_json_as_dict(json_path)
-
-		ModLoaderLog.debug("Config JSON: Looking for config at path: %s" % json_path, LOG_NAME)
-
-		if mod_config.size() > 0:
-			found_configs_count += 1
-
-			ModLoaderLog.info("Config JSON: Found a config file: '%s'" % json_path, LOG_NAME)
-			ModLoaderLog.debug_json_print("Config JSON: File data: ", mod_config, LOG_NAME)
-
-			# Check `load_from` option. This lets you specify the name of a
-			# different JSON file to load your config from. Must be in the same
-			# dir. Means you can have multiple config files for a single mod
-			# and switch between them quickly. Should include ".json" extension.
-			# Ignored if the filename matches the mod ID, or is empty
-			if mod_config.has("load_from"):
-				var new_path: String = mod_config.load_from
-				if not new_path == "" and not new_path == str(dir_name, ".json"):
-					ModLoaderLog.info("Config JSON: Following load_from path: %s" % new_path, LOG_NAME)
-					var new_config := _ModLoaderFile.get_json_as_dict(configs_path + new_path)
-					if new_config.size() > 0:
-						mod_config = new_config
-						ModLoaderLog.info("Config JSON: Loaded from custom json: %s" % new_path, LOG_NAME)
-						ModLoaderLog.debug_json_print("Config JSON: File data:", mod_config, LOG_NAME)
-					else:
-						ModLoaderLog.error("Config JSON: ERROR - Could not load data via `load_from` for %s, at path: %s" % [dir_name, new_path], LOG_NAME)
-
-			ModLoaderStore.mod_data[dir_name].config = mod_config
-
-	if found_configs_count > 0:
-		ModLoaderLog.success("Config JSON: Loaded %s config(s)" % found_configs_count, LOG_NAME)
-	else:
-		ModLoaderLog.info("Config JSON: No mod configs were found", LOG_NAME)
-
-
 # Add a mod's data to mod_data.
 # The mod_folder_path is just the folder name that was added to UNPACKED_DIR,
 # which depends on the name used in a given mod ZIP (eg "mods-unpacked/Folder-Name")