Keyword Item Distributor (KID) Mod

SKSE plugin that distributes keywords to weapons/armor/magic effects/ingestibles and other items, using config files.

How To Use

Distributed records should be written to an ini file containing the suffix "_KID", in the Data folder (for example, MyMod_KID.ini).

They should follow this general format:

Keyword = formID~esp(OR)keywordEditorID|type|strings,formIDs(OR)editorIDs|traits|chance

Keyword

1. FormID is the formID of the keyword with leading zero digits removed (eg. 0x12345)
2. esp is the name of the mod containing the keyword (MyMod.esp). This is not necessary for Skyrim and DLC records.

1. Keyword EditorID is the name of the keyword. If the keyword name cannot be found, the mod will dynamically generate the keyword for you, which can be checked in game using SKSE's GetKeywordString function

Type

The type of item you want the keyword to be added to.

Weapon

Armor

Ammo

Magic Effect

Potion

Scroll

Location

Ingredient

Book

Misc Item

Key

Soul Gem

Spell

Activator

Flora

Furniture

Race

Talking Activator

Enchantment

Filtering

Filters are for distributing to only specific groups of items.

NOTE: Combining multiple filters will progressively restrict the pool of items that can be distributed to.

Distribute the same keyword multiple times to add it to different types of items

Strings

Item names (eg. Iron Sword)

Effect archetypes (Magic Effects, Spells, Enchantments, Scrolls, Potions)

Actor Values (Books, Magic Effects, Spells, Enchantments, Scrolls, Potions, Weapons)

Nif path (string must end with ".nif". Does not work for armors)

(eg. weapons/MyIronSword.nif)

List of archetypes

FormIDs/EditorIDs

To match specific items in a mod :

using formIDs : (0x1234~MyAwesomeSword.esp, 0x4567~MyAwesomeArmor.esp)

using editorIDs : (MyAwesomeSwordID, MyAwesomeArmorID)

To get all items in a mod : (MyAwesomeSwords.esp,MyAwesomeArmors.esp)

List of item specific filters

Pattern Matching

Requirements [strings, formIDs] : require items to have all keywords, using + (eg. ArmorTypeHeavy+ArmorTypeGauntlet to get all heavy gauntlets).

Exclusions [strings, formIDs] : exclude items that have name/keyword/form, using - (eg. -Wooden Sword to exclude all wooden swords).

Wildcards [strings] : get all items that have name or keyword containing wildcard, using * (eg. *Iron to get Iron Sword/Iron Bow/Iron Cuirass).

Matches [strings, formIDs] : default setting. Item must match with any of the listed strings or formIDs. This is equivalent to OR.

These are evaluated in the following order :

1.Requirements

2.Exclusions

3.Matches

3.Wildcards

Multiple entries should be separated using a comma. You can mix and match both string and form filters together.

Traits

Item specific filters you can use to narrow down items further. Negative pattern matching can be used with single letter traits (eg. -H to get all non-hostile magic effects, -E to get non-enchanted items)

Chance

Percentage chance that keywords will be added to items. Chance is fixed and does not change across game sessions (ie. it will either be distributed or not).

Value is from 0.0 -100.0, default chance is 100 if left blank or NONE.

Examples

;add MysticismSpells keyword to all magic effects in Mysticism

Keyword = MysticismSpells|Magic Effect|MysticismMagic.esp

;add NoviceDestruction keyword to all matching magic effects

Keyword = NoviceDestruction|Magic Effect|NONE|20(0/25)

;add poisonous food keyword to all poisonous foods

Keyword = PoisonousFood|Potion|NONE|P,F

;add keyword to all non-enchanted heavy gauntlets (armor having both ArmorHeavy and ArmorGauntlet keywords)

Keyword = 0x1234~MyArmorMod.esp|Armor|ArmorHeavy+ArmorGauntlet|-E

;Add keyword using name, to all bound arrows

Keyword = MysticalAmmo|Ammo|*Bound

;Add sun damage keyword to magic effects with sun hit art

Keyword = MagicDamageSun|Magic Effect|0x02019C9D,0x0200A3BB,0x0200A3BC

;Add spell tome destruction keyword to all books that teach destruction spells

Keyword = SpellTomeDestruction|Book|NONE|S,20

;alternate method

Keyword = SpellTomeDestruction|Book|Destruction|S

;Add MagicAbsorb keyword to all magic effects with Absorb effect archetype

Keyword = MagicAbsorb|Magic Effect|Absorb

;Add steel mace keyword to all weapons with this model path

Keyword = SteelMace|Weapon|*steelmace.nif

Notes

Check po3_KeywordItemDistributor.log in My Games/Skyrim Special Edition/SKSE, for more information about the process.

Credits

Source

1. Ryan (SniffleMan) for CommonLibSSE