Modinfo Specification¶

A modinfo.json file is required in the top-level folder of your mod.

Anno 117 mods and Anno 1800 mod.io mods won't load without a modinfo file.

Auto-completion and Template in Visual Studio Code

Use Anno Modding Tools to get template, auto-completion and tooltips for modinfo.json files.

Ensure anno.workspaceSchemas is enabled for auto-completion and tooltips.

Press F1 and run Anno: Create Mod from Template to generate a template.

Mandatory Fields¶

117 & 1800

Mandatory fields are used by the modloader to correctly identify mods. Missing or wrong entries result in errors in the mod-loader.log.

Anno 117 won't load mods without the correct game version.

modinfo.json

{
  "Anno": 8,
  "Version": "1.0.0",
  "ModID": "first-mod-jakob"
  // ..
}

Field	Description
`Anno`	`8` for Anno 117. `7` for Anno 1800 (optional but recommended for better tool support).
`Version`	Version with three numbers: `MAJOR.Minor.patch`. `MAJOR`: increase when a new game is recommended. Use `0` if you don't guarantee not breaking save games. `Minor`: increase for feature additions. `patch`: bugfixes only.
`ModID`	Unique identifier of the mod. Use dashes and append the creator, e.g. `modname-creatorname`. 1800 only: the folder name is used if a mod has no `ModID` or `modinfo.json`.

Game Setup¶

117

modinfo.json

{
  // ..
  "Difficulty": "harder",
  "GameSetup": {
    "RequiresNewGame": false,
    "SafeToRemove": false,
    "Multiplayer": true,
    "Campaign": true
  }
}

Name	Value	Effect
`Difficulty`¹	`cheat`	e.g. no construction costs Mandatory for Anno 117
.	`easier`	makes the game easier, e.g. reduced needs consumption
.	`unchanged`	is balanced similar as the vanilla game, e.g. new productions or quality of life features like free farmfield placement
.	`harder`	makes the game harder
`RequiresNewGame`	`true` or `false`	only works with a new savegame, for example like river slots. Default is `false`.
`SafeToRemove`	`true` or `false`	can be removed from a savegame without leaving trails. For example construction menu reordering. Default is `false`.
`Multiplayer`	`true` or `false`	can be used in multiplayer games. Default is `true`.
`Campaign`	`true` or `false`	can be used in campaign games. Default is `true`.

Dependencies¶

117 & 1800

117 1800

{
  // ..
  "Dependencies": {
    "Require": [],
    "Optional": [],
    "LoadAfter": [],
    "Deprecate": [],
    "Incompatible": []
  }
}

Name	Description
`Require`	List mods and DLCs that are required to use this mod. Missing dependencies result in log warning.
`Optional`	List mods and DLCs that enable further content in this mod.
`LoadAfter`	List mods to load before this mod.
`Deprecate`	List mods that are replaced by this mod. A warning will be printed in the mod-loader.log. LoadAfter and Require will use the new ID.
`Incompatible`	List incompatible mods. Active incompatible mods result in log warning.

{
  // ..
  "ModDependencies": [],
  "OptionalDependencies": [],
  "LoadAfterIds": [],
  "DeprecateIds": [],
  "IncompatibleIds": []
}

Name	Description
`ModDependencies`	List mods that are required to use this mod. Missing dependencies result in log warning.
`OptionalDependencies`	List mods that enable further content in this mod.
`LoadAfterIds`	List mods to load before this mod.
`DeprecateIds`	List mods that are replaced by this mod.
`IncompatibleIds`	List incompatible mods. Active incompatible mods result in log warning.

Development Info¶

117 & 1800

Infos used by Visual Studio Code plugin Anno Modding Tools.

These don't depend on the game version, but tool version.

Current Deprecated

{
  // ..
  "Development": {
    "Dependencies": [],
    "DeployPath": "${annoMods}/${modName}",
    "Bundle": []
  }
}

Name	Description
`Dependencies`	List of mods that should be loaded for patch error analysis and GUID references.
`DeployPath`	Target path for mod deployment.
`Bundle`	List of mods that should be included as a sub mod.

{
  // ..
  "OptionalDependencies": [],
  "out": "${annoMods}/${modName}",
  "bundle": []
}

Name	Description
`OptionalDependencies`	List of mods that should be loaded for patch error analysis and GUID references.
`out`	Target path for mod deployment.
`bundle`	List of mods that should be included as a sub mod.

Learn more about deploying mods.

The Visual Studio Code modding tools can deploy your mods with automatic DDS generation, dependency downloads, etc.

Check the Build and Deploy documentation.

Localized Info¶

TBD

Additional Info¶

TBD

The mod loader prints an error if the entry is missing or wrong. ↩