Religions modding
Please help with verifying or updating older sections of this article.
At least some were last verified for version 1.0.
New religions can easily be added into the game using the highly modular design which the game offers.
Содержание
Religion family [ править | править код ]
Each religion belongs to a family. The three vanilla families are Abrahamic, Eastern and Pagan. For instance:
- Christianity and Islam are part of the Abrahamic Family
- Slavism and Tengrism are part of the Pagan Family
Religion families are located in /common/religion/religion_families. The religion family is defined as a tag with an alphanumerical ID. For example, the Abrahamic family is defined as follows:
Below is a list of all parameters that can be set for religion families.
| Attribute | Type | Description | Example |
|---|---|---|---|
| name | localization key | If not set will use the object key as localization key | name = name_of_the_family |
| is_pagan | boolean | Specifies if the group is pagan or not (default value is yes) | is_pagan = no |
| graphical_faith | gfx | All religions in this family default to this 3D model (currently used for temple assets). Order of precedence is the lowest level scripted in: faith > religion > family. | graphical_faith = catholic_gfx |
| piety_icon_group | gfx | All religions in this family default to this set of piety icons. Order of precedence is the lowest level scripted in: faith > religion > family. | piety_icon_group = christian |
| doctrine_background_icon | gfx | All religions in this family default to this doctrine background icon. Order of precedence is the lowest level scripted in: faith > religion > family. | doctrine_background_icon = core_tenet_banner_christian.dds |
| hostility_doctrine | doctrine | INTERFACE ONLY: Use this doctrine when displaying hostility information for the whole religious family (if not scripted, then show no information) | hostility_doctrine = christian_hostility_doctrine |
Religion structure [ править | править код ]
Religions are located in the /common/religion/religions folder. Each religion is defined within a file, and the faiths that belong to it are defined within that definition. The religion is defined as a tag with an alphanumerical ID. Here is an example of a fictional religion (localization and faiths are addressed below):
Below is a list of all parameters that can be set for religions.
| Attribute | Type | Description | Example |
|---|---|---|---|
| family | religion family | What religion family the religion belongs to | family = family_name |
| graphical_faith | gfx | All faiths in this religion default to this 3D model (currently used for temple assets). Order of precedence is the lowest level scripted in: faith > religion > family. | graphical_faith = catholic_gfx |
| piety_icon_group | gfx | All faiths in this religion default to this set of piety icons. Order of precedence is the lowest level scripted in: faith > religion > family. | piety_icon_group = christian |
| doctrine_background_icon | image file | All faiths in this religion default to this doctrine background icon. Order of precedence is the lowest level scripted in: faith > religion > family. | doctrine_background_icon = core_tenet_banner_christian.dds |
| pagan_roots | boolean | If yes, then faiths without the unreformed doctrine are considered reformed by the interface. | pagan_roots = yes |
| doctrine | doctrine | Doctrines defined in a religion will be applied to all faiths within it. This is only at game start; it is purely for script convenience, and would be equivalent to putting the doctrine in all the faiths. It can be overridden by putting a different doctrine in the group in the specific faith. Note that doctrines that allow more than one pick can not be defined on a religion level, as there’s no obvious override system that would work then. Doctrines cannot be defined after the faiths section. | doctrine = doctrine_spiritual_head |
| traits | clause | Defines which traits are considered virtues and sins by the religion. Notes on virtues and sins: List traits that are virtues for all followers. Trait groups also work. If more than one trait in a group is defined (or the group itself), only the first will be shown in the UI sins = < . ># (sins) # Virtues and sins give an opinion bonus/penalty (see VIRTUOUS_TRAIT and SINFUL_TRAIT defines). For that it is the «viewer’s» faith that matters. # E.g. if generous is a christian virtue, all christian characters will think more highly of all others with that trait, even if the others are not christian. # Holders of the traits will also get the virtue_owner_modifier/sin_owner_modifier for each matching trait. # Virtues and sins can optionally have a multiplier to scale the effects (default is 1): virtues = < brave = 0.5 ># scales both the opinion effect and the modifier # And they can specify a custom modifier (default is virtue_owner_modifier/sin_owner_modifier): sins = < stubborn = < monthly_prestige = -0.1 >> # When using a custom modifier you can specify a scale as well (default is 1): sins = < stubborn = < monthly_prestige = -0.1 scale = 2 >> # scales both the opinion effect and the modifier | virtues = < brave generous >sins = < stubborn = < monthly_prestige = -0.1 scale = 2 >> |
| reserved_male_names | list | Names listed here will be applied to all faiths that don’t define reserved_male_names themselves. These names can be applied to newborn males when selecting a religion-based name. | reserved_male_names = |
| reserved_female_names | list | Same as reserved_male_names, but applied to female characters instead. | |
| custom_faith_icons | list | When creating a custom faith, these will be the available icons. Path is «gfx/interface/icons/religion/%s.dds», where %s is the name. Also needs a text icon | custom_faith_icons = |
| localization | list | See localization inside faiths below. | |
| holy_order_names | list | Names and CoAs that can be used by holy orders of this religion. These are used if there are none available for the faith. If there are none left here, it uses «holy_order_default» as name and a randomly generated CoA instead. | |
| holy_order_maa | list | Men-At-Arms types mostly used for holy orders. The culture of the headquarters of the holy order must have unlocked the required innovation. (It will use the last available type in the list.) | holy_order_maa = |
| faiths | list | See below |
Faiths [ править | править код ]
Faiths are defined within the faith clause of a religion. They can overwrite default doctrines and graphics set for the whole religion. Here is an example of a fictional faith within the religion defined above.
Below is a list of all parameters that can be set for faiths.
| Attribute | Type | Description | Example |
|---|---|---|---|
| color | rgb | color = | |
| icon | gfx | If you want to use another faith’s icon | icon = bosnian_church |
| graphical_faith | gfx | This faith (and custom faiths based on this faith) use this 3D model (currently used for temple assets). Order of precedence is the lowest level scripted in: faith > religion > family. | graphical_faith = catholic_gfx |
| piety_icon_group | gfx | This faith (and custom faiths based on this faith) use this set of piety icons. Order of precedence is the lowest level scripted in: faith > religion > family. | piety_icon_group = christian |
| doctrine_background_icon | gfx | This faith (and custom faiths based on this faith) use this doctrine background icon. Order of precedence is the lowest level scripted in: faith > religion > family. | |
| religious_head | title | What title should be this faith’s religious head. If not set, will not have a religious head (unless created elsewhere in script) | religious_head = d_coptic_papacy |
| holy_site | holy site | Holy site, as defined in the holy_site folder. You can add any number of these | holy_site = jerusalem |
| doctrine | doctrine | ||
| reserved_male_names/reserved_female_names | list | ||
| localization |
Localization [ править | править код ]
The localization clause in both faiths and religions provides key-value pairs for localization. However, this clause does not include object localization for the religion/faith itself and its basic properties. The following localization keys also need defining:
Below is a list of keys that need to be paired for localization. Although you can use this as a reference, it is also possible to simply copy and paste this list from a vanilla file and add your own keys where needed. Although many items in the list are not relevant to many religions/faiths, they can simply be assigned to a key used by another more relevant item. (e.g. FertilityGodName in Christianity is given as «$christianity_high_god_name$» in the localization file):
- HighGodName
- HighGodNamePossessive
- HighGodNameSheHe
- HighGodHerselfHimself
- HighGodHerHis
- HighGodNameAlternate
- HighGodNameAlternatePossessive
- CreatorName
- CreatorNamePossessive
- CreatorSheHe
- CreatorHerHis
- CreatorHerHim
- HealthGodName
- HealthGodNamePossessive
- HealthGodSheHe
- HealthGodHerHis
- HealthGodHerHim
- FertilityGodName
- FertilityGodNamePossessive
- FertilityGodSheHe
- FertilityGodHerHis
- FertilityGodHerHim
- WealthGodName
- WealthGodNamePossessive
- WealthGodSheHe
- WealthGodHerHis
- WealthGodHerHim
- HouseholdGodName
- HouseholdGodNamePossessive
- HouseholdGodSheHe
- HouseholdGodHerHis
- HouseholdGodHerHim
- FateGodName
- FateGodNamePossessive
- FateGodSheHe
- FateGodHerHis
- FateGodHerHim
- KnowledgeGodName
- KnowledgeGodNamePossessive
- KnowledgeGodSheHe
- KnowledgeGodHerHis
- KnowledgeGodHerHim
- WarGodName
- WarGodNamePossessive
- WarGodSheHe
- WarGodHerHis
- WarGodHerHim
- TricksterGodName
- TricksterGodNamePossessive
- TricksterGodSheHe
- TricksterGodHerHis
- TricksterGodHerHim
- NightGodName
- NightGodNamePossessive
- NightGodSheHe
- NightGodHerHis
- NightGodHerHim
- WaterGodName
- WaterGodNamePossessive
- WaterGodSheHe
- WaterGodHerHis
- WaterGodHerHim
- PantheonTerm
- PantheonTermHasHave
- GoodGodNames (list)
- DevilName
- DevilNamePossessive
- DevilSheHe
- DevilHerHis
- DevilHerselfHimself
- EvilGodNames (list)
- HouseOfWorship
- HouseOfWorshipPlural
- ReligiousSymbol
- ReligiousText
- ReligiousHeadName
- ReligiousHeadTitleName
- DevoteeMale
- DevoteeMalePlural
- DevoteeFemalePlural
- DevoteeNeuter
- DevoteeNeuterPlural
- PriestMale
- PriestMalePlural
- PriestFemale
- PriestFemalePlural
- PriestNeuter
- PriestNeuterPlural
- AltPriestTermPlural
- BishopMale
- BishopMalePlural
- BishopFemale
- BishopFemalePlural
- BishopNeuter
- BishopNeuterPlural
- DivineRealm
- PositiveAfterLife
- NegativeAfterLife
- DeathDeityName
- DeathDeityNamePossessive
- DeathDeitySheHe
- DeathDeityHerHis
- WitchGodName
- WitchGodHerHis
- WitchGodSheHe
- WitchGodHerHim
- WitchGodMistressMaster
- WitchGodMotherFather
- GHWName
- GHWNamePlural
Graphics [ править | править код ]
No graphical modding is required to create a religion or faith, since there is an abundance of icons in the vanilla game, either in use by other religions or reserved for custom faiths. However, adding a new icon is very simple, if you feel that none of the vanilla icons are fitting for your religion. In the path /gfx/interface/icons/faith, create a new 100×100 dds file. The name of the file is how the icon is referred to in the religion file. (e.g. icon = lobbist will refer to /gfx/interface/icons/faith/lobbist.dds).
Holy sites [ править | править код ]
Custom holy sites can be added in a text document in the /common/religion/holy_sites folder. Each site is identified by a name, and contains information on the location of the site and the benefits (or potentially negatives) it brings.
Below are the attributes which can be assigned to a holy site. Only the county is necessary.
| Attribute | Type | Description | Example |
|---|---|---|---|
| county | title | The county in which the holy site is located | county = c_jerusalem |
| barony | title | The barony in which the holy site is located | barony = b_vaticano |
| character modifier | modifier | Applied to all characters of any faith with this holy site when the holder of the barony is of their faith | character_modifier = < |
| flag | flag | flag = jerusalem_conversion_bonus |
Holy sites also require the following keys in localization:
- holy_site_ _name
- holy_site_ _effect_name
- holy_site_ _effects
Tenet ID [ править | править код ]
Each tenet has an internal ID used to reference it within the game files. In general, to get the tenet ID from its name:
- Take the non-variant name (i.e. non-faith specific)
- Turn all upper case letters into lower case ( A. Z->a. z )
- Replace all spaces ( ) with underscores ( _ )
- Add tenet_ to the beginning
Tenets that do not fit the pattern above have been listed below:
Источник
