CC2 plugins pack detections

[toebeann]

There seem to be some users turning up to the discord with cc2 plugin packs not working correctly due to the way they were packaged.

It might be worth adding a few more acceptable packaging structures (eg. If cc2 folder is nested within QMods or BepInEx\plugin)

Possibly also if there is no CC2 folder, just WorkingFiles as long as it includes only .txt files.

Maybe investigate the way cc2 .txt files are structured so we can even detect loose .txt files, similar to how we detect bepinex plugins in loose .dlls, rather than relying so much on package structure?

[toebeann]

Have been giving this more thought over in #8 while considering compatibility between CC2 and Purple's CC3: https://github.com/toebeann/subnautica-support/issues/8#issuecomment-1949115380

Relevant notes:

• CC2 and Purple's CC3 use PrimeSonic's EasyMarkup syntax for plugin files, at this time the only parser for this is the one written by PrimeSonic in his repo here: https://github.com/PrimeSonic/PrimeSonicSubnauticaMods/tree/master/EasyMarkup As such there is no current JavaScript (let alone TypeScript) parser for these files, so if we want to detect them we will have to roll our own
• Simplest method to determine if a file is a CC2/3 EM file seems to be:

  1. Strip out everything in any line following a # symbol (making sure to check for a preceding escape character \ just in case)
  2. Strip out all horizontal whitespace (we don't care about values so it doesn't matter that we're messing up strings)
  3. Strip out empty lines
  4. If the file is a valid CC2/CC3 EasyMarkup file, the first line of the remaining text should begin with one of the following keys, followed by a colon (:) symbol:
     • AddedRecipes
     • AliasRecipes
     • CustomBioFuels
     • CustomFabricators
     • CustomFoods
     • CustomFragmentCounts
     • CustomSizes
     • CustomCraftingTabs
     • ModifiedRecipes
     • MovedRecipes Otherwise, it's definitely not a CC2/CC3 EM file. It still might be an EM file in general, just not for CC2/CC3.
  5. To determine whether a CC2/3 EM file is compatible with PrimeSonic's CC2 (as of CC3 v1.0.0.4):
     • if the primary key of the file is not CustomFoods, it is inherently compatible with CC2
     • otherwise, if one of the following keys are not found in the file, it should be compatible with CC2:
     • OxygenValue
     • HealthValue
     • HeatValue If any of these keys are found, it is only (fully) compatible with MrPurple6411's CC3.

• The HeatValue key of CustomFoods CC3 EM files is only legal in BZ
• At this time it is unclear whether CC2 or CC3 will gracefully ignore unrecognised keys and otherwise work, or if they will throw errors and instead ignore the entire file, or worse. Will likely need to run tests to confirm, and warn the user if we think they are installing a pack which contains files which could error.
• As time goes on, it is possible MrPurple6411 will add more features to CC3 which will could cause further incompatibilities with CC2 when using EM files intended for CC3. As such, it is probably best to advise users that they may wish to migrate to CC3, and that they can simply install and use CC2 plugin packs with CC3 instead.