mirrors/Unciv
1
0
Fork 0
mirror of https://github.com/yairm210/Unciv.git synced 2025-07-07 00:41:39 +07:00
Code Issues Packages Projects Releases Wiki Activity

Added descriptions for some fields

Browse Source
This commit is contained in:
Yair Morgenstern
2023-09-22 11:14:59 +03:00
parent 08816c7f6b
commit 79b54484e5
2 changed files with 42 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/Modders/schemas/buildings.json
View File

@ -19,15 +19,20 @@
"requiredTech": { "type": "string" }, "requiredTech": { "type": "string" },
"cost": { "type": "number" }, "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" }, "percentStatBonus": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/stats.json" },
"specialistSlots": { "specialistSlots": {
"type": "object", "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": { "greatPersonPoints": {
"type": "object", "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" }, "hurryCostModifier": { "type": "number" },
"isWonder": { "type": "boolean" }, "isWonder": { "type": "boolean" },
@ -36,14 +41,29 @@
"requiredResource": { "type": "string" }, "requiredResource": { "type": "string" },
"requiredNearbyImprovedResources": { "requiredNearbyImprovedResources": {
"type": "array", "type": "array",
"items": { "type": "string" } "items": { "type": "string" },
"uniqueItems": true
}, },
"cityStrength": { "type": "number" }, "cityStrength": { "type": "number" },
"cityHealth": { "type": "number" }, "cityHealth": { "type": "number" },
"replaces": { "type": "string" },
"uniqueTo": { "type": "string" }, "uniqueTo": {
"quote": { "type": "string" }, "type": "string",
"replacementTextForUniques": { "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": [ "required": [
"name" "name"

18
docs/Modders/schemas/units.json
View File

@ -23,19 +23,29 @@
"obsoleteTech": { "type": "string" }, "obsoleteTech": { "type": "string" },
"upgradesTo": { "type": "string" }, "upgradesTo": { "type": "string" },
"uniqueTo": { "type": "string" }, "uniqueTo": {
"replaces": { "type": "string" }, "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" }, "uniques": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/uniques.json" },
"promotions": { "promotions": {
"type": "array", "type": "array",
"items": { "type": "string" }, "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" }, "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" } "civilopediaText": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/civilopediaText.json" }
}, },
"required": [ "required": [