Feat zip peeking (#416)

* feat: 🚧 first draft of the export plugin

The plan is to automate the creation of hooks for each function in all GDScripts.

* feat: 🚧 wip callable_stack

* refactor: 🚧 rename vanilla functions

Vanilla functions are renamed, and at the bottom of the script, mod loader hooks are generated. These hooks replace the vanilla functions and handle calls to the `callable_stack`.

* feat: 🚧 added return with types to hook

Currently, I'm stuck on this approach because the method list's return property does not contain any information if there is no return type defined for the method.

* refactor: 🚧 reworked callable_sack funcs

* refactor: 🚧 added return usage check

That seems to work for filtering out methods that have a return.

* refactor: 🚧 remove and add back class_name

Without removing the `class_name` before initializing the script on export, I get this parse error: `hides a global script class`. With these code changes, I get `Value of type [script_path] cannot be assigned to a variable of type [class_name]` if there is a self-assignment somewhere in the script.

* refactor: 🚧 No new script instance - load() the script 😶‍🌫️

Also added a check for static functions and currently working on recognizing inner classes.

* refactor: 🚧 added `get_return_type_string`

check the `type_hint` and add it if it's present.

* refactor: 🚧 added `is_top_level_func`

To check if the function has no space before `func` or `static`, used to ignore functions in inner classes. Later, we might want to figure out a way to include these.

* fix: 🚧 corrected return type in generated methods

Also removed extra comma in args list

* feat: 🚧 only add modloader text to modified scripts

until now all scripts received the "Mod Loader Hooks" header at the bottom
even when no changes where made.

* feat: 🚧 added optional @moddable requirement

* feat: 🚧 added `is_setter`

used to ignore setter funcs

* feat: 🚧 improved runtime performance by pre-hashing dict-lookup

Also refactored some of the function/field names to improved the modding experience

* feat: 🚧 fixed issues with inheritance by adding class hash

added getter method, made both static and moved getter/setter check to is_moddable check

* cleaner getters and setters

* feat: 🚧 added @not-moddable option to exclude methods

improved performance by exiting early when nothing is hooked

* refactor: ♻️ removed no longer used functions

and a first style and type pass

* refactor: 🚧 general code cleanup

* 🚧 refactor: move methods

* 🚧 refactor: extract methods

* 🚧 feat: mod hook packing prototype

* fix: 🚧 fix path to `mod_hook_preprocessor.gd`

* 🚧 fix: typos

* feat: 🚧 WIP: replace `super()`

* feat: 🚧 WIP: replace `super()`

* feat: 🚧 replace `super()` first working draft

* feat: 🚧 replace super calls

* refactor: ♻️ remove static from regex vars

* feat: 🚧 hook creation and loading (#3)

* feat: 🚧 hook creation and loading

* feat: ✨ hook creation and loading

* feat: 🚧 read manifest from zip before loading the mod

* feat: 🚧 read manifest from zip before loading the mod

* feat: 🚧 read manifest from zip before loading the mod

* feat: 🚧 read manifest from zip before loading the mod

* fix: 🐛 fix typos

* fix: 🐛 check overwrites in zip

* fix: 🐛 type inference

* feat: 🚧 hooks

* docs: 📝 better doc comments for ml options

* fix: 🐛 mac exe path

* refactor: ♻️ move hook methods to new file

* fix: 🐛 wrong hook location on mac

* refactor: ♻️ move hook methods to new file

* fix: 🐛 use callv for hooks

* fix: 🐛 fix self reference error from 4.2

* fix: 🐛 getter for steam id

* feat: ✨ improved restart notification

* fix: merge duplication

* Update addons/mod_loader/api/profile.gd

Co-authored-by: KANAjetzt <[email protected]>

* fix: rename zip_file_exists

* docs: minimal hooks documentation

* fix: typo

* fix: review changes

---------

Co-authored-by: Kai <[email protected]>
Co-authored-by: Luca Martinelli <[email protected]>
Co-authored-by: KANAjetzt <[email protected]>

Author: 3 people

addons/mod_loader/_export_plugin/export_plugin.gd

@@ -1,7 +1,7 @@
 extends EditorExportPlugin
 
 const ModHookPreprocessorScript := preload("res://addons/mod_loader/internal/mod_hook_preprocessor.gd")
-static var ModHookPreprocessor
+static var ModHookPreprocessor: ModLoaderHookPreprocessor
 
 
 func _get_name() -> String:

addons/mod_loader/api/config.gd

@@ -125,7 +125,7 @@ static func delete_config(config: ModConfig) -> bool:
 
 	# Remove the config from ModData
 	ModLoaderStore.mod_data[config.mod_id].configs.erase(config.name)
-	
+
 	return true
 
 
@@ -213,7 +213,7 @@ static func _traverse_schema(schema_prop: Dictionary, prop_key_array: Array) ->
 		schema_prop = schema_prop.properties
 
 	schema_prop = _traverse_schema(schema_prop, prop_key_array)
-	
+
 	return schema_prop
 
 
@@ -379,7 +379,7 @@ static func refresh_config_data(config: ModConfig) -> ModConfig:
 	var new_config_data := _ModLoaderFile.get_json_as_dict(config.save_path)
 	# Update the data property of the ModConfig object with the refreshed data
 	config.data = new_config_data
-	
+
 	return config
 
 

addons/mod_loader/api/mod.gd

@@ -11,32 +11,6 @@ extends Object
 const LOG_NAME := "ModLoader:Mod"
 
 
-static func set_modding_hooks(new_callable_stack: Dictionary) -> void:
-	ModLoaderStore.modding_hooks = new_callable_stack
-
-
-static func add_hook(mod_callable: Callable, script_path: String, method_name: String, is_before := false) -> void:
-	ModLoaderStore.any_mod_hooked = true
-	var hash = get_hook_hash(script_path,method_name,is_before)
-	if not ModLoaderStore.modding_hooks.has(hash):
-		ModLoaderStore.modding_hooks[hash] = []
-	ModLoaderStore.modding_hooks[hash].push_back(mod_callable)
-	ModLoaderLog.debug("Added hook script: \"%s\" method: \"%s\" is_before: \"%s\"" % [script_path, method_name, is_before], LOG_NAME)
-	if not ModLoaderStore.hooked_script_paths.has(script_path):
-		ModLoaderStore.hooked_script_paths[script_path] = null
-
-
-static func call_hooks(self_object: Object, args: Array, hook_hash:int) -> void:
-	var hooks = ModLoaderStore.modding_hooks.get(hook_hash, null)
-	if hooks:
-		for mod_func in hooks:
-			mod_func.call(self_object, args)
-
-
-static func get_hook_hash(path:String, method:String, is_before:bool) -> int:
-	return hash(path + method + ("before" if is_before else "after"))
-
-
 ## Installs a script extension that extends a vanilla script.[br]
 ## The [code]child_script_path[/code] should point to your mod's extender script.[br]
 ## Example: [code]"MOD/extensions/singletons/utils.gd"[/code][br]
@@ -51,7 +25,6 @@ static func get_hook_hash(path:String, method:String, is_before:bool) -> int:
 ##
 ## [br][b]Returns:[/b] [code]void[/code][br]
 static func install_script_extension(child_script_path: String) -> void:
-
 	var mod_id: String = _ModLoaderPath.get_mod_dir(child_script_path)
 	var mod_data: ModData = get_mod_data(mod_id)
 	if not ModLoaderStore.saved_extension_paths.has(mod_data.manifest.get_mod_id()):
@@ -68,6 +41,12 @@ static func install_script_extension(child_script_path: String) -> void:
 		_ModLoaderScriptExtension.apply_extension(child_script_path)
 
 
+## Adds a mod hook
+# TODO: detailed doc
+static func add_hook(mod_callable: Callable, script_path: String, method_name: String, is_before := false) -> void:
+	_ModLoaderHooks.add_hook(mod_callable, script_path, method_name, is_before)
+
+
 ## Registers an array of classes to the global scope since Godot only does that in the editor.[br]
 ##
 ## Format: [code]{ "base": "ParentClass", "class": "ClassName", "language": "GDScript", "path": "res://path/class_name.gd" }[/code][br]
@@ -84,8 +63,9 @@ static func register_global_classes_from_array(new_global_classes: Array) -> voi
 	var _savecustom_error: int = ProjectSettings.save_custom(_ModLoaderPath.get_override_path())
 
 
-## Adds a translation file.[br]
-##[br]
+## Adds a translation file.
+## [br]
+## [br]
 ## [i]Note: The translation file should have been created in Godot already,
 ## such as when importing a CSV file. The translation file should be in the format  [code]mytranslation.en.translation[/code].[/i][br]
 ##
@@ -106,19 +86,20 @@ static func add_translation(resource_path: String) -> void:
 		ModLoaderLog.fatal("Failed to load translation at path: %s" % [resource_path], LOG_NAME)
 
 
+
 ## [i]Note: This function requires Godot 4.3 or higher.[/i][br]
-##[br]
+## [br]
 ## Refreshes a specific scene by marking it for refresh.[br]
-##[br]
+## [br]
 ## This function is useful if a script extension is not automatically applied.
 ## This situation can occur when a script is attached to a preloaded scene.
 ## If you encounter issues where your script extension is not working as expected,
 ## try to identify the scene to which it is attached and use this method to refresh it.
 ## This will reload already loaded scenes and apply the script extension.
-##[br]
+## [br]
 ## [br][b]Parameters:[/b][br]
 ## - [code]scene_path[/code] (String): The path to the scene file to be refreshed.
-##[br]
+## [br]
 ## [br][b]Returns:[/b] [code]void[/code][br]
 static func refresh_scene(scene_path: String) -> void:
 	if scene_path in ModLoaderStore.scenes_to_refresh:
@@ -196,12 +177,12 @@ static func is_mod_loaded(mod_id: String) -> bool:
 	return true
 
 
-# Returns true if the mod with the given mod_id was successfully loaded and is currently active.
-#
-# Parameters:
-# - mod_id (String): The ID of the mod.
-#
-# Returns:
-# - bool: true if the mod is loaded and active, false otherwise.
+## Returns true if the mod with the given mod_id was successfully loaded and is currently active.
+## [br]
+## Parameters:
+## - mod_id (String): The ID of the mod.
+## [br]
+## Returns:
+## - bool: true if the mod is loaded and active, false otherwise.
 static func is_mod_active(mod_id: String) -> bool:
 	return is_mod_loaded(mod_id) and ModLoaderStore.mod_data[mod_id].is_active

addons/mod_loader/api/profile.gd

@@ -25,6 +25,17 @@ static func enable_mod(mod_id: String, user_profile:= ModLoaderStore.current_use
 	return _set_mod_state(mod_id, user_profile.name, true)
 
 
+## Forces a mod to enable, ensuring it loads at the next game start, regardless of load warnings.[br]
+## [br]
+## [b]Parameters:[/b][br]
+## - [code]mod_id[/code] ([String]): The ID of the mod to enable.[br]
+## - [code]user_profile[/code] ([ModUserProfile]): (Optional) The user profile for which the mod will be enabled. Defaults to the current user profile.[br]
+## [br]
+## [b]Returns:[/b] [bool]: True if the mod is successfully set to enable, False otherwise.
+static func force_enable_mod(mod_id: String, user_profile:= ModLoaderStore.current_user_profile) -> bool:
+	return _set_mod_state(mod_id, user_profile.name, true, true)
+
+
 ## Disables a mod - it will not be loaded on the next game start[br]
 ## [br]
 ## [b]Parameters:[/b][br]
@@ -208,7 +219,7 @@ static func _update_disabled_mods() -> void:
 	for mod_id in current_user_profile.mod_list:
 		var mod_list_entry: Dictionary = current_user_profile.mod_list[mod_id]
 		if ModLoaderStore.mod_data.has(mod_id):
-			ModLoaderStore.mod_data[mod_id].is_active = mod_list_entry.is_active
+			ModLoaderStore.mod_data[mod_id].set_mod_state(mod_list_entry.is_active, true)
 
 	ModLoaderLog.debug(
 		"Updated the active state of all mods, based on the current user profile \"%s\""
@@ -329,30 +340,25 @@ static func _generate_mod_list_entry(mod_id: String, is_active: bool) -> Diction
 
 
 # Handles the activation or deactivation of a mod in a user profile.
-static func _set_mod_state(mod_id: String, profile_name: String, activate: bool) -> bool:
+static func _set_mod_state(mod_id: String, profile_name: String, should_activate: bool, force := false) -> bool:
 	# Verify whether the mod_id is present in the profile's mod_list.
 	if not _is_mod_id_in_mod_list(mod_id, profile_name):
 		return false
 
-	# Check if it is a locked mod
-	if ModLoaderStore.mod_data.has(mod_id) and ModLoaderStore.mod_data[mod_id].is_locked:
-		ModLoaderLog.error(
-			"Unable to disable mod \"%s\" as it is marked as locked. Locked mods: %s"
-			% [mod_id, ModLoaderStore.ml_options.locked_mods],
-		LOG_NAME)
+	# Handle mod state
+	# Set state in the ModData
+	var was_toggled: bool = ModLoaderStore.mod_data[mod_id].set_mod_state(should_activate, force)
+	if not was_toggled:
 		return false
 
-	# Handle mod state
 	# Set state for user profile
-	ModLoaderStore.user_profiles[profile_name].mod_list[mod_id].is_active = activate
-	# Set state in the ModData
-	ModLoaderStore.mod_data[mod_id].is_active = activate
+	ModLoaderStore.user_profiles[profile_name].mod_list[mod_id].is_active = should_activate
 
 	# Save profiles to the user profiles JSON file
 	var is_save_success := _save()
 
 	if is_save_success:
-		ModLoaderLog.debug("Mod activation state changed: mod_id=%s activate=%s profile_name=%s" % [mod_id, activate, profile_name], LOG_NAME)
+		ModLoaderLog.debug("Mod activation state changed: mod_id=%s should_activate=%s profile_name=%s" % [mod_id, should_activate, profile_name], LOG_NAME)
 
 	return is_save_success
 

addons/mod_loader/internal/cli.gd

@@ -49,7 +49,7 @@ static func _get_fixed_cmdline_args() -> PackedStringArray:
 static func fix_godot_cmdline_args_string_space_splitting(args: PackedStringArray) -> PackedStringArray:
 	if not OS.has_feature("editor"): # only happens in editor builds
 		return args
-	if OS.has_feature("Windows"): # windows is unaffected
+	if OS.has_feature("windows"): # windows is unaffected
 		return args
 
 	var fixed_args := PackedStringArray([])