Manifest Schema
This page documents the fields allowed to be used in manifest.json.
To use the schema and get error-checking and documentation in your editor, add $schema at the top of your manifest.
Here is the raw link to the manifest schema for copying:
Properties
Section titled “Properties”$schema
Section titled “$schema”The JSON schema for this manifest (see Usage)
filename Required
Section titled “filename ”The name of the dll file to load
author Required
Section titled “author ”The author of the mod
name Required
Section titled “name ”The human-readable name of the mod
uniqueName Required
Section titled “uniqueName ”The unique name of the mod. No two mods should ever have the same uniqueName.
version Required
Section titled “version ”The version of the mod (should follow semver)
owmlVersion Required
Section titled “owmlVersion ”The version of the OWML that this mod was created with
patcher
Section titled “patcher”Optional path to a pre-patcher to use
dependencies
Section titled “dependencies”The dependencies of the mod. Should be a list of other mods’ unique names.
priorityLoad
Section titled “priorityLoad”Whether to load the mod before other mods
minGameVersion
Section titled “minGameVersion”The minimum version of the game that this mod is compatible with
maxGameVersion
Section titled “maxGameVersion”The maximum version of the game that this mod is compatible with
requireLatestVersion
Section titled “requireLatestVersion”Whether this mod needs the very latest game version
incompatibleVendors
Section titled “incompatibleVendors”The vendors this mod does not work on
Has to be Steam, Epic, or Gamepass
pathsToPreserve
Section titled “pathsToPreserve”The paths to preserve when updating the mod
Automatically includes config.json, manifest.json, and save.json
conflicts
Section titled “conflicts”The mods that this mod conflicts with
Should be a list of other mods’ unique names
warning
Section titled “warning”A warning to display when starting the mod for the first time
donateLinks
Section titled “donateLinks”Specify links to be displayed in the mod manager for the mod, currently PayPal, Patreon, Buymeacoffee, CashApp, and Kofi are available
donateLink
Section titled “donateLink”DEPRECATED: Use donateLinks