Skip to content
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

feat: context action to create overwrites #41

Merged
merged 14 commits into from
Mar 17, 2023
Merged

feat: context action to create overwrites #41

Changes from 11 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
88e5faf
refactor: :truck: improved file structure
KANAjetzt Mar 14, 2023
03ad417
fix: append line at end of function, properly open and close file
Qubus0 Mar 14, 2023
6195a33
feat: add asset overwriting to file system context menu
Qubus0 Mar 15, 2023
aa113ad
feat: change dock path
Qubus0 Mar 15, 2023
3dcef78
refactor: :truck: improved file structure
KANAjetzt Mar 14, 2023
035b741
feat: change dock path
Qubus0 Mar 15, 2023
cb3a332
Merge branch 'file_structure' into fix/file_system_context_actions
Qubus0 Mar 15, 2023
eb8f928
Merge branch 'fix/file_system_context_actions' into feat/context_acti…
Qubus0 Mar 15, 2023
b85129b
Merge branch 'main' into fix/file_system_context_actions
Qubus0 Mar 17, 2023
18e918a
Merge branch 'fix/file_system_context_actions' into feat/context_acti…
Qubus0 Mar 17, 2023
167b8ec
fix: remove invalid pass
Qubus0 Mar 17, 2023
1b31a67
fix: remove comment
Qubus0 Mar 17, 2023
d23da24
Merge branch 'main' into feat/context_actions_overwrites
Qubus0 Mar 17, 2023
696f247
fix: resolve merge
Qubus0 Mar 17, 2023
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
174 changes: 150 additions & 24 deletions addons/mod_tool/interface/file_system/file_system_context_actions.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,18 +77,25 @@ func add_custom_context_actions(context_menu: PopupMenu, file_paths: PoolStringA
return

var script_paths := []
var asset_override_paths := []
for file_path in file_paths:
if dir.dir_exists(file_path):
continue

if dir.file_exists(file_path):
if file_path.ends_with(".gd"):
script_paths.append(file_path)
continue
if file_path.ends_with(".tscn") or file_path.ends_with(".tres"):
continue
asset_override_paths.append(file_path)

if script_paths.size() > 0:
if script_paths.size() > 0 or asset_override_paths.size() > 0:
context_menu.add_separator()

if script_paths.size() > 0:
context_menu.add_icon_item(
base_theme.get_icon("Override", "EditorIcons"),
base_theme.get_icon("ScriptExtend", "EditorIcons"),
"ModTool: Create Script Extension" + ("s (%s)" % script_paths.size() if script_paths.size() > 1 else "")
)
context_menu.set_item_metadata(
Expand All @@ -97,10 +104,25 @@ func add_custom_context_actions(context_menu: PopupMenu, file_paths: PoolStringA
)
context_menu.set_item_tooltip(
context_menu.get_item_count() -1,
"Will add overrides for: \n%s" %
"Will add extensions for: \n%s" %
str(script_paths).trim_prefix("[").trim_suffix("]").replace(", ", "\n")
)

if asset_override_paths.size() > 0:
context_menu.add_icon_item(
base_theme.get_icon("Override", "EditorIcons"),
"ModTool: Create Asset Overwrite" + ("s (%s)" % asset_override_paths.size() if asset_override_paths.size() > 1 else "")
)
context_menu.set_item_metadata(
context_menu.get_item_count() -1,
{ "mod_tool_override_paths": asset_override_paths }
)
context_menu.set_item_tooltip(
context_menu.get_item_count() -1,
"Will overwrite assets: \n%s" %
str(asset_override_paths).trim_prefix("[").trim_suffix("]").replace(", ", "\n")
)


func file_system_context_menu_pressed(id: int, context_menu: PopupMenu) -> void:
var file_paths: PoolStringArray
Expand All @@ -109,14 +131,19 @@ func file_system_context_menu_pressed(id: int, context_menu: PopupMenu) -> void:
# Ensure that the metadata is actually set by the ModTool
# Since id and index of the item can always change
if metadata is Dictionary and metadata.has("mod_tool_script_paths"):
var file := File.new()

file_paths = metadata.mod_tool_script_paths
for file_path in file_paths:
var extension_path := create_script_extension(file_path)
if extension_path:
add_script_extension_to_mod_main(file, extension_path)
file.close()
add_script_extension_to_mod_main(extension_path)
ModToolStore.editor_plugin.get_editor_interface().get_script_editor().reload_scripts()

if metadata is Dictionary and metadata.has("mod_tool_override_paths"):
file_paths = metadata.mod_tool_override_paths
for file_path in file_paths:
var asset_path := create_overwrite_asset(file_path)
if asset_path:
add_asset_overwrite_to_overwrites(file_path, asset_path)
ModToolStore.editor_plugin.get_editor_interface().get_script_editor().reload_scripts()


Expand All @@ -143,13 +170,16 @@ static func create_script_extension(file_path: String) -> String:
return extension_path


static func add_script_extension_to_mod_main(file: File, extension_path: String):
static func add_script_extension_to_mod_main(extension_path: String) -> void:
var file := File.new()
var main_script_path := ModToolStore.path_mod_dir.plus_file("mod_main.gd")
if not mod_has_install_script_extensions_method(main_script_path):
if not script_has_method(main_script_path, "install_script_extensions"):
ModToolUtils.output_error('To automatically add new script extensions to "mod_main.gd", add the method "install_script_extensions" to it.')
return

file.open(main_script_path, File.READ_WRITE)
file.open(main_script_path, File.READ)
var file_content := file.get_as_text()
file.close()

var index_find_from := file_content.find("func install_script_extensions")
var mod_extensions_dir_path_index := file_content.find("extensions_dir_path", index_find_from)
Expand All @@ -158,31 +188,127 @@ static func add_script_extension_to_mod_main(file: File, extension_path: String)
# variable "extensions_dir_path" is found, use that variable in combination with plus_file
var extension_install_line := "\tmodLoader.install_script_extension(%s)\n"
if mod_extensions_dir_path_index == -1:
extension_install_line = extension_install_line % '"%s"' % extension_path
extension_install_line = extension_install_line % quote_string(extension_path)
else:
extension_path = extension_path.trim_prefix(ModToolStore.path_mod_dir.plus_file("extensions/"))
extension_install_line = extension_install_line % 'extensions_dir_path.plus_file("%s")' % extension_path
extension_install_line = extension_install_line % "extensions_dir_path.plus_file(%s)" % quote_string(extension_path)

# Check if that file was already used as script extension
if extension_install_line.strip_edges() in file_content:
return

var last_install_line_index := file_content.find_last("modLoader.install_script_extension")
# If there is no modLoader.install_script_extension yet, put it directly under install_script_extensions
if last_install_line_index == -1:
last_install_line_index = file_content.find_last("install_script_extensions")
var last_install_line_end_index := file_content.find("\n", last_install_line_index)

if not extension_install_line.strip_edges() in file_content:
# If there is no modLoader.install_script_extension yet, put it at the end of install_script_extensions
var insertion_index := get_index_at_method_end("install_script_extensions", file_content)
file_content = file_content.insert(insertion_index, "\n" + extension_install_line)
else:
var last_install_line_end_index := file_content.find("\n", last_install_line_index)
file_content = file_content.insert(last_install_line_end_index +1, extension_install_line)
file.store_string(file_content)
ModToolUtils.output_info('Added script extension "%s" to mod "%s"' % [extension_path, main_script_path.get_base_dir().get_file()])

file.open(main_script_path, File.WRITE)
file.store_string(file_content)
file.close()
ModToolUtils.output_info('Added script extension "%s" to mod "%s"' % [extension_path, main_script_path.get_base_dir().get_file()])


func create_overwrite_asset(file_path: String) -> String:
if not ModToolStore.name_mod_dir:
ModToolUtils.output_error("Select an existing mod or create a new one to overwrite assets")
return ""

var file_directory := file_path.get_base_dir().trim_prefix("res://")
var overwrite_directory: String = ModToolStore.path_mod_dir.plus_file("overwrites").plus_file(file_directory)
ModToolUtils.make_dir_recursive(overwrite_directory)

var dir := Directory.new()
var overwrite_path := overwrite_directory.plus_file(file_path.get_file())
if not dir.file_exists(overwrite_path):
dir.copy(file_path, overwrite_path)
ModToolUtils.output_info('Copied asset "%s" as overwrite to path %s' % [file_path.get_file(), overwrite_path])

ModToolStore.editor_file_system.scan()
ModToolStore.editor_plugin.get_editor_interface().get_file_system_dock().navigate_to_path(overwrite_path)

return overwrite_path


static func add_asset_overwrite_to_overwrites(vanilla_asset_path: String, asset_path: String) -> void:
var file := File.new()
var overwrites_script_path := ModToolStore.path_mod_dir.plus_file("overwrites.gd")
if not file.file_exists(overwrites_script_path):
file.open(overwrites_script_path, File.WRITE)
file.store_line("extends Node\n\n")
file.store_line("func _init() -> void:")
file.close()

if not script_has_method(overwrites_script_path, "_init"):
file.open(overwrites_script_path, File.READ_WRITE)
file.store_string(file.get_as_text() + "\nfunc _init() -> void:\n")
file.close()

file.open(overwrites_script_path, File.READ)
var file_content := file.get_as_text()
file.close()

# Construct the line required to preload the asset and take over the path
var asset_overwrite_line := "\tpreload(%s).take_over_path(%s)\n" % [quote_string(asset_path), quote_string(vanilla_asset_path)]

# Check if that asset is already being overwritten
if asset_overwrite_line.strip_edges() in file_content:
return

# If there is no modLoader.install_script_extension yet, put it at the end of install_script_extensions
Qubus0 marked this conversation as resolved.
Show resolved Hide resolved
var insertion_index := get_index_at_method_end("_init", file_content)
file_content = file_content.insert(insertion_index, "\n" + asset_overwrite_line)

file.open(overwrites_script_path, File.WRITE)
file.store_string(file_content)
file.close()
ModToolUtils.output_info('Added asset overwrite "%s" to mod "%s"' % [asset_path, overwrites_script_path.get_base_dir().get_file()])


static func get_index_at_method_end(method_name: String, text: String) -> int:
var starting_index := text.find_last(method_name)

# Find the end of the method
var next_method_line_index := text.find("func ", starting_index)
var method_end := -1

if next_method_line_index == -1:
# Backtrack empty lines from the end of the file
method_end = text.length() -1
else:
# Get the line before the next function line
method_end = text.rfind("\n", next_method_line_index)

# Backtrack to the last non-empty line
var last_non_empty_line_index := method_end
while last_non_empty_line_index > starting_index:
last_non_empty_line_index -= 1
# Remove spaces, tabs and newlines (whitespace) to check if the line really is empty
if text[last_non_empty_line_index].rstrip("\t\n "):
break # encountered a filled line

return last_non_empty_line_index +1


static func mod_has_install_script_extensions_method(main_script_path: String) -> bool:
var main_script: Script = load(main_script_path)
static func quote_string(string: String) -> String:
var settings := ModToolStore.editor_plugin.get_editor_interface().get_editor_settings()
if settings.get_setting("text_editor/completion/use_single_quotes"):
return "'%s'" % string
return "\"%s\"" % string

for method in main_script.get_script_method_list():
if method.name == "install_script_extensions":

static func script_has_method(script_path: String, method: String) -> bool:
var script: Script = load(script_path)

for script_method in script.get_script_method_list():
if script_method.name == method:
return true

ModToolUtils.output_error('To automatically add new script extensions to "mod_main.gd", add the method "install_script_extensions" to it.')
if method in script.source_code:
return true

return false