feat: add dictionary for overrides based on feature tags to options

Author: Qubus0

addons/mod_loader/api/log.gd

@@ -345,7 +345,8 @@ static func _log(message: String, mod_name: String, log_type: String = "info", o
 	if only_once and _is_logged_before(log_entry):
 		return
 
-	_store_log(log_entry)
+	if ModLoaderStore:
+		_store_log(log_entry)
 
 	# Check if the scene_tree is available
 	if Engine.get_main_loop():
@@ -385,6 +386,9 @@ static func _log(message: String, mod_name: String, log_type: String = "info", o
 
 
 static func _is_mod_name_ignored(mod_name: String) -> bool:
+	if not ModLoaderStore:
+		return false
+
 	var ignored_mod_names := ModLoaderStore.ml_options.ignored_mod_names_in_log as Array
 
 	if not ignored_mod_names.size() == 0:

addons/mod_loader/mod_loader.gd

@@ -341,7 +341,7 @@ func _init_mod(mod: ModData) -> void:
 		if method.name == "_init":
 			if method.args.size() > 0:
 				argument_found = true
-	
+
 	var mod_main_instance: Node
 	if argument_found:
 		mod_main_instance = mod_main_script.new(self)

addons/mod_loader/mod_loader_store.gd

@@ -150,15 +150,52 @@ func _update_ml_options_from_options_resource() -> void:
 	var ml_options_path := "res://addons/mod_loader/options/options.tres"
 
 	# Get user options for ModLoader
-	if _ModLoaderFile.file_exists(ml_options_path):
-		var options_resource := load(ml_options_path)
-		if not options_resource.current_options == null:
-			var current_options: Resource = options_resource.current_options
+	if not _ModLoaderFile.file_exists(ml_options_path):
+		ModLoaderLog.fatal(str("A critical file is missing: ", ml_options_path), LOG_NAME)
+
+	var options_resource: ModLoaderCurrentOptions = load(ml_options_path)
+	if options_resource.current_options == null:
+		ModLoaderLog.warning(str(
+			"No current options are set. Falling back to defaults. ",
+			"Edit your options at %s. " % ml_options_path
+		), LOG_NAME)
+	else:
+		var current_options = options_resource.current_options
+		if not current_options is ModLoaderOptionsProfile:
+			ModLoaderLog.error(str(
+				"Current options is not a valid Resource of type ModLoaderOptionsProfile. ",
+				"Please edit your options at %s. " % ml_options_path
+			), LOG_NAME)
+		# Update from the options in the resource
+		for key in ml_options:
+			ml_options[key] = current_options[key]
+
+
+	# Get options overrides by feature tags
+	# An override is saved as Dictionary[String: ModLoaderOptionsProfile]
+	for feature_tag in options_resource.feature_override_options.keys():
+		if not feature_tag is String:
+			ModLoaderLog.error(str(
+				"Options override keys are required to be of type String. Failing key: \"%s.\" " % feature_tag,
+				"Please edit your options at %s. " % ml_options_path,
+				"Consult the documentation for all available feature tags: ",
+				"https://docs.godotengine.org/en/3.5/tutorials/export/feature_tags.html"
+			), LOG_NAME)
+			continue
+		if not OS.has_feature(feature_tag):
+			var override_options = options_resource.feature_override_options[feature_tag]
+			if not override_options is ModLoaderOptionsProfile:
+				ModLoaderLog.error(str(
+					"Options override is not a valid Resource of type ModLoaderOptionsProfile. ",
+					"Options override key with invalid resource: \"%s\". " % feature_tag,
+					"Please edit your options at %s. " % ml_options_path
+				), LOG_NAME)
+				continue
 			# Update from the options in the resource
 			for key in ml_options:
-				ml_options[key] = current_options[key]
-	else:
-		ModLoaderLog.fatal(str("A critical file is missing: ", ml_options_path), LOG_NAME)
+				ml_options[key] = override_options[key]
+
+
 
 
 # Update ModLoader's options, via CLI args

addons/mod_loader/options/options.tres

@@ -1,8 +1,12 @@
-[gd_resource type="Resource" load_steps=3 format=2]
+[gd_resource type="Resource" load_steps=4 format=2]
 
 [ext_resource path="res://addons/mod_loader/options/profiles/current.tres" type="Resource" id=1]
 [ext_resource path="res://addons/mod_loader/resources/options_current.gd" type="Script" id=2]
+[ext_resource path="res://addons/mod_loader/options/profiles/editor.tres" type="Resource" id=3]
 
 [resource]
 script = ExtResource( 2 )
 current_options = ExtResource( 1 )
+feature_override_options = {
+"editor": ExtResource( 3 )
+}

addons/mod_loader/options/profiles/editor.tres

@@ -0,0 +1,17 @@
+[gd_resource type="Resource" load_steps=2 format=2]
+
+[ext_resource path="res://addons/mod_loader/resources/options_profile.gd" type="Script" id=1]
+
+[resource]
+script = ExtResource( 1 )
+enable_mods = true
+locked_mods = [  ]
+log_level = 3
+disabled_mods = [  ]
+allow_modloader_autoloads_anywhere = false
+steam_workshop_enabled = false
+override_path_to_mods = ""
+override_path_to_configs = ""
+override_path_to_workshop = ""
+ignore_deprecated_errors = true
+ignored_mod_names_in_log = [  ]

addons/mod_loader/resources/options_current.gd

@@ -1,4 +1,14 @@
 class_name ModLoaderCurrentOptions
 extends Resource
 
-export (Resource) var current_options = null
+# The default options set for the mod loader
+export var current_options: Resource = preload("res://addons/mod_loader/options/profiles/default.tres")
+
+# Overrides for all available feature tags through OS.has_feature()
+# Format: Dictionary[String: ModLoaderOptionsProfile] where the string is a tag
+# Warning: Some tags can occur at the same time (Windows + editor for example) -
+# In a case where multiple apply, the last one in the dict will override all others
+export var feature_override_options: Dictionary = {
+		"editor": preload("res://addons/mod_loader/options/profiles/editor.tres")
+	}
+