Files
vcmi/config/schemas/bonus.json
T
Ivan Savenko 8e71d54c63 Allow mods to provide save and map compatibilty
Now `compatibilityIdentifers` field is supported for all game entities.
As result it is now possible for mods to provide compatibility support
for loading mods and saves made with older version of the mod.

Also, added docs to specify what exactly breaks saves with mods updates
and ways to avoid that
2026-02-01 12:27:00 +02:00

83 lines
2.0 KiB
JSON

{
"type" : "object",
"$schema" : "http://json-schema.org/draft-04/schema",
"title" : "VCMI bonus type format",
"description" : "Definition of bonus types",
"required" : [],
"additionalProperties" : false,
"properties" : {
"compatibilityIdentifiers" : {
"type" : "array",
"items" : {
"type" : "string"
},
"description" : "Additional identifiers that may refer to this object, to provide compatibility after object has been renamed"
},
"hidden" : {
"type" : "boolean",
"description" : "If set to true, all instances of this bonus will be hidden in UI"
},
"creatureNature" : {
"type" : "boolean",
"description" : "If set to true, this bonus will be considered 'creature nature' bonus, and such creature won't be automatically granted LIVING bonus"
},
"blockDescriptionPropagation" : {
"type" : "boolean",
"description" : "If set to true, this ability description will not be displayed if a creature receives it by propagation"
},
"description" : {
"type" : "string"
},
"subtypeDescriptions" : {
"type" : "object",
"description" : "Custom description string for bonus subtype",
"additionalProperties" : {
"type" : "string"
}
},
"valueDescriptions" : {
"type" : "object",
"description" : "Custom description string for bonus value",
"additionalProperties" : {
"type" : "string"
}
},
"graphics" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"icon" : {
"type" : "string",
"description" : "Resourse path of generic icon for this bonus",
"format" : "imageFile"
},
"subtypeIcons" : {
"type" : "object",
"description" : "Resourse path of icon for this bonus subtype",
"additionalProperties" : {
"type" : "string",
"format" : "imageFile"
}
},
"valueIcons" : {
"type" : "object",
"description" : "Resourse path of icon for this bonus value",
"additionalProperties" : {
"type" : "string",
"format" : "imageFile"
}
}
}
}
}
}