From 3a494cb22fd1dc9427e44fad63e93b3d64d8ffce Mon Sep 17 00:00:00 2001
From: SomeTroglodyte <63000004+SomeTroglodyte@users.noreply.github.com>
Date: Sun, 15 Aug 2021 20:02:13 +0200
Subject: [PATCH] Created Unit-related JSON files (markdown)

---
 Unit-related-JSON-files.md | 67 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 Unit-related-JSON-files.md

diff --git a/Unit-related-JSON-files.md b/Unit-related-JSON-files.md
new file mode 100644
index 0000000..d05935b
--- /dev/null
+++ b/Unit-related-JSON-files.md
@@ -0,0 +1,67 @@
+
+* [Units.json](#unitsjson)
+* [UnitPromotions.json](#unitpromotionsjson)
+* [UnitTypes.json](#unittypesjson)
+
+
+## Units.json
+[Link to original](https://github.com/yairm210/Unciv/blob/master/android/assets/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) |
+| unitType | String | required | The type of the unit. Must be in [UnitTypes.json](UnitTypes.json) |
+| cost | Integer (≥0) | defaults to 0 | The amount of production required to build this unit |
+| movement | Integer (≥0) | defaults to 0 | The amount of movement points the unit has by default |
+| strength | Integer (≥0) | defaults to 0 | The melee attack and defensive strength of the unit. If this and rangedStrength are ommited or 0, the unit will be a civilian |
+| rangedStrength | Integer (≥0) | defaults to 0 | The ranged attack strength of the unit. If omitted, the unit cannot ranged attack |
+| range | Integer (≥0) | defaults to 2 | The default range from which ranged attacks can be preformed |
+| interceptRange | Integer (≥0) | defaults to 0 | Air units attacking within in this range will be intercepted |
+| requiredTech | String | defaults to none | The tech required to build this unit. Must be in [Techs.json](#techsjson) |
+| obsoleteTech | String | defaults to none | After researching this tech, the unit can no longer be build. Must be in [Techs.json](#techsjson) |
+| requiredResource | String | defaults to none | Resource that is consumed by building this unit. Must be in [TileResources.json](#tilereousrcesjson) |
+| upgradesTo | String | defaults to none | Unit that this unit can upgrade to when it is available. Must be in [Units.json](#unitsjson) |
+| replaces | String | defaults to none | If this unit is unique to a nation, this is the unit it replaces. Must be in [Units.json](#unitsjson) |
+| uniqueTo | String | defaults to none | The nation that this unit is unique to. Must be in [Nations.json](#nationsjson) |
+| hurryCostModifier | Integer | defaults to 0 | If this unit is bought for gold/faith, it's price is increased by so much percent |
+| promotions | List of Strings | defaults to none | A list of all the promotions the unit automatically receives upon being built. Each promotion must be in [UnitPromotions.json](#unitpromotionsjson) |
+| uniques | List of Strings | defaults to none | A list of the unique abilities this unit has. A list of almost all uniques can be found [here](../Uniques#unit-uniques) |
+| replacementTextForUniques | String | defaults to none | If provided, this will be displayed instead of the list of uniques. Can be used for better formatting. |
+| attackSound | String | defaults to none | The sound that is to be played when this unit attacks. For possible values, see [sounds](#Sounds)
+| civilopediaText | List | Default empty | see [civilopediaText chapter](#civilopedia-text) |
+
+
+## UnitPromotions.json
+[Link to original](https://github.com/yairm210/Unciv/blob/master/android/assets/jsons/Civ%20V%20-%20Vanilla/UnitPromotions.json)
+
+This file lists the available unit promotions.
+
+Each promotion must have an icon, except progressions ending in " I", " II", " III" (no IV V VI allowed) are rendered by looking up an icon without those suffixes and adding stars.
+
+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 |
+| prerequisites | List | Default empty | Prerequisite promotions |
+| effect | String | Default empty | Deprecated, use uniques instead |
+| unitTypes | List | Default empty | The unit types for which this promotion applies as specified in [UnitTypes.json](#unittypesjson) |
+| uniques | List | Default empty | List of effects, [see here](../Uniques#unit-uniques) |
+| civilopediaText | List | Default empty | see [civilopediaText chapter](#civilopedia-text) |
+
+
+## UnitTypes.json
+[Link to original](https://github.com/yairm210/Unciv/blob/master/android/assets/jsons/Civ%20V%20-%20Vanilla/UnitTypes.json)
+
+This optional file is used for defining new types of units. The names of these can be used in unitFilters, and these types determine what domain the unit moves in: over land, over water or through the air. If the file is ommitted, the following are automatically added:
+Civilian, Melee, Ranged, Scout, Mounted, Armor, Siege, WaterCivilian, WaterMelee, WaterRanged, WaterSubmarine, WaterAircraftCarrier, Fighter, Bomber, AtomicBomber, and Missile.
+
+| attribute | Type | optional or not | notes |
+| --------- | ---- | -------- | ----- |
+| name | String | required | The name of the unit type |
+| movementType | String | required | The domain through which the unit moves. Allowed values: "Water", "Land", "Air" |
+| uniques | List of String | defaults to none | A list of the unique abilities every unit of this type has. A list of almost all uniques can be found [here](../Uniques#unit-uniques) |