Documentation for Personality json (#11138)

* Documentation for Personality json

* whoops, bad link

* Fix inaccurate "double focus" comment

* Fix accidental copy-paste error

* Edit priority text to maybe be clearer

core/src/com/unciv/logic/civilization/managers/PolicyManager.kt

@@ -46,7 +46,7 @@ class PolicyManager : IsPartOfGameInfoSerialization {
             val value = HashMap<PolicyBranch, Int>()
             for (branch in branches) {
                 val victoryPriority = branch.priorities[civInfo.nation.preferredVictoryType] ?: 0
-                val personalityPriority = civInfo.getPersonality().policy[branch.name] ?: 0
+                val personalityPriority = civInfo.getPersonality().priorities[branch.name] ?: 0
                 value[branch] = victoryPriority + personalityPriority
             }
             return value

core/src/com/unciv/models/ruleset/nation/Personality.kt

@@ -5,6 +5,9 @@ import com.unciv.models.ruleset.RulesetObject
 import com.unciv.models.ruleset.unique.UniqueTarget
 import kotlin.reflect.KMutableProperty0
 
+/**
+ * Type of Personality focus. Typically ranges from 0 (no focus) to 10 (double focus)
+ */
 enum class PersonalityValue {
     Production,
     Food,
@@ -27,7 +30,7 @@ class Personality: RulesetObject() {
     var faith: Float = 5f
     var military: Float = 5f
     var warMongering: Float = 5f // Todo: Look into where this should be inserted
-    var policy = LinkedHashMap<String, Int>()
+    var priorities = LinkedHashMap<String, Int>()
     var preferredVictoryType: String = Constants.neutralVictoryType
     var isNeutralPersonality: Boolean = false
 

docs/Modders/Mod-file-structure/2-Civilization-related-JSON-files.md

@@ -64,6 +64,7 @@ Each nation has the following structure:
 | cityStateType | String | none | Distinguishes major civilizations from city states (must be in [CityStateTypes.json](#citystatetypesjson)) |
 | startBias | List of strings | empty | Zero or more of: [terrainFilter](../Unique-parameters.md/#terrainfilter) or "Avoid [terrainFilter]". [^S] |
 | preferredVictoryType | String | Neutral | The victory type major civilizations will pursue (need not be specified in [VictoryTypes.json](5-Miscellaneous-JSON-files.md#victorytypesjson)) |
+| personality | String | none | The name of the personality specified in [Personalities.json](#personalitiesjson)
 | favoredReligion | String | none | The religion major civilization will choose if available when founding a religion. Must be in [Religions.json](#religionsjson) |
 | startIntroPart1 | String | none | Introductory blurb shown to Player on game start... |
 | startIntroPart2 | String | none | ... second paragraph. ___NO___ "TBD"!!! Leave empty to skip that alert. |
@@ -91,6 +92,37 @@ Each nation has the following structure:
       These notes are __only__ valid when playing on generated maps, loaded maps from map editor get no "regions" and startBias is processed differently (but you can expect single-entry startBias to work best).
 [^V]: See [Supply Leader Voices](../Images-and-Audio.md#supply-leader-voices)
 
+## Personalities.json
+
+This file contains all Personalities for computer players.
+
+Each personality has the following structure:
+
+| Attribute | Type | Default | Notes |
+| --------- | ---- | ------- | ----- |
+| name | String | Required | |
+| preferredVictoryType | String | Neutral | The victory type major civilizations will pursue (need not be specified in [VictoryTypes.json](5-Miscellaneous-JSON-files.md#victorytypesjson)) |
+| [`<stats>`](3-Map-related-JSON-files.md#general-stat) | Float | 5 | Amount of focus on the stat the computer player will have. Typically ranges from 0 (no focus) to 10 (double focus) |
+| military | Float | 5 | Amount of focus on the military growth the computer player will have. Typically ranges from 0 (no focus) to 10 (double focus) |
+<!-- | warMongering | Float | 5 | Amount of focus on declaring war the computer player will have. Typically ranges from 0 (no focus) to 10 (double focus) |-->
+| priorities | Object | none | Priorities for each policy branch, [^B]
+| uniques | List | empty | List of [unique abilities](../uniques) this personality has |
+| civilopediaText | List | empty | See [civilopediaText chapter](5-Miscellaneous-JSON-files.md#civilopedia-text) |
+
+[^B]: Similar to [policy priorites](#branch-priorities) The "priorities" object defines the priority major civilizations' AI give to a policy branch. The AI chooses the policy branch with the highest number for their preferred victory type. If two or more candidate branches have the same priority, the AI chooses a random branch among the candidates.
+
+The object maps policy branches to priority values for the major civilization using the policy branches name and integers. Any branches not listed have a default value of 0
+
+The code below is an example of a valid "priorities" definition.
+
+```
+"priorities": {
+    "Tradition": 30,
+    "Liberty": 20,
+    "Honor": 10
+}
+```
+
 ## CityStateTypes.json
 
 [Link to original](https://github.com/yairm210/Unciv/blob/master/android/assets/jsons/Civ%20V%20-%20Gods%20%26%20Kings/CityStateTypes.json)
@@ -148,7 +180,7 @@ Each policy branch has the following structure:
 
 ### Branch priorities
 
-The "priorities" object defines the priority major civilizations' AI give to a policy branch. The AI chooses the policy branch with the highest number for their preferred victory type. If two or more candidate branches have the same priority, the AI chooses a random branch among the candidates.
+The "priorities" object defines the priority major civilizations' AI give to a policy branch. The AI chooses the policy branch with the highest sum of the peferred victory type listed here and the number flisted in the personality's priority. If two or more candidate branches have the same priority, the AI chooses a random branch among the candidates.
 
 The object maps victory types to priority values for the major civilization using strings and integers. If the preferred victory type is not specified, the default priority value is set to 0.