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

Assert modloader is first autoload #96

Merged
merged 2 commits into from
Feb 5, 2023
Merged

Assert modloader is first autoload #96

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c87b589
assert that ModLoader is the first autoload
ithinkandicode Feb 5, 2023
c38e2bf
rename var to `is_mod_loader_first`
ithinkandicode Feb 5, 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
37 changes: 37 additions & 0 deletions addons/mod_loader/mod_loader.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,9 @@ func _init() -> void:
if REQUIRE_CMD_LINE and not ModLoaderUtils.is_running_with_command_line_arg("--enable-mods"):
return

# Ensure ModLoader is the first autoload
_check_first_autoload()

# Log game install dir
ModLoaderUtils.log_info("game_install_directory: %s" % ModLoaderUtils.get_local_folder_dir(), LOG_NAME)

Expand Down Expand Up @@ -160,6 +163,40 @@ func _init() -> void:
ModLoaderUtils.log_success("DONE: Completely finished loading mods", LOG_NAME)


# Ensure ModLoader is the first autoload
func _check_first_autoload() -> void:
var autoloads := {}
var autoload_index = 0
var is_mod_loader_first = false

for prop in ProjectSettings.get_property_list():
var name: String = prop.name
if name.begins_with("autoload/"):
if autoload_index == 0:
if name == "autoload/ModLoader":
is_mod_loader_first = true
var value: String = ProjectSettings.get_setting(name)
autoloads[name] = value
autoload_index += 1

# Log the autoloads order. Might seem superflous but could help when providing support
ModLoaderUtils.log_debug_json_print("Autoload order", autoloads, LOG_NAME)

var base_msg = "ModLoader needs to be the first autoload to work correctly, "
var help_msg = ""

if OS.has_feature("editor"):
help_msg = "To configure your autoloads, to go Project > Project Settings > Autoload, and add ModLoader as the first item. For more info, see the 'Godot Project Setup' page on the ModLoader GitHub wiki."
else:
help_msg = "If you're seeing this error, something must have gone wrong in the setup process."

if not is_mod_loader_first:
ModLoaderUtils.log_fatal(str(base_msg, 'but the first autoload is currently: "%s". ' % name, help_msg), LOG_NAME)

if autoloads.size() == 0:
ModLoaderUtils.log_fatal(str(base_msg, "but no autoloads are currently set up. ", help_msg), LOG_NAME)


# Loop over "res://mods" and add any mod zips to the unpacked virtual directory
# (UNPACKED_DIR)
func _load_mod_zips() -> int:
Expand Down