Skip to content

Instantly share code, notes, and snippets.

@pot-code
Last active August 1, 2024 07:19
Show Gist options
  • Save pot-code/1ce967bcfb81568b688997d4121812a8 to your computer and use it in GitHub Desktop.
Save pot-code/1ce967bcfb81568b688997d4121812a8 to your computer and use it in GitHub Desktop.
xmod json schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "xmod json schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "mod id. must be unique across all mods",
"default": ""
},
"project_name": {
"type": "string",
"description": "project name used for package"
},
"name": {
"type": "string",
"description": "mod display name in game",
"default": ""
},
"description": {
"type": "string",
"description": "mod description",
"default": "no description"
},
"date": {
"type": "string",
"description": "create date",
"default": ""
},
"version": {
"type": "integer",
"description": "mod version",
"default": 1
},
"author": {
"type": "string",
"description": "mod author",
"default": ""
},
"save": {
"type": "boolean",
"description": "",
"default": false
},
"sync": {
"type": "boolean",
"description": "",
"default": false
},
"output": {
"type": "string",
"description": "output directory",
"default": "dist"
},
"translations": {
"type": "array",
"description": "mod description in different languages",
"items": {
"type": "object",
"properties": {
"language": {
"type": "integer",
"description": "language code"
},
"description": {
"type": "string",
"description": "mod description in this language"
}
},
"required": [
"language",
"description"
]
}
},
"dependencies": {
"type": "array",
"description": "mod dependencies",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "dependency mod id"
},
"optional": {
"type": "boolean",
"description": "is dependency optional"
},
"version": {
"type": "integer",
"description": "dependency version"
}
},
"required": [
"id",
"optional",
"version"
]
}
}
},
"required": [
"id",
"name",
"description",
"date",
"version",
"author",
"output"
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment