Files
minecraft-bedrock-json-schemas/general/manifest.json

1 line
12 KiB
JSON
Raw Normal View History

2021-03-21 12:22:44 +00:00
{"$schema":"http://json-schema.org/draft-07/schema","$id":"blockception.minecraft.manifest","type":"object","title":"The minecraft manifest schema","description":"The minecraft manifest schema","required":["format_version","header"],"examples":[{"format_version":2,"header":{"description":"pack.description","name":"pack.name","uuid":"UUID2","min_engine_version":[1,16,0],"version":[1,0,0]},"modules":[{"type":"data","uuid":"UUID2","version":[1,0,0]}]}],"allOf":[{"if":{"properties":{"format_version":{"const":1,"type":"number","title":"Format Version"}}},"then":{"$ref":"#/definitions/A"}},{"if":{"properties":{"format_version":{"const":2,"type":"number","title":"Format Version"}}},"then":{"$ref":"#/definitions/D"}}],"definitions":{"A_uuidv4":{"$ref":"#/definitions/B"},"A_version":{"$ref":"#/definitions/C"},"B":{"type":"string","title":"A UUID V4","description":"A valid uuid v4","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","format":"uuid"},"C":{"type":"array","title":"Version numbering","description":"A version made of 3 numbers","minItems":3,"maxItems":3,"items":[{"type":"number","minimum":1},{"type":"number","minimum":0},{"type":"number","minimum":0}]},"A":{"type":"object","title":"The minecraft manifest v1 schema","description":"The manifest file contains all the basic information about the pack that Minecraft needs to identify it. The tables below contain all the components of the manifest, their individual properties, and what they mean.","additionalProperties":false,"required":["format_version","header"],"properties":{"format_version":{"type":"number","description":"This defines the current version of the manifest. Don't change this unless you have a good reason to","title":"Format Version"},"header":{"required":["description","name","uuid","version"],"properties":{"name":{"type":"string","default":0,"description":"This is the name of the pack as it appears within Minecraft","title":"Name"},"description":{"type":"string","default":0,"description":"This is a short description of the pack. It will appear in the game below the name of the pack. We recommend keeping it to 1-2 lines.","title":"Description"},"uuid":{"type":"string","$ref":"#/definitions/A_uuidv4","description":"This is a special type of identifier that uniquely identifies this pack from any other pack. UUIDs are written in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx where each x is a hexadecimal value (0-9 or a-f). We recommend using an online service to generate this and guarantee their uniqueness (just bing UUID Generator to find some)","title":"Uuid"},"version":{"$ref":"#/definitions/A_version","description":"This is the version of your pack in the format [majorVersion, minorVersion, revision].","title":"Version"},"min_engine_version":{"type":"string","$ref":"#/definitions/A_version","description":"This is the minimum version of the game that this pack was written for. This helps the game identify whether any backwards compatibility is needed for your pack. You should always use the highest version currently available when creating packs","title":"Min Engine Version"},"lock_template_options":{"type":"boolean","description":"TODO description: lock template options","title":"Lock Template Options"},"base_game_version":{"$ref":"#/definitions/A_version","description":"TODO description: base game version","title":"Base Game Version"}},"description":"TODO description: header","title":"Header"},"modules":{"type":"array","title":"Modules","items":{"additionalProperties":false,"type":"object","required":["type","uuid","version"],"properties":{"type":{"description":"This is the type of the module. Can be any of the following: resources, data, client_data, interface, world_template","type":"string","enum":["resources","data","client_data","interface","world_template"],"title":"Type"},"description":{"type":"string","description":"This is a short description of the module. This is not user-facing at the moment but is a good place to remind yourself why the module is defined","title":"Description"},"uuid":{"$ref":"#/definitions