Skip to content

refactor: ♻️ non static ModManifest #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 9, 2025
Merged

refactor: ♻️ non static ModManifest #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions addons/mod_tool/interface/create_mod/create_mod.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ func _ready() -> void:

func add_mod() -> void:
# Validate mod-id
if not ModManifest.is_mod_id_valid(mod_tool_store.name_mod_dir, mod_tool_store.name_mod_dir, "", true):
if not mod_tool_store.manifest_data.is_mod_id_valid(mod_tool_store.name_mod_dir, mod_tool_store.name_mod_dir, "", true):
ModToolUtils.output_error('Invalid name or namespace: "%s". You may only use letters, numbers, underscores and at least 3 characters for each.' % mod_tool_store.name_mod_dir)
return

Expand Down Expand Up @@ -115,17 +115,17 @@ func get_template_options() -> Array[String]:


func _on_Namespace_value_changed(new_value: String, input_node: ModToolInterfaceInputString) -> void:
input_node.validate(ModManifest.is_name_or_namespace_valid(new_value, true))
input_node.validate(mod_tool_store.manifest_data.is_name_or_namespace_valid(new_value, true))
mod_id.input_text = "%s-%s" % [mod_namespace.get_input_value(), mod_name.get_input_value()]


func _on_ModName_value_changed(new_value: String, input_node: ModToolInterfaceInputString) -> void:
input_node.validate(ModManifest.is_name_or_namespace_valid(new_value, true))
input_node.validate(mod_tool_store.manifest_data.is_name_or_namespace_valid(new_value, true))
mod_id.input_text = "%s-%s" % [mod_namespace.get_input_value(), mod_name.get_input_value()]


func _on_ModId_value_changed(new_value: String, input_node: ModToolInterfaceInputString) -> void:
input_node.validate(ModManifest.is_mod_id_valid(new_value, new_value, "", true))
input_node.validate(mod_tool_store.manifest_data.is_mod_id_valid(new_value, new_value, "", true))
mod_tool_store.name_mod_dir = new_value


Expand Down
36 changes: 18 additions & 18 deletions addons/mod_tool/interface/manifest_editor/manifest_editor.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ extends PanelContainer

var input_fields := []

@onready var mod_tool_store = get_node_or_null("/root/ModToolStore")
@onready var mod_tool_store: ModToolStore = get_node_or_null("/root/ModToolStore")
@onready var manifest_input_vbox := $"%InputVBox"
@onready var input_incompatibilities: ModToolInterfaceInputString = $"%Incompatibilities"
@onready var input_dependencies: ModToolInterfaceInputString = $"%Dependencies"
Expand All @@ -23,7 +23,7 @@ func _ready() -> void:

func load_manifest() -> void:
var manifest_dict_json := _ModLoaderFile.get_json_as_dict(mod_tool_store.path_manifest)
mod_tool_store.manifest_data = ModManifest.new(manifest_dict_json)
mod_tool_store.manifest_data = ModManifest.new(manifest_dict_json, mod_tool_store.path_mod_dir)
ModToolUtils.output_info("Loaded manifest from " + mod_tool_store.path_manifest)


Expand Down Expand Up @@ -80,17 +80,17 @@ func _on_SaveManifest_pressed() -> void:

func _on_ModName_value_changed(new_text: String, input_node: ModToolInterfaceInputString) -> void:
_update_manifest_value(input_node, new_text)
input_node.validate(ModManifest.is_name_or_namespace_valid(new_text, true))
input_node.validate(mod_tool_store.manifest_data.is_name_or_namespace_valid(new_text, true))


func _on_Namespace_value_changed(new_text: String, input_node: ModToolInterfaceInputString) -> void:
_update_manifest_value(input_node, new_text)
input_node.validate(ModManifest.is_name_or_namespace_valid(new_text, true))
input_node.validate(mod_tool_store.manifest_data.is_name_or_namespace_valid(new_text, true))


func _on_Version_value_changed(new_text: String, input_node: ModToolInterfaceInputString) -> void:
_update_manifest_value(input_node, new_text)
input_node.validate(ModManifest.is_semver_valid("", new_text, "version", true))
input_node.validate(mod_tool_store.manifest_data.is_semver_valid("", new_text, "version", true))


# When dealing with Inputs that depend on other Inputs, the `input_node` is not utilized.
Expand All @@ -106,16 +106,16 @@ func _on_Dependencies_value_changed(new_text: String, input_node: ModToolInterfa
dependencies = input_dependencies.get_input_as_array_from_comma_separated_string()
_update_manifest_value(input_dependencies, dependencies)

var is_id_array_valid := ModManifest.is_mod_id_array_valid(mod_tool_store.name_mod_dir, dependencies, "dependencies", true)
var is_distinct_mod_id_incompatibilities := ModManifest.validate_distinct_mod_ids_in_arrays(
var is_id_array_valid := mod_tool_store.manifest_data.is_mod_id_array_valid(mod_tool_store.name_mod_dir, dependencies, "dependencies", true)
var is_distinct_mod_id_incompatibilities := mod_tool_store.manifest_data.validate_distinct_mod_ids_in_arrays(
mod_tool_store.name_mod_dir,
dependencies,
mod_tool_store.manifest_data.incompatibilities,
["dependencies", "incompatibilities"],
"",
true
)
var is_distinct_mod_id_optional_dependencies := ModManifest.validate_distinct_mod_ids_in_arrays(
var is_distinct_mod_id_optional_dependencies := mod_tool_store.manifest_data.validate_distinct_mod_ids_in_arrays(
mod_tool_store.name_mod_dir,
dependencies,
mod_tool_store.manifest_data.optional_dependencies,
Expand Down Expand Up @@ -144,16 +144,16 @@ func _on_OptionalDependencies_value_changed(new_text: String, input_node: ModToo
optional_dependencies = input_optional_dependencies.get_input_as_array_from_comma_separated_string()
_update_manifest_value(input_optional_dependencies, optional_dependencies)

var is_id_array_valid := ModManifest.is_mod_id_array_valid(mod_tool_store.name_mod_dir, optional_dependencies, "optional_dependencies", true)
var is_distinct_mod_id_incompatibilities := ModManifest.validate_distinct_mod_ids_in_arrays(
var is_id_array_valid := mod_tool_store.manifest_data.is_mod_id_array_valid(mod_tool_store.name_mod_dir, optional_dependencies, "optional_dependencies", true)
var is_distinct_mod_id_incompatibilities := mod_tool_store.manifest_data.validate_distinct_mod_ids_in_arrays(
mod_tool_store.name_mod_dir,
optional_dependencies,
mod_tool_store.manifest_data.incompatibilities,
["optional_dependencies", "incompatibilities"],
"",
true
)
var is_distinct_mod_id_dependencies := ModManifest.validate_distinct_mod_ids_in_arrays(
var is_distinct_mod_id_dependencies := mod_tool_store.manifest_data.validate_distinct_mod_ids_in_arrays(
mod_tool_store.name_mod_dir,
optional_dependencies,
mod_tool_store.manifest_data.dependencies,
Expand All @@ -172,7 +172,7 @@ func _on_OptionalDependencies_value_changed(new_text: String, input_node: ModToo
func _on_CompatibleModLoaderVersions_value_changed(new_text: String, input_node: ModToolInterfaceInputString) -> void:
var compatible_modloader_versions := input_node.get_input_as_array_from_comma_separated_string()
_update_manifest_value(input_node, compatible_modloader_versions)
input_node.validate(ModManifest.is_semver_version_array_valid(mod_tool_store.name_mod_dir, compatible_modloader_versions, "Compatible ModLoader Versions", true))
input_node.validate(mod_tool_store.manifest_data.is_semver_version_array_valid(mod_tool_store.name_mod_dir, compatible_modloader_versions, "Compatible ModLoader Versions", true))


# When dealing with Inputs that depend on other Inputs, the `input_node` is not utilized.
Expand All @@ -188,16 +188,16 @@ func _on_Incompatibilities_value_changed(new_text: String, input_node: ModToolIn
incompatibilities = input_incompatibilities.get_input_as_array_from_comma_separated_string()
_update_manifest_value(input_incompatibilities, incompatibilities)

var is_mod_id_array_valid := ModManifest.is_mod_id_array_valid(mod_tool_store.name_mod_dir, incompatibilities, "incompatibilities", true)
var is_distinct_mod_id_dependencies := ModManifest.validate_distinct_mod_ids_in_arrays(
var is_mod_id_array_valid := mod_tool_store.manifest_data.is_mod_id_array_valid(mod_tool_store.name_mod_dir, incompatibilities, "incompatibilities", true)
var is_distinct_mod_id_dependencies := mod_tool_store.manifest_data.validate_distinct_mod_ids_in_arrays(
mod_tool_store.name_mod_dir,
mod_tool_store.manifest_data.dependencies,
incompatibilities,
["dependencies", "incompatibilities"],
"",
true
)
var is_distinct_mod_id_optional_dependencies := ModManifest.validate_distinct_mod_ids_in_arrays(
var is_distinct_mod_id_optional_dependencies := mod_tool_store.manifest_data.validate_distinct_mod_ids_in_arrays(
mod_tool_store.name_mod_dir,
mod_tool_store.manifest_data.optional_dependencies,
incompatibilities,
Expand Down Expand Up @@ -226,16 +226,16 @@ func _on_LoadBefore_value_changed(new_text: String, input_node: ModToolInterface
load_before = input_load_before.get_input_as_array_from_comma_separated_string()
_update_manifest_value(input_load_before, load_before)

var is_mod_id_array_valid := ModManifest.is_mod_id_array_valid(mod_tool_store.name_mod_dir, load_before, "load_before", true)
var is_distinct_mod_id_dependencies := ModManifest.validate_distinct_mod_ids_in_arrays(
var is_mod_id_array_valid := mod_tool_store.manifest_data.is_mod_id_array_valid(mod_tool_store.name_mod_dir, load_before, "load_before", true)
var is_distinct_mod_id_dependencies := mod_tool_store.manifest_data.validate_distinct_mod_ids_in_arrays(
mod_tool_store.name_mod_dir,
load_before,
mod_tool_store.manifest_data.dependencies,
["load_before", "dependencies"],
"\"load_before\" should be handled as optional dependency adding it to \"dependencies\" will cancel out the desired effect.",
true
)
var is_distinct_mod_id_optional_dependencies := ModManifest.validate_distinct_mod_ids_in_arrays(
var is_distinct_mod_id_optional_dependencies := mod_tool_store.manifest_data.validate_distinct_mod_ids_in_arrays(
mod_tool_store.name_mod_dir,
load_before,
mod_tool_store.manifest_data.optional_dependencies,
Expand Down
2 changes: 1 addition & 1 deletion addons/mod_tool/scripts/hook_gen.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ extends RefCounted


static func transform_one(path: String, mod_tool_store: ModToolStore) -> Error:
var source_code_processed := mod_tool_store.mod_hook_preprocessor.process_script(path)
var source_code_processed := mod_tool_store.mod_hook_preprocessor.process_script(path, true)
var backup_path := "%s/%s" % [mod_tool_store.path_script_backup_dir, path.trim_prefix("res://")]

# Create a backup of the vanilla script files
Expand Down