Skip to main content
Version: 0.2.1

Mod manifests

The official WukongMP SDK mod template contains a file named manifest.json. This file is required by the mod loader to recognize the folder containing your mod DLL as a WukongMP mod, and contains information required for resolving mod dependencies.

An example manifest.json file looks like this:

manifest.json
{
"uniqueId": "WukongMP.Coop",
"version": "0.2.0",
"name": "WukongMP Co-op mode",
"author": "ReadyM Team",
"description": "The official WukongMP Co-op mode.",
"dependencies": [
{
"uniqueId": "WukongMP.SDK",
"minimumVersion": "0.2.0"
}
]
}

Refer to the table below for the description of each field in the manifest file.

FieldTypeOptionalDescription
uniqueIdstringnoUnique identifier of your mod. Can contain only alphanumeric characters, . or _
versionstringnoMod version, in MAJOR.MINOR.PATCH format.
namestringnoMod name, as it will be displayed in the server admin portal and in the Launcher.
authorstringnoMod author, as it will be displayed in the server admin portal and in the Launcher.
descriptionstringyesA short description of the mod.
dependenciesarray of objectsyesA list of other mods that are required for your mod to work. Each dependency must specify the uniqueId of the required mod, and a minimumVersion.