feat: Bad mod formatting warnings

[Alystrasz]

While loading mods, this checks if a mod.json file is present in mods directories; if not, this will display a warning message, telling user mod hasn't been installed properly.

This does not analyze hidden directories (with a filename beginning with a .).

Depends on (cyclic dependency):

• Add UI Notification for Invalid Mod Installs NorthstarMods#597

[Alystrasz]

@GeckoEidechse if you want to keep doing your shenanigans, this will ignore your git folders 😁

[GeckoEidechse]

@GeckoEidechse if you want to keep doing your shenanigans, this will ignore your git folders grin

Depending on how fast VTOL switches to using enabledmods.json we might also have to ignore the disabled folder it uses to hide the mod.json.
@BigSpice is there an ETA on the fix in VTOL? ^^

[GeckoEidechse]

Actually I just realised that this might also cause issues for players where there is a leftover disabled folder in the mods dir. Not sure if Viper ever cleaned that up after switching to enabledmods.json.

It might make more sense to check folder recursively for mod.json and only warn if there is actually one in a subdirectory.

[Alystrasz]

It might make more sense to check folder recursively for mod.json and only warn if there is actually one in a subdirectory.

What about mod folders with no mod.json file? (quite unlikely, I know)

[GeckoEidechse]

What about mod folders with no mod.json file? (quite unlikely, I know)

For that to occur, the player must have manually deleted that file, given that a mod author wouldn't release a mod with missing mod.json cause that mod would have never loaded on their end in the first place. I'd argue that this would be a rarer occurrence then a player accidentally creating an empty folder. ^^

[Alystrasz]

It might make more sense to check folder recursively for mod.json and only warn if there is actually one in a subdirectory.

Addressed in c0e44c9.

[BobTheBob9]

concept is good, but would be nicer if this was exposed to script and shown in ui, rather than than shown as a messagebox? messagebox would be annoying in cases where mod formatting isn't an issue since it'd block execution

[Alystrasz]

concept is good, but would be nicer if this was exposed to script and shown in ui, rather than than shown as a messagebox?

What method would you use to show error message in UI? All cool UI methods I know are callable from Squirrel VM.

messagebox would be annoying in cases where mod formatting isn't an issue since it'd block execution

Yeah that's also cool, because this way we're sure user knows some of their mods are fucked (in comparison with a notification that closes automatically without user noticing it)

[BobTheBob9]

What method would you use to show error message in UI? All cool UI methods I know are callable from Squirrel VM.

something on the title screen to display warnings would work, would need to expose all messages to squirrel on reload and do some ui stuff in script to display them

Yeah that's also cool, because this way we're sure user knows some of their mods are fucked (in comparison with a notification that closes automatically without user noticing it)

it'd be very annoying for developers in situations where they know they'll get the warning and don't want to wait for a blocking textbox every startup, is what i'm thinking

[Alystrasz]

Marking this as draft while I refactor to address comments.

[uniboi]

What method would you use to show error message in UI? All cool UI methods I know are callable from Squirrel VM.

Define a global function in the UI that displays a dialog / menu / submenu that explains what's going on and call that function from native after the UI VM is initialized and mods that are formatted wrong are detected

[Alystrasz]

Reviews have been addressed, @uniboi implemented the UI part in R2Northstar/NorthstarMods#597.
I'm marking this as ready for reviews.

[uniboi]

Do note that this changes the function signatures of some script methods as they are currently incorrect. R2Northstar/NorthstarMods#597 fixes those issues as well.

[GeckoEidechse]

@Alystrasz just a heads-up that this PR sadly has merge conflicts now ^^"

[Alystrasz]

@Alystrasz just a heads-up that this PR sadly has merge conflicts now ^^"

Done :)

[ASpoonPlaysGames]

@Alystrasz would this need a rework to check packages as well? We already have basic format requirements for packages already so maybe not but want your opinion

[Alystrasz]

@Alystrasz would this need a rework to check packages as well? We already have basic format requirements for packages already so maybe not but want your opinion

About packages, currently we only check if directory names match the AUTHOR-MOD-VERSION pattern, not checking if the mod manifest is at the right place; this has been added in e398b5c and 0d6b624.

I removed the "READY TO MERGE" label since the diff shows this is deleting functions such as NSGetModNames (probably some merge operation failed), I need to address that.

[Alystrasz]

Waiting for @uniboi to re-add the NSGetInvalidMods function with new syntax since they've done it in the first place :)