From 251aeaebaa038fd935cbbcd5d5adbf4c5823f23d Mon Sep 17 00:00:00 2001 From: DaanV2 Date: Sun, 4 Apr 2021 14:14:02 +0200 Subject: [PATCH] Updated descrption/titles --- .vscode/settings.json | 9 +- source/resource/biomes_client.json | 16 +-- source/resource/blocks.json | 6 +- .../1.10.0/render_controllers.json | 92 ++++++++++------ .../1.8.0/render_controllers.json | 103 +++++++++++------- 5 files changed, 137 insertions(+), 89 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 883de170..4d4b9039 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,3 +1,10 @@ { - "json.schemas": [{ "fileMatch": ["source/**/*.json", "source/*.json"], "url": ".vscode/schema-validation.json" }] + "json.schemas": [{ "fileMatch": ["source/**/*.json", "source/*.json"], "url": ".vscode/schema-validation.json" }], + "editor.formatOnSave": true, + "[json]": { "editor.defaultFormatter": "esbenp.prettier-vscode" }, + "[jsonc]": { "editor.defaultFormatter": "esbenp.prettier-vscode" }, + + "prettier.printWidth": 150, + "prettier.useTabs": false, + "prettier.tabWidth": 2 } diff --git a/source/resource/biomes_client.json b/source/resource/biomes_client.json index a46dfc61..2db5c9f3 100644 --- a/source/resource/biomes_client.json +++ b/source/resource/biomes_client.json @@ -4,6 +4,7 @@ "type": "object", "title": "Biomes Client", "description": "The minecraft biomes definition file", + "additionalProperties": false, "definitions": { "biomespec": { "additionalProperties": false, @@ -16,17 +17,17 @@ "water_fog_color": { "$ref": "#/definitions/colorhex", "title": "Water Fog Color", "description": "The color of the water fog" }, "water_fog_distance": { "type": "integer", "title": "Water Fog Distance", "description": "The distance the water fog start at" }, "water_surface_color": { "$ref": "#/definitions/colorhex", "title": "Water Surface Color", "description": "The color of the water surface" }, - "water_surface_transparency": { "type": "number", "title": "Water Surface Transparency", "description": "TODO" } + "water_surface_transparency": { "type": "number", "title": "Water Surface Transparency", "description": "The amount of transpareny the surface of the water has" } } }, - "colorhex": { "description": "TODO description: colorhex", "title": "Colorhex", "format": "color-hex" } + "colorhex": { "description": "The colouration of this object", "title": "Colorhex", "format": "color-hex" } }, "properties": { - "biomes": { - "additionalProperties": false, - "description": "TODO description: biomes", - "title": "Biomes", + "biomes": { "type": "object", + "title": "Biomes", + "additionalProperties": false, + "description": "A collection of predefined biomes", "properties": { "bamboo_jungle": { "$ref": "#/definitions/biomespec" }, "bamboo_jungle_hills": { "$ref": "#/definitions/biomespec" }, @@ -99,6 +100,5 @@ "warped_forest": { "$ref": "#/definitions/biomespec" } } } - }, - "additionalProperties": false + } } diff --git a/source/resource/blocks.json b/source/resource/blocks.json index f9e98bc1..e86a1d2a 100644 --- a/source/resource/blocks.json +++ b/source/resource/blocks.json @@ -31,14 +31,14 @@ "additionalProperties": { "additionalProperties": false, "title": "Block", - "description": "TODO", + "description": "Block texture definition", "type": "object", "properties": { "brightness_gamma": { "type": "number", "title": "Brightness Gamma", "description": "TODO" }, "carried_textures": { "$ref": "#/definitions/texture", "title": "Carried Textures", "description": "TODO" }, "isotropic": { "title": "Isotropic", - "description": "TODO", + "description": "Marks if this block is isotropic or not, or which side are", "oneOf": [ { "type": "boolean" }, { @@ -56,7 +56,7 @@ } ] }, - "sound": { "type": "string", "title": "Sound", "description": "TODO" }, + "sound": { "type": "string", "title": "Sound", "description": "The sound definition of this block" }, "textures": { "$ref": "#/definitions/texture", "title": "Sound", "description": "Textures" } } } diff --git a/source/resource/render_controllers/1.10.0/render_controllers.json b/source/resource/render_controllers/1.10.0/render_controllers.json index 65d9f37a..16d45f15 100644 --- a/source/resource/render_controllers/1.10.0/render_controllers.json +++ b/source/resource/render_controllers/1.10.0/render_controllers.json @@ -22,7 +22,7 @@ "render_controllers": { "type": "object", "propertyNames": { "pattern": "^controller\\.render\\.[a-z\\.]+" }, - "additionalProperties": { + "additionalProperties": { "title": "Render Controller", "additionalProperties": false, "type": "object", @@ -30,48 +30,64 @@ "required": ["geometry", "materials"], "properties": { "arrays": { - "additionalProperties": false, "type": "object", + "title": "Arrays", + "additionalProperties": false, + "description": "A collection of definition of arrays", "properties": { "geometries": { "type": "object", "minProperties": 1, + "description": "A collection of Geometry array", + "title": "Geometries", "additionalProperties": { "type": "array", - "items": { "type": "string", "pattern": "^[Gg]eometry\\..+", "description": "TODO description: additionalProperties", "title": "TODO" }, - "description": "TODO description: additionalProperties", - "title": "TODO" - }, - "description": "TODO description: geometries", - "title": "Geometries" + "items": { + "type": "string", + "pattern": "^[Gg]eometry\\..+", + "description": "A geometry item, must be defined in the entity", + "title": "Geometry reference" + }, + "description": "A geometry array definition", + "title": "Geometry array" + } }, "materials": { "type": "object", "minProperties": 1, + "description": "A collection of materials array", + "title": "Materials", "additionalProperties": { "type": "array", - "items": { "type": "string", "pattern": "^[Mm]aterial\\..+", "description": "TODO description: additionalProperties", "title": "TODO" }, - "description": "TODO description: additionalProperties", - "title": "TODO" - }, - "description": "TODO description: materials", - "title": "Materials" + "items": { + "type": "string", + "pattern": "^[Mm]aterial\\..+", + "description": "A material item, must be defined in the entity", + "title": "Material reference" + }, + "description": "A material array definition", + "title": "Material array" + } }, "textures": { "type": "object", "minProperties": 1, + "description": "A collection of texture array", + "title": "Textures", "additionalProperties": { "type": "array", "description": "Textures", "title": "Texture", - "items": { "type": "string", "pattern": "^[Tt]exture\\..+", "default": "texture.", "description": "An texture item", "title": "Texture" } - }, - "description": "TODO description: textures", - "title": "Textures" + "items": { + "type": "string", + "pattern": "^[Tt]exture\\..+", + "default": "texture.", + "description": "An texture item", + "title": "Texture" + } + } } - }, - "description": "TODO description: arrays", - "title": "Arrays" + } }, "color": { "additionalProperties": false, @@ -91,14 +107,14 @@ "is_hurt_color": { "additionalProperties": false, "type": "object", + "description": "The color to overlay on the entity when hurt", + "title": "Is Hurt Color", "properties": { - "r": { "$ref": "#/definitions/color" }, - "g": { "$ref": "#/definitions/color" }, - "b": { "$ref": "#/definitions/color" }, - "a": { "$ref": "#/definitions/color" } - }, - "description": "TODO description: is hurt color", - "title": "Is Hurt Color" + "r": { "$ref": "#/definitions/color", "description": "The value of red", "title": "R" }, + "g": { "$ref": "#/definitions/color", "description": "The value of green", "title": "G" }, + "b": { "$ref": "#/definitions/color", "description": "The value of blue", "title": "B" }, + "a": { "$ref": "#/definitions/color", "description": "The value of alpha", "title": "A" } + } }, "materials": { "type": "array", @@ -115,14 +131,14 @@ "overlay_color": { "additionalProperties": false, "type": "object", - "properties": { - "r": { "$ref": "#/definitions/color", "description": "TODO description: r", "title": "R" }, - "g": { "$ref": "#/definitions/color", "description": "TODO description: g", "title": "G" }, - "b": { "$ref": "#/definitions/color", "description": "TODO description: b", "title": "B" }, - "a": { "$ref": "#/definitions/color", "description": "TODO description: a", "title": "A" } - }, "description": "TODO description: overlay color", - "title": "Overlay Color" + "title": "Overlay Color", + "properties": { + "r": { "$ref": "#/definitions/color", "description": "The value of red", "title": "R" }, + "g": { "$ref": "#/definitions/color", "description": "The value of green", "title": "G" }, + "b": { "$ref": "#/definitions/color", "description": "The value of blue", "title": "B" }, + "a": { "$ref": "#/definitions/color", "description": "The value of alpha", "title": "A" } + } }, "textures": { "type": "array", @@ -168,7 +184,11 @@ "description": "TODO description: part visibility", "title": "Part Visibility" }, - "rebuild_animation_matrices": { "type": "boolean", "description": "TODO description: rebuild animation matrices", "title": "Rebuild Animation Matrices" } + "rebuild_animation_matrices": { + "type": "boolean", + "description": "TODO description: rebuild animation matrices", + "title": "Rebuild Animation Matrices" + } } }, "description": "TODO description: render controllers", diff --git a/source/resource/render_controllers/1.8.0/render_controllers.json b/source/resource/render_controllers/1.8.0/render_controllers.json index 1e9b1a34..d219138d 100644 --- a/source/resource/render_controllers/1.8.0/render_controllers.json +++ b/source/resource/render_controllers/1.8.0/render_controllers.json @@ -32,80 +32,97 @@ "required": ["geometry", "materials"], "properties": { "arrays": { - "additionalProperties": false, - "description": "TODO description: arrays", - "title": "Arrays", "type": "object", + "title": "Arrays", + "additionalProperties": false, + "description": "A collection of definition of arrays", "properties": { "geometries": { "type": "object", "minProperties": 1, - "propertyNames": { "pattern": "^[Aa]rray\\..+" }, + "description": "A collection of Geometry array", + "title": "Geometries", "additionalProperties": { "type": "array", - "items": { "type": "string", "pattern": "^[Gg]eometry\\..+", "description": "TODO description: additionalProperties", "title": "TODO" }, - "description": "TODO description: additionalProperties", - "title": "TODO" - }, - "description": "TODO description: geometries", - "title": "Geometries" + "items": { + "type": "string", + "pattern": "^[Gg]eometry\\..+", + "description": "A geometry item, must be defined in the entity", + "title": "Geometry reference" + }, + "description": "A geometry array definition", + "title": "Geometry array" + } }, "materials": { "type": "object", "minProperties": 1, - "propertyNames": { "pattern": "^[Aa]rray\\..+" }, + "description": "A collection of materials array", + "title": "Materials", "additionalProperties": { "type": "array", - "items": { "type": "string", "pattern": "^[Mm]aterial\\..+", "description": "TODO description: additionalProperties", "title": "TODO" }, - "description": "TODO description: additionalProperties", - "title": "TODO" - }, - "description": "TODO description: materials", - "title": "Materials" + "items": { + "type": "string", + "pattern": "^[Mm]aterial\\..+", + "description": "A material item, must be defined in the entity", + "title": "Material reference" + }, + "description": "A material array definition", + "title": "Material array" + } }, "textures": { "type": "object", "minProperties": 1, - "propertyNames": { "pattern": "^[Aa]rray\\..+" }, + "description": "A collection of texture array", + "title": "Textures", "additionalProperties": { "type": "array", - "items": { "type": "string", "pattern": "^[Tt]exture\\..+", "description": "TODO description: additionalProperties", "title": "TODO" }, - "description": "TODO description: additionalProperties", - "title": "TODO" - }, - "description": "TODO description: textures", - "title": "Textures" + "description": "Textures", + "title": "Texture", + "items": { + "type": "string", + "pattern": "^[Tt]exture\\..+", + "default": "texture.", + "description": "An texture item", + "title": "Texture" + } + } } } }, "color": { + "description": "TODO description: color", + "title": "Color", "additionalProperties": false, "type": "object", "properties": { - "r": { "$ref": "#/definitions/color" }, - "g": { "$ref": "#/definitions/color" }, - "b": { "$ref": "#/definitions/color" }, - "a": { "$ref": "#/definitions/color" } - }, - "description": "TODO description: color", - "title": "Color" + "r": { "$ref": "#/definitions/color", "description": "The value of red", "title": "R" }, + "g": { "$ref": "#/definitions/color", "description": "The value of green", "title": "G" }, + "b": { "$ref": "#/definitions/color", "description": "The value of blue", "title": "B" }, + "a": { "$ref": "#/definitions/color", "description": "The value of alpha", "title": "A" } + } }, "filter_lighting": { "type": "boolean", "description": "TODO description: filter lighting", "title": "Filter Lighting" }, "geometry": { "type": "string", "description": "TODO description: geometry", "title": "Geometry" }, "ignore_lighting": { "type": "boolean", "description": "TODO description: ignore lighting", "title": "Ignore Lighting" }, "is_hurt_color": { - "additionalProperties": false, "type": "object", + "title": "Is hurt color", + "additionalProperties": false, + "description": "The color that is overlay when hurt", "properties": { - "r": { "$ref": "#/definitions/color" }, - "g": { "$ref": "#/definitions/color" }, - "b": { "$ref": "#/definitions/color" }, - "a": { "$ref": "#/definitions/color" } - }, - "description": "TODO description: is hurt color", - "title": "Is Hurt Color" + "r": { "$ref": "#/definitions/color", "description": "The value of red", "title": "R" }, + "g": { "$ref": "#/definitions/color", "description": "The value of green", "title": "G" }, + "b": { "$ref": "#/definitions/color", "description": "The value of blue", "title": "B" }, + "a": { "$ref": "#/definitions/color", "description": "The value of alpha", "title": "A" } + } + }, + "light_color_multiplier": { + "$ref": "../../../molang/1.8.0/number.json", + "description": "TODO description: light color multiplier", + "title": "Light Color Multiplier" }, - "light_color_multiplier": { "$ref": "../../../molang/1.8.0/number.json", "description": "TODO description: light color multiplier", "title": "Light Color Multiplier" }, "materials": { "type": "array", "minItems": 1, @@ -159,7 +176,11 @@ "description": "TODO description: part visibility", "title": "Part Visibility" }, - "rebuild_animation_matrices": { "type": "boolean", "description": "TODO description: rebuild animation matrices", "title": "Rebuild Animation Matrices" }, + "rebuild_animation_matrices": { + "type": "boolean", + "description": "TODO description: rebuild animation matrices", + "title": "Rebuild Animation Matrices" + }, "textures": { "type": "array", "minItems": 1,