Associated mods PR: R2Northstar/NorthstarMods#824

Problem

Whether through manual installation or through mod auto-downloading, several versions of the same mod can be installed in Northstar, which currently does not handle this:

This video was recorded using a profile with two Parkour mod versions, v0.1.2 and v0.2.1: note how the client does not distinguish between the two versions (version displayed in the UI is the same for both mods), and is not capable of (de)activating any of them.

Description

New enabledmods.json format

Since the current enabledmods.json format does not allow for multiple mod versions, it has been reworked.
With this PR, if "old" file format is detected, enabledmods.json will automatically be converted to "new" format.

Old format

{
    "Northstar.Client": true,
    "Northstar.Coop": true,
    "Northstar.CustomServers": true,
    "Northstar.Custom": true,
    "MRVN Shake It": true,
    "Titan Payload": false,
    "Parkour": true
}

New format

{
    "Northstar.Client": {
        "1.19.0": true
    },
    "Northstar.Coop": {
        "0.0.0": true
    },
    "Northstar.CustomServers": {
        "1.19.0": true
    },
    "Northstar.Custom": {
        "1.19.0": false
    },
    "Parkour": {
        "0.1.2": false,
        "0.2.1": true
    },
    "MRVN Shake It": {
        "0.0.1": true
    },
    "Titan Payload": {
        "1.2.0": false
    }
}

(new enabledmods.json format also means mod managers will have to adapt)

Squirrel-exposed functions

• Functions were reworked to take mod version into account:
  • NSIsModEnabled(string modName) is now NSIsModEnabled(string modName, string modVersion);
  • NSSetModEnabled(string modName, bool enabled) is now NSSetModEnabled(string modName, string modVersion, bool enabled);
  • NSIsModRemote(string modName) is now NSIsModRemote(string modName, string modVersion);
  • NSGetModVersionByModName(string modName) is now NSGetModVersions(string modName);
• A lot of functions loop over the list of local mods to retrieve some mod attribute (mod description, download link etc); these functions are called one after the other in the VM, therefore making useless loops over the list of mods:
  • To fix that, we add a NSGetModsInformation method, that returns a list of mods with all associated information at once (and not only names like NSGetModNames currently does it);
  • As the information they provided is now accessible through NSGetModsInformation, the following functions were removed: NSGetModDescriptionByModName, NSGetModDownloadLinkByModName, NSGetModLoadPriority, NSIsModRequiredOnClient, NSGetModConvarsByModName

Result

This video was recorded using a profile with two Parkour mod versions, v0.1.2 and v0.2.1: the client now differentiate the two versions (they both appear correctly on the UI), and is capable (de)activating any of them.

Closes #670.
Closes #757.

Testing (manifesto format)

As this PR modifies your enabledmods.json file, you might want to copy it somewhere safe before testing.

Test scenarios

• Old format refers to the following configuration format: mod name => boolean value
• New format refers to the following configuration format: mod name => version string => boolean value

Launch game:

with no enabledmods.json file at all

• enabledmods.json should be created using new format

with an invalid enabledmods.json file (not following JSON format)

• invalid enabledmods.json should be renamed into enabledmods.json.old
• enabledmods.json should be created using new format

with enabledmods.json using old format

• enabledmods.json file should be renamed into enabledmods.json.old
• enabledmods.json should be recreated using new format

with enabledmods.json using new format

• game should start and load mods according to enabledmods.json configuration (you can check that in the Mods menu)

TODOs

• If old manifesto format is detected, rename file and recreate file using new format
  • Mutualise file creation code with UnloadMods method
  • Check whether I can remove GenerateModsConfigurationFile method (since mod entries are already created ~L667)
  • Rename original file if it exists
  • Convert old format to new format
• Use new manifesto format to load mods config into the client
• Remove all code related to old format
• Remove new script package and update old functions instead (e.g. NSSetModEnabled(name,bool to NSSetModEnabled(name,ver,bool)
  • Mirror changes in mods