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

Jump to bottom

Improve Comments #42

Merged
merged 4 commits into from
Jan 16, 2023
Merged

Improve Comments #42

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9f14128
improve comments
ithinkandicode Jan 16, 2023
e03daf6
change zipped mods warning to be more generic ("resource packs" inste…
ithinkandicode Jan 16, 2023
7acd4c2
fix typo in zipped mods warning
ithinkandicode Jan 16, 2023
145160d
Merge branch 'main' into improve-comments
ithinkandicode Jan 16, 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
20 changes: 14 additions & 6 deletions loader/mod_loader.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,11 @@ var mod_data = {}
# Order for mods to be loaded in, set by `_get_load_order`
var mod_load_order = []

# Override for the path mods are loaded from. Only gets set if the CLI arg
# --mods-path is used. This can be tested in the editor via:
# Project Settings > Display> Editor > Main Run Args
# Override for the path mods are loaded from. Only set if the CLI arg is present.
# Can be tested in the editor via: Project Settings > Display> Editor > Main Run Args
# Default: "res://mods"
# Set via: --mods-path
# Example: --mods-path="C://path/mods"
var os_mods_path_override = ""

# Any mods that are missing their dependancies are added to this
Expand Down Expand Up @@ -214,6 +216,8 @@ func mod_log(text:String, mod_name:String = "Unknown-Mod", pretty:bool = false)-
log_file.close()


# Loop over "res://mods" and add any mod zips to the unpacked virtual directory
# (UNPACKED_DIR)
func _load_mod_zips():
# Path to the games mod folder
var game_mod_folder_path = _get_local_folder_dir("mods")
Expand Down Expand Up @@ -252,12 +256,15 @@ func _load_mod_zips():
var is_mod_loaded_success = ProjectSettings.load_resource_pack(mod_folder_global_path, false)

# Notifies developer of an issue with Godot, where using `load_resource_pack`
# in the editor WIPES the entire res:// directory the first time you use it:
# in the editor WIPES the entire virtual res:// directory the first time you
# use it. This means that unpacked mods are no longer accessible, because they
# no longer exist in the file system. So this warning basically says
# "don't use ZIPs with unpacked mods!"
# https://github.com/godotengine/godot/issues/19815
# https://github.com/godotengine/godot/issues/16798
if OS.has_feature("editor") && !has_shown_editor_warning:
mod_log(str(
"WARNING: Loading files with `load_resource_pack` will WIPE the entire virtual res:// directory. ",
"WARNING: Loading any resource packs (.zip/.pck) with `load_resource_pack` will WIPE the entire virtual res:// directory. ",
"If you have any unpacked mods in ", UNPACKED_DIR, ", they will not be loaded. ",
"Please unpack your mod ZIPs instead, and add them to ", UNPACKED_DIR), LOG_NAME)
has_shown_editor_warning = true
Expand All @@ -276,6 +283,8 @@ func _load_mod_zips():
dir.list_dir_end()


# Loop over UNPACKED_DIR and triggers `_init_mod_data` for each mod directory,
# which adds their data to mod_data.
func _setup_mods():
# Path to the unpacked mods folder
var unpacked_mods_path = UNPACKED_DIR
Expand Down Expand Up @@ -489,7 +498,6 @@ func _init_mod(mod):
add_child(mod_main_instance, true)



# Utils (Mod Loader)
# =============================================================================

Expand Down