summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAdmiral H. Curtiss <pikachu025@gmail.com>2021-12-08 23:49:30 +0100
committerAdmiral H. Curtiss <pikachu025@gmail.com>2021-12-12 21:26:09 +0100
commitaa0595589aa10d5c6958b61814628d8c12f3f087 (patch)
tree91dce54b616acf80b58d7d13d4ff89c72e87e554 /docs
parentb50861ea44e237e69b1c931b4ceb8c9b6dc8db4e (diff)
docs: Add JSON Schema for game mod descriptors.
Diffstat (limited to 'docs')
-rw-r--r--docs/game-mod-descriptor.json66
1 files changed, 66 insertions, 0 deletions
diff --git a/docs/game-mod-descriptor.json b/docs/game-mod-descriptor.json
new file mode 100644
index 0000000000..a78486f6c1
--- /dev/null
+++ b/docs/game-mod-descriptor.json
@@ -0,0 +1,66 @@
+{
+ "$schema": "https://raw.githubusercontent.com/dolphin-emu/dolphin/master/docs/game-mod-descriptor.json",
+ "title": "Dolphin Game Mod Descriptor",
+ "type": "object",
+ "required": ["type", "version", "base-file"],
+ "properties": {
+ "type": {
+ "type": "string",
+ "pattern": "^dolphin-game-mod-descriptor$"
+ },
+ "version": {
+ "type": "integer"
+ },
+ "base-file": {
+ "type": "string"
+ },
+ "display-name": {
+ "type": "string"
+ },
+ "banner": {
+ "type": "string"
+ },
+ "riivolution": {
+ "type": "object",
+ "required": ["patches"],
+ "properties": {
+ "patches": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": ["xml", "root", "options"],
+ "properties": {
+ "xml": {
+ "type": "string"
+ },
+ "root": {
+ "type": "string"
+ },
+ "options": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "required": ["choice"],
+ "properties": {
+ "section-name": {
+ "type": "string"
+ },
+ "option-id": {
+ "type": "string"
+ },
+ "option-name": {
+ "type": "string"
+ },
+ "choice": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}