Refine Magic Material Data documentation for clarity and consistency

This commit is contained in:
2026-05-25 16:34:47 -04:00
parent 322575d913
commit d6048b4d55
+31 -11
View File
@@ -6,23 +6,43 @@ See Raw Data section.
# Enums
- MaterialCategory required: enum of Ore, Sunless Ore, Liquid, Plant, and Void Stone.
- MaterialCategory required: enum of `Ore`, `SunlessOre`, `Liquid`, `Plant`, and `VoidStone`.
- `MaterialCategory` is derived from the `Type` column.
# String
# Strings
- Name required: taken from text label in the Magic Material column
- `Name` required: taken from the Magic Material column.
- `Description` optional: flavour text or inferred description for the material.
- `GlobalBonus` optional: raw text from the Global bonus column.
- `InfusionEffects1` optional: raw effect text from the Requires 1 column.
- `InfusionEffects2` optional: raw effect text from the Requires 2 column.
- `InfusionEffects3` optional: raw effect text from the Requires 3 column.
# Ints
# Int
- `IncreaseProduction?`: Annex resources production bonus.
- `IncreaseMana?`: Annex resources mana bonus.
- `IncreaseDraft?`: Annex resources draft bonus.
- `IncreaseKnowledge?`: Annex resources knowledge bonus.
- `IncreaseFood?`: Annex resources food bonus.
- `IncreaseStability?`: Annex resources stability bonus.
- `IncreaseImperium?`: Annex resources imperium bonus.
- `IncreaseAllegianceFromWhisperingStones?`: Annex resources allegiance bonus.
- `IncreaseRelationWithFreeCitiesAndRulers?`: Annex resources Relations with Free Cities and Rulers bonus.
- `IncreaseCombatCastingPoints?`: combat casting points bonus from the data.
- `IncreaseWorldCastingPoints?`: world map casting points bonus from the data.
- `IncreaseHPRegen?`: HP regeneration bonus from the data.
- `IncreaseHitPoints?`: direct hit point bonus from the data.
- `IncreaseExperiencePercent?`: experience gain bonus from the data.
- `IncreaseAllegianceFromUmbralDwellings?`: Annex resources allegiance bonus.
- `DecreaseDraftCostPercent?`: draft cost reduction percentage from the data.
- `DecreaseRecruitmentCostPercent?`: recruitment cost reduction percentage from the data.
- `DecreaseKnowledgeResearchCostPercent?`: knowledge research cost reduction percentage from the data.
- `DecreaseTurnsTakenToFoundAbsorbMigrateCities?`: turns to found, absorb or migrate cities reduction from the data.
- IncreaseProduction?:
- IncreaseMana?:
- IncreaseDraft?:
- IncreaseKnowledge?:
- IncreaseFood?:
- IncreaseStability?:
-
# Notes
- The `Annex resources` column is the primary source for numeric resource increases.
---