Skip to content

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.

{
  "$schema": "https://raw.githubusercontent.com/ow-mods/owml/refs/heads/master/schemas/manifest_schema.json",
  "filename": "MyMod.dll",
  "author": "Me",
  "name": "My Mod",
  "uniqueName": "Bwc9876.MyMod",
  "version": "0.0.1",
  "owmlVersion": "2.9.0"
}

Here is the raw link to the manifest schema for copying:

https://raw.githubusercontent.com/ow-mods/owml/refs/heads/master/schemas/manifest_schema.json

The JSON schema for this manifest (see Usage)

The name of the dll file to load

The author of the mod

The human-readable name of the mod

The unique name of the mod. No two mods should ever have the same uniqueName.

The version of the mod (should follow semver)

The version of the OWML that this mod was created with

Optional path to a pre-patcher to use

The dependencies of the mod. Should be a list of other mods’ unique names.

Whether to load the mod before other mods

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

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

Whether this mod needs the very latest game version

The vendors this mod does not work on

Has to be Steam, Epic, or Gamepass

The paths to preserve when updating the mod

Automatically includes config.json, manifest.json, and save.json

The mods that this mod conflicts with

Should be a list of other mods’ unique names

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

Specify links to be displayed in the mod manager for the mod, currently PayPal, Patreon, Buymeacoffee, CashApp, and Kofi are available

DEPRECATED: Use donateLinks