Updated patches.json specification (markdown)

bicarus
2026-07-19 23:25:01 -07:00
parent 3ec9e48ca4
commit 9fc433a2b8
+18
@@ -17,6 +17,7 @@ The JSON file is an array of patch objects.
|`type`|String|See [Memory](#memory-patch-properties), [union](#union-patch-properties), and [Signature](#signature-patch-properties) patch properties.|
|`peIdentifier`\*|String|Identifier for main game module. See the [PE Identifier](#pe-identifier) section.|
|`preset`\*\*|Bool|Unused. Leave as `false` or omit.|
|`group`|String|Group ID, if this patch parents up to a group. Optional.|
\*Optional if the filename is `{peIdentifier}.json`.
@@ -79,6 +80,20 @@ For `"type": "number"`, the patch object has an object named `patch` with the fo
|`min`|Integer|Minimum allowed value for the patch(inclusive)|
|`max`|Integer|Maximum allowed value for the patch(inclusive)|
## Group Patch Object specification
For `"type": "group"`, these are not actually patches but placeholders for parenting up child patches.
|Property|Type|Description|
|:-|:-|:-|
|`type`|String|Must be "group"|
|`id`|String|Unique group ID.|
|`name`|String|Name of the group.|
|`description`|String|group description which appears in the tooltip. Required, but can be blank.|
|`caution` \*\*|String|Warning about the group which appears in a highlighted tooltip.|
|`gameCode`|String|Gamecode. For instance; `ABC` in `ABC-001-2024042700`.|
## Header / metadata
Starting with version `24-07-03` -
@@ -104,6 +119,9 @@ URL `https://spice2x.github.io/patches/` is available with:
* `M32:J:B:A:2022102400` - see https://spice2x.github.io/patches/M32-634910da_15daec.json
* `LDJ:J:A:A:2023090500` - see https://spice2x.github.io/patches/LDJ-64ef0ff5_1037754.json
Here is a file with groups:
* `LDJ:J:A:A:2025082500` - see https://spice2x.github.io/patches/LDJ-68a2bd1c_b1c7bc.json
These patches are shared as a reference for patch developers only. spice2x team will not be maintaining patches.
## Troubleshooting issues when developing patches