diff --git a/docs/Modders/schemas/buildings.json b/docs/Modders/schemas/buildings.json index cac09ceb10..d0facbd3df 100644 --- a/docs/Modders/schemas/buildings.json +++ b/docs/Modders/schemas/buildings.json @@ -19,15 +19,20 @@ "requiredTech": { "type": "string" }, "cost": { "type": "number" }, - "maintenance": { "type": "number" }, + "maintenance": { + "type": "number", + "description": "Gold upkeep per turn for this building" + }, "percentStatBonus": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/stats.json" }, "specialistSlots": { "type": "object", - "additionalProperties": {"type": "integer"} + "additionalProperties": {"type": "integer"}, + "description": "How many specialists of each type does this building allow for. Key must be name of existing specialist." }, "greatPersonPoints": { "type": "object", - "additionalProperties": {"type": "integer"} + "additionalProperties": {"type": "integer"}, + "description": "Which Great Person Points this building generates per turn. Key must be name of Great Person unit." }, "hurryCostModifier": { "type": "number" }, "isWonder": { "type": "boolean" }, @@ -36,14 +41,29 @@ "requiredResource": { "type": "string" }, "requiredNearbyImprovedResources": { "type": "array", - "items": { "type": "string" } + "items": { "type": "string" }, + "uniqueItems": true }, "cityStrength": { "type": "number" }, "cityHealth": { "type": "number" }, - "replaces": { "type": "string" }, - "uniqueTo": { "type": "string" }, - "quote": { "type": "string" }, - "replacementTextForUniques": { "type": "string" } + + "uniqueTo": { + "type": "string", + "description": "Designates that only this nation can build this unit. Must be exact name of existing nation." + }, + "replaces": { + "type": "string", + "description": "For unique units: the name of the original unit that this unit replaces for the uniqueTo nation." + }, + + "quote": { + "type": "string", + "description": "Quote that will be displayed for Wonders in the 'construction completed' popup" + }, + "replacementTextForUniques": { + "type": "string", + "description": "Freeform text that will be shown to users, overriding the list of uniques." + } }, "required": [ "name" diff --git a/docs/Modders/schemas/units.json b/docs/Modders/schemas/units.json index 73a8e6bb67..8c0db317ab 100644 --- a/docs/Modders/schemas/units.json +++ b/docs/Modders/schemas/units.json @@ -23,19 +23,29 @@ "obsoleteTech": { "type": "string" }, "upgradesTo": { "type": "string" }, - "uniqueTo": { "type": "string" }, - "replaces": { "type": "string" }, + "uniqueTo": { + "type": "string", + "description": "Designates that only this nation can build this unit. Must be exact name of existing nation." + }, + "replaces": { + "type": "string", + "description": "For unique units: the name of the original unit that this unit replaces for the uniqueTo nation." + }, "uniques": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/uniques.json" }, "promotions": { "type": "array", "items": { "type": "string" }, - "uniqueItems": true + "uniqueItems": true, + "description": "Promotions that the unit gets on creation. Must be exact names of existing promotions." }, "attackSound": { "type": "string" }, - "replacementTextForUniques": { "type": "string" }, + "replacementTextForUniques": { + "type": "string", + "description": "Freeform text that will be shown to users, overriding the list of uniques." + }, "civilopediaText": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/civilopediaText.json" } }, "required": [