diff --git a/docs/Other/Map-related-JSON-files.md b/docs/Other/Map-related-JSON-files.md index 4de79f0bdc..6e8b4aed2e 100644 --- a/docs/Other/Map-related-JSON-files.md +++ b/docs/Other/Map-related-JSON-files.md @@ -1,14 +1,9 @@ -* [Terrains.json](#terrainsjson) -* [TileResources.json](#tileresourcesjson) -* [TileImprovements.json](#tileimprovementsjson) -* [Ruins.json](#ruinsjson) -* [Tileset-specific json](#tileset-specific-json) - ## Terrains.json This file lists the base terrains, terrain features and natural wonders that can appear on the map. Each terrain entry can have the following properties: + | Attribute | Type | Optional? | Notes | |-----------|------|-----------|-------| | name | String | Required | | @@ -35,6 +30,7 @@ This file lists the improvements that can be constructed or created on a map til Note that improvements have two visual representations - icon and pixel graphic in the tileset. Omitting the icon results in a horribly ugly user interface, while omitting tileset graphics will just miss out on an _optional_ visualization. If you provide a pixel graphic for FantasyHex, please be aware of the layering system and the ruleVariants in the tileset json. A single graphic may suffice if it has lots of transparency, as it will be drawn on top of all other terrain elements. Each improvement can have the following properties: + | Attribute | Type | Optional? | Notes | |-----------|------|-----------|-------| | name | String | Required | | @@ -61,6 +57,7 @@ Note the predefined resource _types_ cannot be altered in json. Note also that resources have two visual representations - icon and pixel graphic in the tileset. Omitting the icon results in a horribly ugly user interface, while omitting tileset graphics will miss out on a visualization on the map. If you provide a pixel graphic for FantasyHex, please be aware of the layering system and the ruleVariants in the tileset json. A single graphic may suffice if it has lots of transparency, as it will be drawn on top of terrain and features but below an improvement - if the single improvement graphic exists at all. Each resource can have the following properties: + | Attribute | Type | Optional? | Notes | |-----------|------|-----------|-------| | name | String | Required | | diff --git a/docs/Other/Miscellaneous-JSON-files.md b/docs/Other/Miscellaneous-JSON-files.md index eb1bcc807d..db7cefbfac 100644 --- a/docs/Other/Miscellaneous-JSON-files.md +++ b/docs/Other/Miscellaneous-JSON-files.md @@ -1,16 +1,11 @@ -* [Difficulties.json](#difficultiesjson) -* [Eras.json](#erasjson) -* [ModOptions.json](#modoptionsjson) -* [Generic Civilopedia Text](#civilopedia-text) - - ## Difficulties.json [Link to original](/jsons/Civ%20V%20-%20Vanilla/Difficulties.json) This file defines the difficulty levels a player can choose when starting a new game. Each difficulty level can have the following attributes: + | Attribute | Type | Mandatory | Notes | | --------- | ---- | ------- | ----- | | name | String | Required | Name of the difficulty level | @@ -44,6 +39,7 @@ Each difficulty level can have the following attributes: This file should contain all the era's you want to use in your mod. Each era can have the following attributes: + | attribute | Type | optional or not | notes | | --------- | ---- | --------------- | ----- | | name | String | required | Name of the era | @@ -69,6 +65,7 @@ This file is a little different: - Is entirely optional but will be created after downloading a mod The file can have the following attributes, including the values Unciv sets (no point in a mod author setting those): + | Attribute | Type | Defaults | Notes | |-----------|------|-----------|-------| | isBaseRuleset | Boolean | false | Differentiates mods that change the vanilla ruleset or replace it | @@ -97,6 +94,7 @@ An example of the format is: ], ``` List of attributes - note not all combinations are valid: + |attribute|type|description| |---------|----|-----------| |`text`|String|Text to display.| diff --git a/docs/Other/Unit-related-JSON-files.md b/docs/Other/Unit-related-JSON-files.md index 7072e7ea1d..f80e1f5470 100644 --- a/docs/Other/Unit-related-JSON-files.md +++ b/docs/Other/Unit-related-JSON-files.md @@ -1,15 +1,11 @@ -* [Units.json](#unitsjson) -* [UnitPromotions.json](#unitpromotionsjson) -* [UnitTypes.json](#unittypesjson) - - ## Units.json [Link to original](/jsons/Civ%20V%20-%20Vanilla/Units.json) This file should contain a list of all the units, both military and civilian, that you want to use in your mod. Each unit can have the following attributes: + | attribute | Type | optional or not | notes | | --------- | ---- | -------- | ----- | | name | String | required | The name of the units (required) | @@ -44,6 +40,7 @@ Each promotion must have an icon, except progressions ending in " I", " II", " I Remember, promotions can be "bought" with XP, but also granted by the unit type, buildings, wonders and such. They are preserved when a unit upgrades, therefore special properties of nation unique units that can be inherited when they upgrade should be in a promotion, not uniques/stats in the units json (example: Slinger withdraw). Each promotion can have the following properties: + | Attribute | Type | Optional? | Notes | |-----------|------|-----------|-------| | name | String | Required | See above for "I, II, III" progressions |