Self installation #33

Qubus0 · 2023-01-15T22:36:38Z

to test:

automatic loader setup: add this startup flag --script addons/mod_loader_tools/mod_loader_setup_helper.gd and nothing else. Start the game from the editor or from steam. I won't tell you what the things in the UI are. if something is unclear, tell me because then it needs to be changed.
1. try out the method mentioned in the readme under For Mod Loader Developers > Clean Setup

Note: you will have to restart the game manually after first load to make the override kick in

Let me know what you think!

…ectory, add ui layouts

# Conflicts: # README.md

# Conflicts: # README.md # addons/mod_loader_tools/mod_loader.gd

ithinkandicode · 2023-01-16T09:18:13Z

Compiled PCK for Brotato, hosted this myself due to GitHub's upload limits:

https://brotato.codemuffin.com/_files/Brotato--ModLoader-PR-33.zip

Two test mods, they simply append the version on the title screen.
The 2nd has the 1st as a dependency, so it won't work without it:

ithinkandicode · 2023-01-16T09:24:11Z

Screenshots

Initial Setup - always shown on first load:

After initial setup, with no mods in ./mods. Starts in fullscreen:

After adding mods and restarting:

After disabling the fullscreen through Brotato's own options, restarting, and enabling 1 mod:

Qubus0 · 2023-01-16T09:52:17Z

README.md

-For detailed info, see the [docs for Delta-V Modding](https://gitlab.com/Delta-V-Modding/Mods/-/blob/main/MODDING.md), upon which ModLoader is based. The docs there cover mod setup and helper functions in much greater detail.
-
-## Mod Setup
+## Table of Contents


i've just moved it further down https://github.com/GodotModding/godot-mod-loader/pull/33/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R206

Qubus0 · 2023-01-16T09:54:59Z

I will decouple the interface from the self setup and the loader so the user can choose if they want to use it or an external tool/ do it manually

Qubus0 · 2023-01-16T09:55:56Z

README.md

+  * [For Everyone](#for-everyone)
+    * [Folder locations](#folder-locations)
+  * [Credits](#credits)
+<!-- TOC -->


yes, completely agree. it's just something for another pr

ithinkandicode

The code itself looks fine. Most of my notes are for the README. There's also notes on duped code and making comments clearer. The only major issue is using a separate dir for the save files, which would disable Steam saves and has shown to be confusing for users.

README.md

ithinkandicode · 2023-01-16T11:00:08Z

addons/mod_loader_tools/mod_loader_helper.gd

+		ProjectSettings.get_setting(project_setting)
+
+
+static func cmd_line_arg_exists(argument: String) -> bool:


duped from mod_loader

there are a few dupes in here, which I would prefer to move over here as static methods.

Is mod_loader_helper.gd called before mod_loader.gd? I can understand why these methods would be duped if that's the case.

Would it be viable to make another class, eg "mod_loader_utils" or something, and have that as the top-most autoload? It could contain the duped methods for stuff like getting CLI args, probably logging too, which would have the extra benefit of making the methods in mod_loader focused entirely on just loading mods.

ModLoader is not available in the setup helper before it is, well, set up. That also means having another autoload won't fix it. I even have to use the classes directly from the script because the class isn't registered as global yet.

# mod_loader_setup_helper.gd # IMPORTANT: use the ModLoaderHelper through this in this script! Otherwise # script compilation will break on first load since the class is not defined var modloaderhelper: Node = load("res://addons/mod_loader_tools/mod_loader_helper.gd").new() var skip_mod_selection: bool = modloaderhelper.should_skip_mod_selection() # mod_loader_helper.gd static func should_skip_mod_selection() -> bool: return cmd_line_arg_exists("--skip-mod-selection") or\ is_project_setting_true(settings.SKIP_MOD_SELECTION)

So if I understand it correctly, mod_loader_helper is a set of static utilities, is that right?

It seems like this should be a larger, separate PR: One that makes such a utility class, and moves anything that's potentially duplicatable out of mod_loader and into its utility class

I think the filenames could be shortened too. Eg "mod_loader_setup_helper" could just be called "autosetup.gd", and "mod_loader_helper" could just be "utils.gd".

ithinkandicode · 2023-01-16T11:01:56Z

addons/mod_loader_tools/mod_loader_helper.gd

+# 3.x does not support ligatures (eg. "tag" being replaced by the glyph)
+# so the glyph is used directly (but it's invisible in the code editor :/ )
+# the name is the same as used in font awesome
+# refer to https://fontawesome.com/search?o=r&m=free&s=solid&f=classic


Having things that are invisible in the editor isn't really desirable as it can easily cause issues

I agree. the only way to make them visible is to change the editor font though

Contributors may be editing these files in Godot, rather than an external editor, so I think making things invisible could be a point of impasse here. Is there an alternative implementation to whatever FontAwesome is used for here?

addons/mod_loader_tools/mod_loader_setup_helper.gd

ithinkandicode · 2023-01-16T11:06:31Z

addons/mod_loader_tools/mod_loader_setup_helper.gd

+	# rename application to make it clear to the user that they are playing modded
+	# godot also creates a new user:// folder for logs (and other things using user:// for saves etc.)
+	var original_name: String = ProjectSettings.get_setting(modloaderhelper.settings.APPLICATION_NAME)
+	ProjectSettings.set_setting(modloaderhelper.settings.APPLICATION_NAME, original_name + " (Modded)")


Definitely not a fan of this, users will think their progress has been wiped (as they do for Brotato mods like Assassin, which disables Steam). It also disables Steam saves, which we shouldn't do. Using mods shouldn't affect how the game loads your save file.

It's a good idea in theory, but we've seen how this plays out in practice with Brotato.

addons/mod_loader_tools/mod_loader_setup_helper.gd

ithinkandicode · 2023-01-16T11:32:58Z

~~Notes on the GUI itself~~

Moved to PR #36

README.md

Qubus0 · 2023-01-16T12:07:49Z

@ithinkandicode we should merge your pr first, then adjust and merge this one on top.

let's keep the whole readme out of this and reconsolidate it into a proper wiki with separate pages for everything. I have created an issue for that where we can discuss everything: #35. I'll resolve all the comments about the readme here so we can focus on the code
What we do with the Interface branch is also a thing we can decide after that

ithinkandicode · 2023-01-16T16:27:05Z

@Qubus0 I've copied over the content from the README in this PR to a temporary wiki page:

https://github.com/GodotModding/godot-mod-loader/wiki/@TEMP:-PR33

This ensures we keep your new content safe, which should help you fix any merge conflicts with the newer README from the main branch.

# Conflicts: # addons/mod_loader_tools/mod_loader.gd

ithinkandicode · 2023-01-16T23:36:19Z

So I think that what's being done in this PR would benefit from being split into smaller PRs. Atm you have:

The auto setup stuff (setup_helper)
A utility file, with some duped stuff from mod_loader.gd (helper)
A mod class, with its own validation (mod_details)
Code that adds support for the GUI in #36

I think you could split this into four PRs, one for each of the above

ithinkandicode · 2023-01-17T00:04:24Z

RE: override.cfg is used: What happens when the game updates? It looks like the override.cfg that got created when I ran the setup for Brotato includes all the vanilla stuff. Can you use an override.cfg that only includes certain settings, or does it have to be the entire project?

If it has to be the entire project's configs, perhaps could you check to see if the game has been updated since override.cfg was created? Eg. you could create a backup of the vanilla override.cfg during the initial setup phase, then you could re-regenerate it from vanilla again later and check its checksum. That'd show you if anything's been changed in vanilla

(note: I think I said this elsewhere but can't find it)

Qubus0 · 2023-01-17T10:01:58Z

oh yep good idea. the interface only covers manual resets so far

Qubus0 · 2023-01-17T14:43:27Z

reworking this into multiple new prs

ithinkandicode · 2023-01-17T14:43:45Z

oh yep good idea. the interface only covers manual resets so far

Cool. I mentioned saving a copy of the vanilla override.cfg, just noting here that it might be best to save it in user:// so it doesn't bloat the game dir too much.

Qubus0 added 7 commits January 12, 2023 23:28

allow self-installing through helper script, move mod into addons dir…

46db461

…ectory, add ui layouts

add readme toc, fix layout

b05b14c

Merge branch 'main' into self_installation_and_ui

31e47f6

Merge branch 'main' into self_installation_and_ui

c5e218d

# Conflicts: # README.md

finish basic mod detail and selection ui

68df2c1

Merge branch 'main' into self_installation_and_ui

3e784ad

# Conflicts: # README.md # addons/mod_loader_tools/mod_loader.gd

fix issues setting up without editor by removing static types

6b3b58b

Qubus0 requested review from a team, ithinkandicode, KANAjetzt and otDan and removed request for a team January 15, 2023 22:37

This was linked to issues Jan 15, 2023

Mod Loader without editing source code (Automatic Self Install Setup) #8

Closed

Remove the need to add a cmd line arg for run.gd #9

Closed

[meta.json] "Enabled" option #19

Closed

Qubus0 commented Jan 16, 2023

View reviewed changes

remove interface for separate pr

ec05f56

Qubus0 mentioned this pull request Jan 16, 2023

Only Interface PR #36

Closed

ithinkandicode reviewed Jan 16, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

fix issue with finding loader node on game start

b90ed1d

Qubus0 mentioned this pull request Jan 16, 2023

create a wiki and shrink the README.md #35

Closed

Qubus0 changed the title ~~Self installation and UI~~ Self installation Jan 16, 2023

Qubus0 added 2 commits January 16, 2023 17:48

reset README.md to main state, used wiki instead

91fbd4e

Merge branch 'main' into self_installation

6159b91

# Conflicts: # addons/mod_loader_tools/mod_loader.gd

resolve merge issues

70e503e

Qubus0 closed this Jan 17, 2023

Qubus0 deleted the self_installation_and_ui branch January 19, 2023 22:50

Qubus0 mentioned this pull request Jan 23, 2023

Self setup #75

Merged

Qubus0 mentioned this pull request Feb 13, 2023

Add option to disable certain mods via JSON #109

Closed

ithinkandicode mentioned this pull request Feb 27, 2023

Update docs for latest release (5.0.1) #126

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Self installation #33

Self installation #33

Qubus0 commented Jan 15, 2023 •

edited

Loading

ithinkandicode commented Jan 16, 2023

ithinkandicode commented Jan 16, 2023 •

edited

Loading

Qubus0 Jan 16, 2023

Qubus0 commented Jan 16, 2023

Qubus0 Jan 16, 2023

ithinkandicode left a comment

ithinkandicode Jan 16, 2023

Qubus0 Jan 16, 2023

ithinkandicode Jan 16, 2023

Qubus0 Jan 16, 2023

ithinkandicode Jan 16, 2023 •

edited

Loading

ithinkandicode Jan 16, 2023

Qubus0 Jan 16, 2023

ithinkandicode Jan 16, 2023

ithinkandicode Jan 16, 2023

ithinkandicode commented Jan 16, 2023 •

edited

Loading

Qubus0 commented Jan 16, 2023

ithinkandicode commented Jan 16, 2023

ithinkandicode commented Jan 16, 2023

ithinkandicode commented Jan 17, 2023

Qubus0 commented Jan 17, 2023

Qubus0 commented Jan 17, 2023

ithinkandicode commented Jan 17, 2023

		ProjectSettings.get_setting(project_setting)


		static func cmd_line_arg_exists(argument: String) -> bool:

Self installation #33

Self installation #33

Conversation

Qubus0 commented Jan 15, 2023 • edited Loading

ithinkandicode commented Jan 16, 2023

ithinkandicode commented Jan 16, 2023 • edited Loading

Choose a reason for hiding this comment

Qubus0 commented Jan 16, 2023

Choose a reason for hiding this comment

ithinkandicode left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ithinkandicode Jan 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ithinkandicode commented Jan 16, 2023 • edited Loading

Qubus0 commented Jan 16, 2023

ithinkandicode commented Jan 16, 2023

ithinkandicode commented Jan 16, 2023

ithinkandicode commented Jan 17, 2023

Qubus0 commented Jan 17, 2023

Qubus0 commented Jan 17, 2023

ithinkandicode commented Jan 17, 2023

Qubus0 commented Jan 15, 2023 •

edited

Loading

ithinkandicode commented Jan 16, 2023 •

edited

Loading

ithinkandicode Jan 16, 2023 •

edited

Loading

ithinkandicode commented Jan 16, 2023 •

edited

Loading