Deployed 5a204eb with MkDocs version: 1.6.1

yairm210 · Nov 27, 2024 · 6acd07c · 6acd07c
commit 6acd07c
Show file tree

Hide file tree

Showing 105 changed files with 74,703 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/404.html b/404.html
diff --git a/Credits/index.html b/Credits/index.html
diff --git a/Developers/Building-Locally/index.html b/Developers/Building-Locally/index.html
diff --git a/Developers/Coding-standards/index.html b/Developers/Coding-standards/index.html
diff --git a/Developers/From-code-to-deployment/index.html b/Developers/From-code-to-deployment/index.html
diff --git a/Developers/Game-Making-Tips/index.html b/Developers/Game-Making-Tips/index.html
diff --git a/Developers/Map-rendering/index.html b/Developers/Map-rendering/index.html
diff --git a/Developers/Project-structure-and-major-classes/index.html b/Developers/Project-structure-and-major-classes/index.html
diff --git a/Developers/Saved-games-and-transients/index.html b/Developers/Saved-games-and-transients/index.html
diff --git a/Developers/Testing-Android-Builds/index.html b/Developers/Testing-Android-Builds/index.html
diff --git a/Developers/Translations,-mods,-and-modding-freedom-in-Open-Source/index.html b/Developers/Translations,-mods,-and-modding-freedom-in-Open-Source/index.html
diff --git a/Developers/UI-development/index.html b/Developers/UI-development/index.html
diff --git a/Developers/Uniques/index.html b/Developers/Uniques/index.html
diff --git a/Guiding-Principles/index.html b/Guiding-Principles/index.html
diff --git a/Modders/Autoupdates/index.html b/Modders/Autoupdates/index.html
diff --git a/Modders/Creating-a-UI-skin/index.html b/Modders/Creating-a-UI-skin/index.html
diff --git a/Modders/Creating-a-custom-tileset/index.html b/Modders/Creating-a-custom-tileset/index.html
diff --git a/Modders/Images-and-Audio/index.html b/Modders/Images-and-Audio/index.html
diff --git a/Modders/Making-a-new-Civilization/index.html b/Modders/Making-a-new-Civilization/index.html
diff --git a/Modders/Mod-file-structure/1-Overview/index.html b/Modders/Mod-file-structure/1-Overview/index.html
diff --git a/Modders/Mod-file-structure/2-Civilization-related-JSON-files/index.html b/Modders/Mod-file-structure/2-Civilization-related-JSON-files/index.html
diff --git a/Modders/Mod-file-structure/3-Map-related-JSON-files/index.html b/Modders/Mod-file-structure/3-Map-related-JSON-files/index.html
diff --git a/Modders/Mod-file-structure/4-Unit-related-JSON-files/index.html b/Modders/Mod-file-structure/4-Unit-related-JSON-files/index.html
diff --git a/Modders/Mod-file-structure/5-Miscellaneous-JSON-files/index.html b/Modders/Mod-file-structure/5-Miscellaneous-JSON-files/index.html
diff --git a/Modders/Mods/index.html b/Modders/Mods/index.html
diff --git a/Modders/Scenarios/index.html b/Modders/Scenarios/index.html
diff --git a/Modders/Type-checking/index.html b/Modders/Type-checking/index.html
diff --git a/Modders/Unique-parameters/index.html b/Modders/Unique-parameters/index.html
diff --git a/Modders/schemas/buildings.json b/Modders/schemas/buildings.json
@@ -0,0 +1,73 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "type": "array",
+  "items": {
+      "type": "object",
+      "properties": {
+          "name": { "type": "string" },
+
+          "production": { "type": "number" },
+          "food": { "type": "number" },
+          "gold": { "type": "number" },
+          "science": { "type": "number" },
+          "culture": { "type": "number" },
+          "happiness": { "type": "number" },
+          "faith": { "type": "number" },
+
+          "uniques": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/uniques.json" },
+          "civilopediaText": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/civilopediaText.json" },
+
+          "requiredTech": { "type": "string" },
+          "cost": { "type": "integer" },
+          "maintenance": {
+              "type": "integer",
+              "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" },
+              "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" },
+              "description": "Which Great Person Points this building generates per turn. Key must be name of Great Person unit."
+          },
+          "hurryCostModifier": { "type": "number" },
+          "isWonder": { "type": "boolean" },
+          "isNationalWonder": { "type": "boolean" },
+          "requiredBuilding": { "type": "string" },
+          "requiredResource": { "type": "string" },
+          "requiredNearbyImprovedResources": {
+              "type": "array",
+              "items": { "type": "string" },
+              "uniqueItems": true
+          },
+          "cityStrength": { "type": "integer" },
+          "cityHealth": { "type": "integer" },
+
+          "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"
+      ],
+      "additionalProperties": false
+  }
+}
diff --git a/Modders/schemas/civilopediaText.json b/Modders/schemas/civilopediaText.json
@@ -0,0 +1,22 @@
+{
+    "type": "array",
+    "items": {
+        "type": "object",
+        "properties": {
+            "text": { "type": "string" },
+            "link": { "type": "string" },
+            "icon": { "type": "string" },
+            "extraImage": { "type": "string" },
+            "imageSize": { "type": "number" },
+            "size": { "type": "number" },
+            "header": { "type": "number" },
+            "indent": { "type": "number" },
+            "padding": { "type": "number" },
+            "color": { "type": "string" },
+            "separator": { "type": "boolean" },
+            "starred": { "type": "boolean" },
+            "centered": { "type": "boolean" },
+            "iconCrossed": { "type": "boolean" }
+        }
+    }
+}
diff --git a/Modders/schemas/color.json b/Modders/schemas/color.json
@@ -0,0 +1,11 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "type": "array",
+    "minLength": 3,
+    "maxLength": 3,
+    "items": {
+        "type": "integer",
+        "minimum": 0,
+        "maximum": 255
+    }
+}
diff --git a/Modders/schemas/events.json b/Modders/schemas/events.json
@@ -0,0 +1,32 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "type": "array",
+  "items": {
+      "type": "object",
+      "properties": {
+          "name": { "type": "string" },
+          "text": { "type": "string" },
+          "presentation": { "enum": ["None", "Alert", "Floating"] },
+
+          "uniques": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/uniques.json" },
+          "civilopediaText": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/civilopediaText.json" },
+
+          "choices": {
+              "type": "array",
+              "items": {
+                  "properties": {
+                      "text": { "type": "string" },
+                      "uniques": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/uniques.json" },
+                      "civilopediaText": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/civilopediaText.json" }
+                  },
+                  "required": ["text", "uniques"],
+                  "additionalProperties": false
+              }
+          }
+      },
+      "required": [
+          "name"
+      ],
+      "additionalProperties": false
+  }
+}
diff --git a/Modders/schemas/nations.json b/Modders/schemas/nations.json
@@ -0,0 +1,66 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "type": "array",
+  "items": {
+      "type": "object",
+      "properties": {
+          "name": { "type": "string" },
+          "leaderName": { "type": "string" },
+          "adjective": {
+              "type": "array",
+              "items": { "type": "string" },
+              "uniqueItems": true,
+              "description": "Currently not in use"
+          },
+          "style": { "type": "string" },
+          "cityStateType": { "type": "string" },
+          "outerColor": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/color.json" },
+          "innerColor": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/color.json" },
+
+          "preferredVictoryType": { "type": "string" },
+          "startBias": {
+              "type": "array",
+              "items": { "type": "string" },
+              "uniqueItems": true,
+              "description": "Types of tiles where the civ will be more likely to start"
+          },
+
+          "uniques": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/uniques.json" },
+
+
+          // All of these are cosmetic
+          "introduction": { "type": "string" },
+          "tradeRequest": { "type": "string" },
+          "neutralHello": { "type": "string" },
+          "hateHello": { "type": "string" },
+
+          "declaringWar": { "type": "string" },
+          "attacked": { "type": "string" },
+          "defeated": { "type": "string" },
+          "startIntroPart1": { "type": "string" },
+          "startIntroPart2": { "type": "string" },
+          "cities": {
+              "type": "array",
+              "items": { "type": "string" },
+              "uniqueItems": true,
+          },
+          "spyNames": {
+              "type": "array",
+              "items": { "type": "string" },
+              "uniqueItems": true,
+          },
+          "favoredReligion": { "type": "string" },
+
+          "uniqueName": { "type": "string" },
+          "uniqueText": {
+              "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": [
+          "name", "outerColor", "cities"
+      ],
+      "additionalProperties": false
+  }
+}
diff --git a/Modders/schemas/stats.json b/Modders/schemas/stats.json
@@ -0,0 +1,14 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "type": "object",
+    "properties": {
+        "production": { "type": "number" },
+        "food": { "type": "number" },
+        "gold": { "type": "number" },
+        "science": { "type": "number" },
+        "culture": { "type": "number" },
+        "happiness": { "type": "number" },
+        "faith": { "type": "number" }
+    },
+    "additionalProperties": false
+}
diff --git a/Modders/schemas/techs.json b/Modders/schemas/techs.json
@@ -0,0 +1,58 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "type": "array",
+  "items": {
+      "type": "object",
+      "properties": {
+          "columnNumber": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "The number of this column in the techs matrix - 0 being the leftmost column"
+          },
+          "era": { "type": "string" },
+          "techCost": { "type": "integer" },
+          "buildingCost": { "type": "integer" },
+          "wonderCost": { "type": "integer" },
+          "techs": {
+              "type": "array",
+              "items": {
+                  "type": "object",
+                  "properties": {
+                      "name":  { "type": "string" },
+                      "row":  {
+                          "type": "integer",
+                          "minimum": 1,
+                          "description": "The row, within the column, where this tech appears - 1 being the topmost tech"
+                      },
+                      "cost":  {
+                          "type": "integer",
+                          "description": "Science cost of this tech - overrides the column techCost"
+                      },
+                      "uniques":  { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/uniques.json" },
+                      "prerequisites": {
+                          "type": "array",
+                          "items": { "type": "string" },
+                          "description": "The names of techs which must be researched before this tech can be researched",
+                          "uniqueItems": true
+                      },
+                      "civilopediaText": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/civilopediaText.json" },
+                      "quote":  {
+                          "type": "string",
+                          "description": "The quote that is displayed when you have researched the tech - flavor text"
+                      }
+                  },
+                  "required": ["name", "row"],
+                  "additionalProperties": false
+              }
+          },
+
+          "uniques": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/uniques.json" },
+
+          "civilopediaText": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/civilopediaText.json" }
+      },
+      "required": [
+          "columnNumber", "era"
+      ],
+      "additionalProperties": false
+  }
+}
diff --git a/Modders/schemas/terrains.json b/Modders/schemas/terrains.json
@@ -0,0 +1,41 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "type": "array",
+  "items": {
+      "type": "object",
+      "properties": {
+          "name": { "type": "string" },
+          "type": { "enum": ["Land", "Water", "TerrainFeature", "NaturalWonder"] },
+
+          "production": { "type": "number" },
+          "food": { "type": "number" },
+          "gold": { "type": "number" },
+          "science": { "type": "number" },
+          "culture": { "type": "number" },
+          "happiness": { "type": "number" },
+          "faith": { "type": "number" },
+
+          "movementCost": { "type": "number" },
+          "impassable": { "type": "boolean" },
+          "defenceBonus": { "type": "number", "description": "In percentages - so 0.1 is 10% bonus" },
+          "unbuildable": { "type": "boolean", "description": "If true, nothing can be built here - not even resource improvements" },
+
+          "RGB": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/color.json" },
+
+          "occursOn": { "type": "array", "items": { "type": "string" },
+              "description": "For terrain features - List of terrains that this feature can appear on" },
+          "overrideStats": { "type": "boolean", "description": "For terrain features - indicates the stats of this terrain override those of all previous layers" },
+
+          "turnsInto": { "type": "string", "description": "Used by Natural Wonders: it is the baseTerrain on top of which the Natural Wonder is placed" },
+          "weight": { "type": "number", "description": "For natural wonders - the chance this nat wonder will be picked" },
+
+          "uniques": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/uniques.json" },
+
+          "civilopediaText": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/civilopediaText.json" }
+      },
+      "required": [
+          "name", "type"
+      ],
+      "additionalProperties": false
+  }
+}
diff --git a/Modders/schemas/tileImprovements.json b/Modders/schemas/tileImprovements.json
@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "type": "array",
+  "items": {
+      "type": "object",
+      "properties": {
+          "name": { "type": "string" },
+          "terrainsCanBeBuiltOn": {
+              "type": "array",
+              "items": { "type": "string" },
+              "uniqueItems": true
+          },
+          "turnsToBuild": { "type": "integer" },
+          "techRequired": { "type": "string" },
+          "uniqueTo": { "type": "string" },
+          "shortcutKey": {
+              "type": "string",
+              "maxLength": 1
+          },
+
+          "production": { "type": "number" },
+          "food": { "type": "number" },
+          "gold": { "type": "number" },
+          "science": { "type": "number" },
+          "culture": { "type": "number" },
+          "happiness": { "type": "number" },
+          "faith": { "type": "number" },
+
+          "uniques": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/uniques.json" },
+
+          "civilopediaText": { "$ref": "https://raw.githubusercontent.com/yairm210/Unciv/master/docs/Modders/schemas/civilopediaText.json" }
+      },
+      "required": [
+          "name",
+      ],
+      "additionalProperties": false
+  }
+}