Legacy Manifest

Ah, the legacy manifest... The first of many, unbeknown to me.
So, as I said in the introduction, the legacy manifest was the first idea I had to solve mods getting more complex. Like any first idea it has a lot of flaws that I didn't see at the time, but it worked for the time being.
All this manifest does is grant the creator the ability to give their mod a user-friendly name, description, and icon. Alongside optionally specifying some basic variations of their mod.

Properties

• Guid
  • required
  • string
  • A unique identifier in form of a GUID. This value should be the same across mod versions. It's used by the manager to tell the mod apart from others. You can think of this value as the mods social media handle.
• Name
  • required
  • string
  • The user-friendly name of the mod.
• Description
  • required
  • string
  • The user-friendly description of the mod.
• IconPath
  • optional
  • string | null
  • The path to the mods icon, relative to the mods root.
• Options
  • optional
  • array | null
  • An array of string paths as options of the mod. Each item is both a root relative path and a name of the option. If null or not defined the root will be used to source the patch files.

Example

1
2
3
4
5
6
7
8
9
10
{
	"Guid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
	"Name": "Mod Name",
	"Description": "Lorem ipsum",
	"IconPath": "icon.png",
	"Options": [
		"Option 1",
		"Option 2"
	]
}