StardewValley
/
SMAPI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

expand Content Patcher schema, detect more common issues (#654)

This commit is contained in:
Jesse Plamondon-Willard 2019-08-06 05:07:15 -04:00
parent 807868f440
commit 5679df8d66
No known key found for this signature in database
GPG Key ID: CF8B1456B3E29F49
1 changed files with 202 additions and 134 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

264
src/SMAPI.Web/wwwroot/schemas/content-patcher.json
View File

@ -9,9 +9,12 @@
"properties": { "properties": {
"Format": { "Format": {
"title": "Format version", "title": "Format version",
"description": "The format version. You should always use the latest version to use the latest features and avoid obsolete behavior.", "description": "The format version. You should always use the latest version to enable the latest features and avoid obsolete behavior.",
"type": "string", "type": "string",
"pattern": "\\d+\\.\\d+" "const": "1.9",
"@errorMessages": {
"const": "Incorrect value '@value'. This should be set to the latest format version, currently '1.9'."
}
}, },
"ConfigSchema": { "ConfigSchema": {
"title": "Config schema", "title": "Config schema",
@ -39,8 +42,12 @@
"title": "Default value", "title": "Default value",
"description": "The default values when the field is missing. Can contain multiple comma-delimited values if AllowMultiple is true. If omitted, blank fields are left blank.", "description": "The default values when the field is missing. Can contain multiple comma-delimited values if AllowMultiple is true. If omitted, blank fields are left blank.",
"type": "string" "type": "string"
}
}, },
"additionalProperties": false
},
"allOf": [
{
"if": { "if": {
"properties": { "properties": {
"AllowBlank": { "const": false } "AllowBlank": { "const": false }
@ -51,6 +58,12 @@
"required": [ "Default" ] "required": [ "Default" ]
} }
} }
],
"@errorMessages": {
"allOf": "If 'AllowBlank' is false, the 'Default' field is required."
}
}
}, },
"DynamicTokens": { "DynamicTokens": {
"title": "Dynamic tokens", "title": "Dynamic tokens",
@ -61,7 +74,7 @@
"properties": { "properties": {
"Name": { "Name": {
"title": "Name", "title": "Name",
"description": "The name of the token to use for tokens & condition.", "description": "The name of the token to use for tokens & conditions.",
"type": "string" "type": "string"
}, },
"Value": { "Value": {
@ -75,7 +88,9 @@
"$ref": "#/definitions/Condition" "$ref": "#/definitions/Condition"
} }
}, },
"required": [ "Name", "Value" ]
"required": [ "Name", "Value" ],
"additionalProperties": false
} }
}, },
"Changes": { "Changes": {
@ -93,11 +108,17 @@
"Target": { "Target": {
"title": "Target asset", "title": "Target asset",
"description": "The game asset you want to patch (or multiple comma-delimited assets). This is the file path inside your game's Content folder, without the file extension or language (like Animals/Dinosaur to edit Content/Animals/Dinosaur.xnb). This field supports tokens and capitalisation doesn't matter. Your changes are applied in all languages unless you specify a language condition.", "description": "The game asset you want to patch (or multiple comma-delimited assets). This is the file path inside your game's Content folder, without the file extension or language (like Animals/Dinosaur to edit Content/Animals/Dinosaur.xnb). This field supports tokens and capitalisation doesn't matter. Your changes are applied in all languages unless you specify a language condition.",
"type": "string" "type": "string",
"not": {
"pattern": "^ *[cC][oO][nN][tT][eE][nN][tT]/|\\.[xX][nN][bB] *$|\\.[a-zA-Z][a-zA-Z]-[a-zA-Z][a-zA-Z](?:.xnb)? *$"
},
"@errorMessages": {
"not": "Invalid target; it shouldn't include the 'Content/' folder, '.xnb' extension, or locale code."
}
}, },
"LogName": { "LogName": {
"title": "Patch log name", "title": "Patch log name",
"description": "A name for this patch shown in log messages. This is very useful for understanding errors; if not specified, will default to a name like entry #14 (EditImage Animals/Dinosaurs).", "description": "A name for this patch shown in log messages. This is very useful for understanding errors; if not specified, will default to a name like 'entry #14 (EditImage Animals/Dinosaurs)'.",
"type": "string" "type": "string"
}, },
"Enabled": { "Enabled": {
@ -112,41 +133,29 @@
"type": "string", "type": "string",
"pattern": "\\{\\{[^{}]+\\}\\}" "pattern": "\\{\\{[^{}]+\\}\\}"
} }
] ],
}, "@errorMessages": {
"When": { "anyOf": "Invalid value; must be true, false, or a single token which evaluates to true or false."
"title": "When",
"description": "Only apply the patch if the given conditions match.",
"$ref": "#/definitions/Condition"
} }
}, },
"required": [ "Action", "Target" ], "FromFile": {
"title": "Source file",
"description": "The relative file path in your content pack folder to load instead (like 'assets/dinosaur.png'). This can be a .json (data), .png (image), .tbin (map), or .xnb file. This field supports tokens and capitalisation doesn't matter.",
"type": "string",
"allOf": [ "allOf": [
{ {
"if": { "not": {
"properties": { "pattern": "\b\\.\\.[/\\]"
"Action": { "const": "Load" }
}
},
"then": {
"properties": {
"FromFile": {
"$ref": "#/definitions/FromFile"
}
},
"required": [ "FromFile" ]
} }
}, },
{ {
"if": { "pattern": "\\.(json|png|tbin|xnb) *$"
"properties": { }
"Action": { "const": "EditImage" } ],
"@errorMessages": {
"allOf:indexes: 0": "Invalid value; must not contain directory climbing (like '../').",
"allOf:indexes: 1": "Invalid value; must be a file path ending with .json, .png, .tbin, or .xnb."
} }
},
"then": {
"properties": {
"FromFile": {
"$ref": "#/definitions/FromFile"
}, },
"FromArea": { "FromArea": {
"title": "Source area", "title": "Source area",
@ -162,20 +171,9 @@
"title": "Patch mode", "title": "Patch mode",
"description": "How to apply FromArea to ToArea. Defaults to Replace.", "description": "How to apply FromArea to ToArea. Defaults to Replace.",
"type": "string", "type": "string",
"enum": [ "Replace", "Overlay" ] "enum": [ "Replace", "Overlay" ],
} "default": "Replace"
}, },
"required": [ "FromFile" ]
}
},
{
"if": {
"properties": {
"Action": { "const": "EditData" }
}
},
"then": {
"properties": {
"Fields": { "Fields": {
"title": "Fields", "title": "Fields",
"description": "The individual fields you want to change for existing entries. This field supports tokens in field keys and values. The key for each field is the field index (starting at zero) for a slash-delimited string, or the field name for an object.", "description": "The individual fields you want to change for existing entries. This field supports tokens in field keys and values. The key for each field is the field index (starting at zero) for a slash-delimited string, or the field name for an object.",
@ -186,7 +184,11 @@
}, },
"Entries": { "Entries": {
"title": "Entries", "title": "Entries",
"description": "The entries in the data file you want to add, replace, or delete. If you only want to change a few fields, use Fields instead for best compatibility with other mods. To add an entry, just specify a key that doesn't exist; to delete an entry, set the value to null (like \"some key\": null). This field supports tokens in entry keys and values.\nCaution: some XNB files have extra fields at the end for translations; when adding or replacing an entry for all locales, make sure you include the extra fields to avoid errors for non-English players." "description": "The entries in the data file you want to add, replace, or delete. If you only want to change a few fields, use Fields instead for best compatibility with other mods. To add an entry, just specify a key that doesn't exist; to delete an entry, set the value to null (like \"some key\": null). This field supports tokens in entry keys and values.\nCaution: some XNB files have extra fields at the end for translations; when adding or replacing an entry for all locales, make sure you include the extra fields to avoid errors for non-English players.",
"type": "object",
"additionalProperties": {
"type": "object"
}
}, },
"MoveEntries": { "MoveEntries": {
"type": "array", "type": "array",
@ -197,49 +199,114 @@
"title": "ID", "title": "ID",
"description": "The ID of the entry to move", "description": "The ID of the entry to move",
"type": "string" "type": "string"
}
}, },
"anyOf": [
{
"properties": {
"ID": {},
"BeforeID": { "BeforeID": {
"title": "Before ID", "title": "Before ID",
"description": "Move entry so it's right before this ID", "description": "Move entry so it's right before this ID",
"type": "string" "type": "string"
}
}, },
"required": [ "ID", "BeforeID" ],
"additionalProperties": false
},
{
"properties": {
"ID": {},
"AfterID": { "AfterID": {
"title": "After ID", "title": "After ID",
"description": "Move entry so it's right after this ID", "description": "Move entry so it's right after this ID",
"type": "string" "type": "string"
}
}, },
"required": [ "ID", "AfterID" ],
"additionalProperties": false
},
{
"properties": {
"ID": {},
"ToPosition": { "ToPosition": {
"title": "To position", "title": "To position",
"description": "Move entry so it's right at this position", "description": "Move entry so it's right at this position",
"enum": [ "Top", "Bottom" ] "enum": [ "Top", "Bottom" ]
} }
}, },
"required": [ "ID", "ToPosition" ],
"additionalProperties": false "anyOf": [
{
"required": [ "BeforeID" ]
},
{
"required": [ "AfterID" ]
},
{
"required": [ "ToPosition" ]
} }
], ],
"required": [ "ID" ]
"dependencies": {
"BeforeID": {
"propertyNames": {
"enum": [ "ID", "BeforeID" ]
}
},
"AfterID": {
"propertyNames": {
"enum": [ "ID", "AfterID" ]
}
},
"ToPosition": {
"propertyNames": {
"enum": [ "ID", "ToPosition" ]
} }
} }
},
"required": [ "ID" ],
"@errorMessages": {
"anyOf": "You must specify one of 'AfterID', 'BeforeID', or 'ToPosition'.",
"dependencies:BeforeID": "If 'BeforeID' is specified, only 'ID' and 'BeforeID' fields are valid.",
"dependencies:AfterID": "If 'AfterID' is specified, only 'ID' and 'AfterID' fields are valid.",
"dependencies:ToPosition": "If 'ToPosition' is specified, only 'ID' and 'ToPosition' fields are valid."
}
}
},
"When": {
"title": "When",
"description": "Only apply the patch if the given conditions match.",
"$ref": "#/definitions/Condition"
}
},
"allOf": [
{
"if": {
"properties": {
"Action": { "const": "Load" }
}
},
"then": {
"required": [ "FromFile" ],
"propertyNames": {
"enum": [ "Action", "Target", "LogName", "Enabled", "When", "FromFile" ]
},
"@errorMessages": {
"then": "$transparent"
}
}
},
{
"if": {
"properties": {
"Action": { "const": "EditImage" }
}
},
"then": {
"required": [ "FromFile" ],
"propertyNames": {
"enum": [ "Action", "Target", "LogName", "Enabled", "When", "FromFile", "FromArea", "ToArea", "PatchMode" ]
},
"@errorMessages": {
"then": "$transparent"
}
}
},
{
"if": {
"properties": {
"Action": { "const": "EditData" }
}
},
"then": {
"propertyNames": {
"enum": [ "Action", "Target", "LogName", "Enabled", "When", "Fields", "Entries", "MoveEntries" ]
},
"@errorMessages": {
"then": "$transparent"
} }
} }
}, },
@ -252,31 +319,34 @@
"then": { "then": {
"properties": { "properties": {
"FromFile": { "FromFile": {
"description": "The relative path to the map in your content pack folder from which to copy (like assets/town.tbin). This can be a .tbin or .xnb file. This field supports tokens and capitalisation doesn't matter.\nContent Patcher will handle tilesheets referenced by the FromFile map for you if it's a .tbin file:\n - If a tilesheet isn't referenced by the target map, Content Patcher will add it for you (with a z_ ID prefix to avoid conflicts with hardcoded game logic). If the source map has a custom version of a tilesheet that's already referenced, it'll be added as a separate tilesheet only used by your tiles.\n - If you include the tilesheet file in your mod folder, Content Patcher will use that one automatically; otherwise it will be loaded from the game's Content/Maps folder.", "description": "The relative path to the map in your content pack folder from which to copy (like assets/town.tbin). This can be a .tbin or .xnb file. This field supports tokens and capitalisation doesn't matter.\nContent Patcher will handle tilesheets referenced by the FromFile map for you if it's a .tbin file:\n - If a tilesheet isn't referenced by the target map, Content Patcher will add it for you (with a z_ ID prefix to avoid conflicts with hardcoded game logic). If the source map has a custom version of a tilesheet that's already referenced, it'll be added as a separate tilesheet only used by your tiles.\n - If you include the tilesheet file in your mod folder, Content Patcher will use that one automatically; otherwise it will be loaded from the game's Content/Maps folder."
"$ref": "#/definitions/FromFile"
}, },
"FromArea": { "FromArea": {
"title": "Source area", "description": "The part of the source map to copy. Defaults to the whole source map."
"description": "The part of the source map to copy. Defaults to the whole source map.",
"$ref": "#/definitions/Rectangle"
}, },
"ToArea": { "ToArea": {
"title": "Target area", "description": "The part of the target map to replace."
"description": "The part of the target map to replace.",
"$ref": "#/definitions/Rectangle"
} }
}, },
"propertyNames": {
"enum": [ "Action", "Target", "LogName", "Enabled", "When", "FromFile", "FromArea", "ToArea" ]
},
"required": [ "FromFile", "ToArea" ] "required": [ "FromFile", "ToArea" ]
} }
} }
] ],
"required": [ "Action", "Target" ],
"@errorMessages": {
"allOf": "$transparent"
}
} }
}, },
"$schema": { "$schema": {
"title": "Schema", "title": "Schema",
"description": "The schema this JSON should follow. Useful for JSON validation tools.", "description": "A reference to this JSON schema. Not part of the actual format, but useful for validation tools.",
"type": "string", "type": "string",
"format": "uri" "const": "https://smapi.io/schemas/content-patcher.json"
} }
}, },
"definitions": { "definitions": {
@ -286,42 +356,40 @@
"type": "string" "type": "string"
} }
}, },
"FromFile": {
"title": "Source file",
"description": "The relative file path in your content pack folder to load instead (like assets/dinosaur.png). This can be a .json (data), .png (image), .tbin (map), or .xnb file. This field supports tokens and capitalisation doesn't matter.",
"type": "string",
"pattern": ".*\\.(json|png|tbin|xnb)$|.*\\{\\{[^}]+}}$"
},
"Rectangle": { "Rectangle": {
"type": "object", "type": "object",
"properties": { "properties": {
"X": { "X": {
"title": "X-Coordinate", "title": "X-Coordinate",
"description": "Location in pixels of the top-left of the rectangle", "description": "Location in pixels of the top-left of the rectangle",
"type": "number", "type": "integer",
"multipleOf": 1 "minimum:": 0
}, },
"Y": { "Y": {
"title": "Y-Coordinate", "title": "Y-Coordinate",
"description": "Location in pixels of the top-left of the rectangle", "description": "Location in pixels of the top-left of the rectangle",
"type": "number", "type": "integer",
"multipleOf": 1 "minimum:": 0
}, },
"Width": { "Width": {
"title": "Width", "title": "Width",
"description": "The width of the rectangle", "description": "The width of the rectangle",
"type": "number", "type": "integer",
"multipleOf": 1 "minimum:": 0
}, },
"Height": { "Height": {
"title": "Height", "title": "Height",
"description": "The height of the rectangle", "description": "The height of the rectangle",
"type": "number", "type": "integer",
"multipleOf": 1 "minimum:": 0
}
}
} }
}, },
"required": [ "Format", "Changes" ] "required": [ "X", "Y", "Width", "Height" ],
"additionalProperties": false
}
},
"required": [ "Format", "Changes" ],
"additionalProperties": false
} }