2025-11-25 04:04:29

src/common/doctrines/_documentation.md

@@ -0,0 +1,57 @@
+# Doctrines
+
+## Important concepts:
+
+* **Folder** - the category of doctrines, e.g. *land*, *air* or *naval*
+* **Grand Doctrine** - mutually exclusive root of the doctrine folder, unlocked with XP
+* **Track** - a slot for a subdoctrine and its rewards
+* **Milestone** - an additional reward for completing a track
+* **Subdoctrine** - can be slotted as the root of a specific track, unlocked with XP
+* **Mastery** - the progress made within a track
+* **Reward** - a reward for making gaining mastery within a track, belongs to a subdoctrine
+
+## Doctrine Effects
+
+* set_grand_doctrine
+* set_sub_doctrine
+* add_mastery
+* add_daily_mastery
+* add_mastery_bonus
+
+## Doctrine Triggers
+
+* has_completed_subdoctrine
+* has_doctrine
+* has_completed_track
+* has_subdoctrine_in_track
+* has_mastery
+* has_mastery_level
+
+## Doctrine Modifiers
+
+### Doctrine Cost modifiers
+
+* *[folder_name]*_doctrine_cost_factor
+```
+# Example:
+land_doctrine_cost_factor = -0.15 # 15% cost reduction to grand doctrines and subdoctrines in the land folder
+```
+### Mastery Gain modifiers
+
+Note: for these mastery gain modifiers, localization is automatically mapped, meaning you do not have to define unique localization keys for each generated modifier.
+
+* *[grand_doctrine_name]*_mastery_gain_factor
+```
+# Example:
+new_mobile_warfare_mastery_gain_factor = 0.15 # +15% mastery gain for all tracks which have Mobile Warfare as the grand doctrine
+```
+* *[subdoctrine_name]*_mastery_gain_factor
+```
+# Example:
+guerilla_war_mastery_gain_factor = 0.15 # +15% mastery gain for all tracks which have Guerilla Warfare as the subdoctrine
+```
+* *[track_name]*_track_mastery_gain_factor
+```
+# Example:
+infantry_track_mastery_gain_factor = 0.15 # +15% mastery gain for infantry tracks
+```