rename ModDetails to ModManifest, remove logs for now

Author: Qubus0

addons/mod_loader/mod_data.gd

@@ -14,7 +14,7 @@ enum required_mod_files {
 	MANIFEST,
 }
 
-## Directory of the mod. Has to be identical to [method ModDetails.get_mod_id]
+## Directory of the mod. Has to be identical to [method ModManifest.get_mod_id]
 var dir_name := ""
 ## Path to the Mod's Directory
 var dir_path := ""
@@ -23,7 +23,7 @@ var is_loadable := true
 ## Is increased for every mod depending on this mod. Highest importance is loaded first
 var importance := 0
 ## Contents of the manifest
-var details: ModDetails
+var manifest: ModManifest
 ## Updated in _load_mod_configs
 var config := {}
 
@@ -36,32 +36,32 @@ func _init(_dir_path: String) -> void:
 
 
 ## Load meta data from a mod's manifest.json file
-func load_details(modLoader = ModLoader) -> void:
+func load_manifest() -> void:
 	if not has_required_files():
 		return
 
-	modLoader.mod_log("Loading mod_details (manifest.json) for -> %s" % dir_name, LOG_NAME)
+#	ModLoader.mod_log("Loading mod_manifest (manifest.json) for -> %s" % dir_name, LOG_NAME)
 
 	# Load meta data file
 	var manifest_path = get_required_mod_file_path(required_mod_files.MANIFEST)
-	var manifest_dict = modLoader._get_json_as_dict(manifest_path) # todo get from utils
+	var manifest_dict = _get_json_as_dict(manifest_path) # todo get from utils
 
-	modLoader.dev_log("%s loaded manifest data -> %s" % [dir_name, manifest_dict], LOG_NAME)
+#	ModLoader.mod_log("%s loaded manifest data -> %s" % [dir_name, manifest_dict], LOG_NAME)
 
-	var mod_details := ModDetails.new(manifest_dict)
+	var mod_manifest := ModManifest.new(manifest_dict)
 
-	if not mod_details:
+	if not mod_manifest:
 		is_loadable = false
 		return
 
-	details = mod_details
+	manifest = mod_manifest
 
 
-## Validates if [member dir_name] matches [method ModDetails.get_mod_id]
+## Validates if [member dir_name] matches [method ModManifest.get_mod_id]
 func is_mod_dir_name_same_as_id() -> bool:
-	var manifest_id = details.get_mod_id()
+	var manifest_id = manifest.get_mod_id()
 	if dir_name != manifest_id:
-		ModLoader.mod_log('ERROR - Mod directory name "%s" does not match the data in manifest.json. Expected "%s"' % [ dir_name, manifest_id ], LOG_NAME)
+#		ModLoader.mod_log('ERROR - Mod directory name "%s" does not match the data in manifest.json. Expected "%s"' % [ dir_name, manifest_id ], LOG_NAME)
 		is_loadable = false
 		return false
 	return true
@@ -75,14 +75,14 @@ func has_required_files() -> bool:
 		var file_path = get_required_mod_file_path(required_mod_files[required_file])
 
 		if !file_check.file_exists(file_path):
-			ModLoader.mod_log("ERROR - %s is missing a required file: %s" % [dir_name, file_path], LOG_NAME)
+#			ModLoader.mod_log("ERROR - %s is missing a required file: %s" % [dir_name, file_path], LOG_NAME)
 			is_loadable = false
 	return is_loadable
 
 
-## Validates if details are set
-func has_details() -> bool:
-	return not details == null
+## Validates if manifest is set
+func has_manifest() -> bool:
+	return not manifest == null
 
 
 ## Converts enum indices [member required_mod_files] into their respective file paths
@@ -95,6 +95,25 @@ func get_required_mod_file_path(required_file: int) -> String:
 	return ""
 
 
+## Parses JSON from a given file path and returns a dictionary.
+## Returns an empty dictionary if no file exists (check with size() < 1)
+static func _get_json_as_dict(path:String) -> Dictionary: # todo move to utils
+	var file = File.new()
+
+	if !file.file_exists(path):
+		file.close()
+		return {}
+
+	file.open(path, File.READ)
+	var content = file.get_as_text()
+
+	var parsed := JSON.parse(content)
+	if parsed.error:
+		# log error
+		return {}
+	return parsed.result
+
+
 #func _to_string() -> String:
 	# todo if we want it pretty printed
 

addons/mod_loader/mod_loader.gd

@@ -123,17 +123,17 @@ func _init():
 	# required properties (REQUIRED_META_TAGS)
 	for dir_name in mod_data:
 		var mod: ModData = mod_data[dir_name]
-		mod.load_details(self)
+		mod.load_manifest()
 
 	mod_log("DONE: Loaded all meta data", LOG_NAME)
 
-	# Run dependency checks after loading mod_details. If a mod depends on another
+	# Run dependency checks after loading mod_manifest. If a mod depends on another
 	# mod that hasn't been loaded, that dependent mod won't be loaded.
 	for dir_name in mod_data:
 		var mod: ModData = mod_data[dir_name]
 		if not mod.is_loadable:
 			continue
-		_check_dependencies(dir_name, mod.details.dependencies)
+		_check_dependencies(dir_name, mod.manifest.dependencies)
 
 	# Sort mod_load_order by the importance score of the mod
 	_get_load_order()
@@ -147,8 +147,8 @@ func _init():
 
 	# Instance every mod and add it as a node to the Mod Loader
 	for mod in mod_load_order:
-		# mod_log(str("Initializing -> ", mod.mod_details.extra.godot.id), LOG_NAME)
-		mod_log("Initializing -> %s" % mod.details.get_mod_id(), LOG_NAME)
+		# mod_log(str("Initializing -> ", mod.mod_manifest.extra.godot.id), LOG_NAME)
+		mod_log("Initializing -> %s" % mod.manifest.get_mod_id(), LOG_NAME)
 		_init_mod(mod)
 
 	dev_log(str("mod_data: ", JSON.print(mod_data, '   ')), LOG_NAME)
@@ -315,7 +315,7 @@ func _load_mod_configs():
 
 	for dir_name in mod_data:
 		var json_path = configs_path.plus_file(dir_name + ".json")
-		var mod_config = _get_json_as_dict(json_path)
+		var mod_config = ModData._get_json_as_dict(json_path)
 
 		dev_log(str("Config JSON: Looking for config at path: ", json_path), LOG_NAME)
 
@@ -334,7 +334,7 @@ func _load_mod_configs():
 				var new_path = mod_config.load_from
 				if new_path != "" && new_path != str(dir_name, ".json"):
 					mod_log(str("Config JSON: Following load_from path: ", new_path), LOG_NAME)
-					var new_config = _get_json_as_dict(configs_path + new_path)
+					var new_config = ModData._get_json_as_dict(configs_path + new_path)
 					if new_config.size() > 0 != null:
 						mod_config = new_config
 						mod_log(str("Config JSON: Loaded from custom json: ", new_path), LOG_NAME)
@@ -373,7 +373,7 @@ func _init_mod_data(mod_folder_path):
 
 
 # Run dependency checks on a mod, checking any dependencies it lists in its
-# mod_details (ie. its manifest.json file). If a mod depends on another mod that
+# mod_manifest (ie. its manifest.json file). If a mod depends on another mod that
 # hasn't been loaded, the dependent mod won't be loaded.
 func _check_dependencies(mod_id:String, deps:Array):
 	dev_log(str("Checking dependencies - mod_id: ", mod_id, " dependencies: ", deps), LOG_NAME)
@@ -386,7 +386,7 @@ func _check_dependencies(mod_id:String, deps:Array):
 			continue
 
 		var dependency = mod_data[dependency_id]
-		var dependency_mod_details = mod_data[dependency_id].mod_details
+		var dependency_mod_manifest = mod_data[dependency_id].mod_manifest
 
 		# Init the importance score if it's missing
 
@@ -395,8 +395,8 @@ func _check_dependencies(mod_id:String, deps:Array):
 		dev_log(str("Dependency -> ", dependency_id, " importance -> ", dependency.importance), LOG_NAME)
 
 		# check if dependency has dependencies
-		if(dependency_mod_details.dependencies.size() > 0):
-			_check_dependencies(dependency_id, dependency_mod_details.dependencies)
+		if(dependency_mod_manifest.dependencies.size() > 0):
+			_check_dependencies(dependency_id, dependency_mod_manifest.dependencies)
 
 
 # Handle missing dependencies: Sets `is_loadable` to false and logs an error
@@ -445,8 +445,8 @@ func _init_mod(mod: ModData):
 	dev_log("Loaded script -> %s" % mod_main_script, LOG_NAME)
 
 	var mod_main_instance = mod_main_script.new(self)
-	# mod_main_instance.name = mod.mod_details.extra.godot.id
-	mod_main_instance.name = mod.details.get_mod_id()
+	# mod_main_instance.name = mod.mod_manifest.extra.godot.id
+	mod_main_instance.name = mod.manifest.get_mod_id()
 
 	dev_log("Adding child -> %s" % mod_main_instance, LOG_NAME)
 	add_child(mod_main_instance, true)
@@ -494,22 +494,6 @@ func _get_local_folder_dir(subfolder:String = ""):
 	return game_install_directory.plus_file(subfolder)
 
 
-# Parses JSON from a given file path and returns a dictionary.
-# Returns an empty dictionary if no file exists (check with size() < 1)
-func _get_json_as_dict(path:String)->Dictionary:
-	# mod_log(str("getting JSON as dict from path -> ", path), LOG_NAME)
-	var file = File.new()
-
-	if !file.file_exists(path):
-		file.close()
-		return {}
-
-	file.open(path, File.READ)
-	var content = file.get_as_text()
-
-	return JSON.parse(content).result
-
-
 func _get_file_name(path, is_lower_case = true, is_no_extension = false):
 	# mod_log(str("Get file name from path -> ", path), LOG_NAME)
 	var file_name = path.get_file()
@@ -673,7 +657,7 @@ func get_mod_config(mod_id:String = "", key:String = "")->Dictionary:
 	# Mod ID is valid
 	if error_num == 0:
 		var config_data = mod_data[mod_id].config
-		defaults = mod_data[mod_id].mod_details.extra.godot.config_defaults
+		defaults = mod_data[mod_id].mod_manifest.extra.godot.config_defaults
 
 		# No custom JSON file
 		if config_data.size() == 0:

addons/mod_loader/mod_details.gd renamed to addons/mod_loader/mod_manifest.gd

@@ -1,6 +1,6 @@
 extends Resource
 ## Stores and validates contents of the manifest set by the user
-class_name ModDetails
+class_name ModManifest
 
 
 ## Mod name.