V1 Manifest

Now we're in the present.
The V1 manifest is the current standard and addresses all the issues I had with legacy as well as expand a bit more due to growing mod complexity.

Properties

• Version
  • required
  • number
  • Version specifier of the manifest (NOT THE MOD). Should always be 1 when targeting V1. This property is required to tell legacy, V1, and future manifests apart.
• 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 Option objects. If null or not defined the root will be used to source the patch files.
• NexusData
  • optional
  • object | null
  • Optional Nexus Data object.

Option

• Name
  • required
  • string
  • The user-friendly name of the option.
• Description
  • required
  • string
  • The user-friendly description of the option.
• Include
  • optional
  • array | null
  • Additional root relative include paths for the option. Must be st if SubOptions is null or undefined!
• Image
  • optional
  • string | null
  • The root relative path to an icon for the option.
• SubOptions
  • optional
  • array | null
  • Optional Sub-Options for the current option. Must be set if Include is null or undefined!

Sub-Option

• Name
  • required
  • string
  • The user-friendly name of the sub-option.
• Description
  • required
  • string
  • The user-friendly description of the sub-option.
• Include
  • optional
  • array | null
  • Additional root relative include paths for the option.
• Image
  • optional
  • string | null
  • The root relative path to an icon for the option.

Nexus Data

• ModId
  • required
  • number
  • The ID assigned to the mod by Nexus Mods
• Version
  • required
  • string
  • The version of the mod.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
	"Version": 1,
	"Guid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
	"Name": "Mod Name",
	"Description": "",
	"IconPath": "icon.png",
	"Options": [
		{
			"Name": "Option Name",
			"Description": "",
			"Include": [
				"Base"
			],
			"Image": "img.png",
			"SubOptions": [
				{
					"Name": "Sub Option Name",
					"Description": "",
					"Include": [
						"Addition"
					],
					"Image": "img.png"
				}
			]
		}
	],
	"NexusData": {
		"ModId": 109,
		"Version": "1.0.0"
	}
}