Manifest Schema

Type: object

No Additional Properties

Root $schema
Type: string

The JSON schema for this manifest

Root filename
Type: string

The name of the dll file to load

Root patcher
Type: string

The path to the patcher to use

Root author
Type: string

The author of the mod

Examples:

"John Doe"
"Bwc9876"
"xen-42"

Root name
Type: string

The human-readable name of the mod

Examples:

"Example Mod"
"My Cool Mod"

Root uniqueName
Type: string

The unique name of the mod

Examples:

"Bwc9876.TimeSaver"
"Me.MyMod"
"Me.MyCoolMod"

Root version
Type: string

The version of the mod (should follow semver)

Must match regular expression: ^\d+\.\d+\.\d+$

Examples:

"1.0.0"
"2.0.1"
"0.1.4"

Root owmlVersion
Type: string

The version of the OWML that this mod was created with

Must match regular expression: ^\d+\.\d+\.\d+$

Examples:

"1.0.0"
"2.0.1"
"0.1.4"

Root dependencies
Type: array of string

The dependencies of the mod

All items must be unique

Each item of this array must be:

Root dependenciesdependencies items
Type: string

The uniqueName of the dependency

Examples:

"Bwc9876.TimeSaver"
"Me.MyMod"
"Me.MyCoolMod"

Root priorityLoad
Type: boolean
Default: false

Whether or not to load the mod before other mods

Root minGameVersion
Type: string

The minimum version of the game that this mod is compatible with

Must match regular expression: ^\d+\.\d+\.\d+\.\d+$

Examples:

"1.0.0"
"2.0.1"
"0.1.4"

Root maxGameVersion
Type: string

The maximum version of the game that this mod is compatible with

Must match regular expression: ^\d+\.\d+\.\d+\.\d+$

Examples:

"1.0.0"
"2.0.1"
"0.1.4"

Root requireLatestVersion
Type: boolean
Default: false

Whether this mod needs the very latest game version

Root incompatibleVendors
Type: array of enum (of string)

The vendors this mod does not work on

Each item of this array must be:

Root incompatibleVendorsincompatibleVendors items
Type: enum (of string)

Must be one of:

  • "Steam"
  • "Epic"
  • "Gamepass"

Root pathsToPreserve
Type: array of string

The paths to preserve when updating the mod
Automatically includes config.json, manifest.json, and save.json

All items must be unique

Each item of this array must be:

Root pathsToPreservepathsToPreserve items
Type: string

The path to preserve

Examples:

"MyMod/MyMod.dll"
"MyMod/MyMod.xml"
"MyMod/MyMod.json"

Root conflicts
Type: array of string

The mods that this mod conflicts with

All items must be unique

Each item of this array must be:

Root conflictsconflicts items
Type: string

The uniqueName of the conflicting mod

Examples:

"Bwc9876.TimeSaver"
"Me.MyMod"
"Me.MyCoolMod"

Root warning
Type: string

The warning to display when starting the mod for the first time