The Mod Manifest

Manifests are your only way of telling Centrifuge that your mod exists. Below you will learn everything about what a manifest consists of and how to use it to your advantage.

Mandatory Manifest Parameters

▐ FriendlyName : string
This parameter allows you to provide a human-readable, short name for your mod. It's useful for mod management utilities and other tools that may interface with the manifests.

▐ ModuleFileName : string
Your mod's DLL file name. Usually the same as project name + .dll at the end. This is what actually tells Centrifuge where your mod's code is located.

Optional Manifest Parameters

Values in <> denote the defaults when properties are not provided.

▐ Author : string <string.Empty>
Specifies the author, the creator of the mod. That means you, duh.

▐ Contact : string <string.Empty>
Allows you to provide your Discord contact info, or an e-mail address, for example. Anything that one can use to contact you regarding your mod.

▐ Dependencies : array{string} <[]>
Enables you to provide file paths (or file names) of any DLL dependencies that will be loaded just before your mod. The dependency file paths (or file names) provided must be relative to the private Dependencies/ directory of your mod.

▐ Priority : int <10>
Allows you to specify the position of your mod in the load order. Higher value means your mod will be loaded earlier. Useful when your mod is a dependency of another mod. Or when something's going to shit.

▐ SkipLoad : bool <false>
If set to true, the mod will not be loaded.

Example mod.json file

{
  "FriendlyName": "ExampleMod",
  "Author": "You",
  "Contact": "0451",
  "ModuleFileName": "ExampleMod.dll",
  "Dependencies": [],
  "SkipLoad": false,
  "Priority": 10
}