Wildermyth Wiki - User contributions [en]

Image layers

2025-06-02T13:50:23Z

Ironskink: Moves `expandFaceToExpressions` example to correct subsection

Image layers are used by [[Theme|themes]], [[Modding_add_equipment|equipment]] and even regular [[Aspect|aspects]] to affect the appearance of a character. Characters in Wildermyth are created by layering a number of .png files overtop each other based on their "depth" value, with higher values appearing overtop lower values in their group.

Images are clumped into five groups: the main body, the head, the main/equipped weapon, the inactive/stowed weapon, and the offhand weapon/item. Regardless of depth values, image layers within the head group or an item will all be "flat" with respect to the body layers. An axe that uses two layers can have depth values of 1 and 2 and it will always be drawn in front of the body & armour layers when equipped and behind the torso when inactive.

''Note: In most game files, image layers are grouped under a heading called '''"layers"''', while in aspect files they are called '''"skinLayers"'''. This guide applies regardless of which of these headings is used.''

== Default Layer Depths ==

{| class="wikitable"
|+ Layer depths used by the base game
! Layer Depth !! Used for !! Notes
|-
| 10-11 || Cloak Backs ||
|-
| 55-58 || Wings || Includes [[Crowtouched|Crow Wings]], [[Hawksoul|Hawk Wings]], [[Mothly|Moth Wings]], [[Drauven Wings]] and [[Teeny Wings]]
|-
| 70 || Shoulder Pets || Includes [[Drauven Bird]] and [[Netherowl]]
|-
| 100-103 || Tails ||
|-
| 1000 || '''Human Torso''' || Hard-coded, not visible in game files
|-
| 1001-1003 || Bear (Tattoo) Arms, Tree (Willow) Arms ||
|-
| 1100 || '''Left & Right Human Legs''' || Hard-coded, not visible in game files
|-
| 1101-1106 || Theme Legs, some Theme Arms ||
|-
| 1150 || Bandaged & Prosthetic Legs ||
|-
| 1200 || '''Human Right & Left Arms, Human Upper Left Arm (2-handed pose)''' || Hard-coded, not visible in game files
|-
| 1200 || Most Spelltouched (Tattoo) Layers || Exceptions: Torso (1211), Lower 2-Handed Left Arm (3000)
|-
| 1201-1204 || Most Right & Left Theme Arms ||
|-
| 1211 || Spelltouched (Tattoo) Torso ||
|-
| 1212 || Morthagi Captain Torso || Not normally available to players
|-
| 1300 || Bandaged & Prosthetic Arms ||
|-
| 1500-1503 || [[Mortificial Enhancements|Mortificial]] Arms ||
|-
| 2000 || Foothill Neck Tattoos ||
|-
| 2000-2400 || Clothing/Armor || Excluding Clothing/Armor that covers the Lower Left Arm (2-Handed Pose). Some Warrior armor layers go as high as 2500.
|-
| 2490-2491 || Some Sash Augments ||
|-
| 2900-2901 || Belt Augments, Bracelet Augments (1-Handed Pose), Kneepad Augments ||
|-
| 2910 || Starheart Belt ||
|-
| 2940-2495 || Some Sash Augments ||
|-
| 2950-2955 || Some Cloak Augments (Front), Talisman Augments ||
|-
| 2970-2971 || Tortoiseshell Pendant ||
|-
| 3000 || '''Human Lower Left Arm (2-Handed Pose)''' || Hard-coded, not visible in game files
|-
| 3000 || Spelltouched Tattoos - Lower Left Arm (2-Handed Pose) ||
|-
| 3020-3499 || Clothing/Armor Layers, Lower Left Arm (2-Handed Pose) ||
|-
| 3550-3555 || Some Cloak Augments (Front) ||
|-
| 3560-3565 || Some Strap Augments, Some Scarf Augments ||
|-
| 3570-3575 || Necklace Augments ||
|-
| 3580-3582 || Pauldron Augments, Some Theme Arms || Includes [[Child of the Hills]], [[Elmsoul]] and [[Crystalline]]
|-
| 3590-3592 || Broach Augments ||
|-
| 3999 || Neck Theme Layers ||
|-
| 4000-4003 || Bracelet Augments ||
|-
| 4900 || '''Left Hand, Book Grip (Back)''' || Hard-coded, not visible in game files
|-
| 5000+ || '''Held Item (Offhand)''' || Hard-coded, not visible in game files. For multi-layer items, the default layer starts at 5000 and additional layers are added on top of that. For example, if an offhand item draws a shading layer at a depth of 1, when equipped in the off-hand the layer will have a value of 5001.
|-
| 6000 || '''Left Hand: Closed, Open, and Book (front) Grips''' || Hard-coded, not visible in game files
|-
| 6100-6103 || Shield Offhand Items ||
|-
| 7000 || '''Held Item (Main Hand)''' || Hard-coded, not visible in game files. For multi-layer items, the default layer starts at 5000 and additional layers are added on top of that. For example, if an offhand item draws a shading layer at a depth of 1, when equipped in the off-hand the layer will have a value of 7001.
|-
| 8000 || '''Right Hand: Closed, Open and Book Grips''' || Hard-coded, not visible in game files
|-
| 8100-8105 || Ring Augments ||
|}

== Modding Head Layers (Heads, Hair, Faces, Scars, etc.) ==

Head layers are used by the "peopleParts" files (to customize character appearance) and several aspects (such as the various scars).

Head layers are all drawn as a separate group from the body layers, so 'depth' values are only relative to other images being drawn on the head. The base game gives the various possible heads a depth value of 4000, so layers with a lower depth value will be drawn behind the head.

=== Layer Definition ===

Inside the peoplePart or aspect file, the layer definition will look something like this:

<pre>
"layers": [
{
"name": "hairFB3_behind",
"tint": "hair",
"bodyPart": "hair",
"depth": 3900,
"headOffset": true
},
{
"name": "hairFB3",
"tint": "hair",
"bodyPart": "hair",
"depth": 4200,
"rigMode": "femaleHead",
"headOffset": true
},
{
"name": "hairFB3M",
"tint": "hair",
"bodyPart": "hair",
"depth": 4200,
"rigMode": "maleHead",
"headOffset": true
},
{
"name": "hairFB3_streaks",
"tint": "streaks",
"bodyPart": "hair",
"depth": 4201,
"headOffset": true
}
]
</pre>

Some important fields:

* '''name''' ''(required)'': The name of the image to be used, not including the ''.png'' file extension.
* '''headOffset''' (required): Setting this to ''true'' is what defines this as a head layer.
* '''depth''' ''(recommended)'': Determines the order of drawing the images. High numbers go above lower numbers.
* '''tint''': Which of the character's ''tint'' colours to apply to this layer. Possible values are ''skin'', ''hair'', ''primary'', ''secondary'' and ''streaks''. (If omitted, no tint will be applied.)
* '''tintAmount''': How strongly the layer should be tinted on a scale from 0.0 (not at all) to 1.0 (full strength). (If omitted, any tint will be applied at full strength.)
* '''bodyPart''': If set, will only be drawn if the character has that body part and body part hasn't been transformed by a theme.
* '''rigMode''': If set, will only be drawn for the appropriate rig. Possible values are ''maleHead'' and ''femaleHead''
* '''ifOwnerHasPart''': If set, will only draw this layer if the character also has this other body part. (Often used to make beards fit exactly to faces.)
* '''expandFaceToExpressions''': If set and the keyword '''$face''' is used in the "name" value, the game will substitute '''$face''' for the character's current expression (Often used to make beards fit exactly to faces). For example, if you set the name to "customHead_$face_detail", the game will look for image files named ''customHead_happy_detail'', ''customHead_rage_detail, customHead_default_detail,'' etc. to match the layer to the expression being drawn.
* '''facialExpression''': An array of the facial expressions that this layer applies to. (Often used with theme heads to allow the same head to apply to multiple expressions)
* '''ifOwnerAspect''': Only draw this layer if the character also has some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifOwnerAspects''': Character must have ''all'' of these aspects in order for the layer to be drawn.
* '''ifNoOwnerAspect''': Only draw this layer if the character does '''not''' have some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifNoOwnerAspects''': Character must not have ''any'' of these aspects in order for the layer to be drawn.

=== File Names ===

If using '''expandFaceToExpressions''', you will need to provide separate images for all 17 facial expressions ("neutral", "interested", "grim", "sad", "skeptical", "dubious", "open", "surprised", "scared", "angry", "rage", "scheming", "hit", "dead", "happy", "joke" and "joy"). Otherwise, your file name will simply be the name that you specified plus a .png file extension.

=== Canvas Size ===

Head image layers are defined in a rig's associated skeleton file. All human heads are expected to be 192 x
256 pixels. Any images of different dimensions will be stretched or squashed to this size.

'''Known Exceptions:''' Custom rigs may specify custom dimensions for the head layer. See "Mods with Special Considerations" below for known cases where custom head sizes are being used.

=== Image Location ===

Your mod should place all images for these layers inside the '''assets/figures/images/human/misc''' folder of your mod. (The first time you add an image to your mod, you may need to create these folders.)

Any images that share the exact same name as images in the base game's '''assets/figures/images/human/misc''' or '''assets/figures/images/human/unpacked''' folder will overwrite the base game's version of the file.

== Modding Body Layers (Limbs, Augments, Armor, etc.) ==

Most of the layers that appear on your character are part of the body set. The body layer includes the torso, the character's limbs, [[Armor|armour]], [[Augment|augments]], shields, and all of the theme parts that can replace the torso or limbs.

Body layers are '''rig-specific''', meaning that the game will determine which image to use based on the character's rig. The base game has a total of 6 rigs: Male/Female body shapes for each of the three classes (Warrior/Hunter/Mystic), and modders can create their own custom rigs and apply them using the [[Modding alternate rigs|rigOverride]] aspect.

=== Layer Definition ===

Inside the aspect, theme or armour file, the definition of a layer for the body will look something like this:

<pre>
"layers": [
{
"name": "replaceArmL_wolfA_tint",
"tint": "hair",
"depth": 1201,
"ifNoOwnerAspect": "themeSkin_wolf*"
},
{
"name": "replaceArmL_wolfB_untinted",
"depth": 1202,
"ifNoOwnerAspect": "themeSkin_wolf*"
}
],
</pre>

Some important fields:

* '''name''' ''(required)'': The name of the image to be used. (Body layers are special - see below)
* '''depth''' ''(recommended)'': Determines the order of drawing the images. High numbers go above lower numbers. (See below for list of depths used by base-game assets)
* '''tint''': Which of the character's ''tint'' colours to apply to this layer. Possible values are ''skin'', ''hair'', ''primary'', ''secondary'' and ''streaks''. (If omitted, no tint will be applied.)
* '''tintAmount''': How strongly the layer should be tinted on a scale from 0.0 (not at all) to 1.0 (full strength). (If omitted, any tint will be applied at full strength.)
* '''ifOwnerAspect''': Only draw this layer if the character also has some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifOwnerAspects''': Character must have ''all'' of these aspects in order for the layer to be drawn.
* '''ifNoOwnerAspect''': Only draw this layer if the character does '''not''' have some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifNoOwnerAspects''': Character must not have ''any'' of these aspects in order for the layer to be drawn.
* '''rigMode''': If set, only draw this layer in the specified mode. Possible values are ''oneHanded'' and ''twoHanded''.
* '''ifRightHandGrasp''': If set, only draw this layer based on the right hand's grasp value. Possible values are ''open'', ''closed'' and ''book''.
* '''ifLeftHandGrasp''': If set, only draw this layer based on the left hand's grasp value. Possible values are ''open'', ''closed'' and ''book''.

It is possible to create some very complicated effects using the above fields, such as including multiple layers that are each tinted separately, allowing augments or alternate arms/hands to grasp weapons and items, and making layers depend on multiple aspects to have them show or hide automatically based on other factors.

=== File Names and Rigs ===

As mentioned above, body layers are generally '''rig-specific'''. This means that the file the game will look for when drawing the character will be a combination of the name of the rig and the '''name''' specified in your layer, in the form ''<rigName>_<layer name>.png''. For example, if you set the name field for your layer as ''myNewLayer'', a female warrior (which uses the rig ''warriorF'') would use the image file '''warriorF_myNewLayer.png''' while a male mystic (which uses the rig ''mysticM'') would use the image file '''mysticM_myNewLayer.png'''

For body layers, you must therefore provide separate images for each rig that you wish to support.

The six rigs used in the base game are:

* hunterF
* hunterM
* mysticF
* mysticM
* warriorF
* warriorM

It is possible for mods to define and use custom rigs in addition to the base-game rigs above. See "Mods with Special Considerations" below for more information.

=== Canvas Size ===

Body image layers are all expected to be 512 x 512 pixels. Any images of different dimensions will be stretched or squashed to this size.

=== Image Location ===

Your mod should place all images for these layers inside the '''assets/figures/images/human/misc''' folder of your mod. (The first time you add an image to your mod, you may need to create these folders.)

Any images that share the exact same name as images in the base game's '''assets/figures/images/human/misc''' or '''assets/figures/images/human/unpacked''' folder will overwrite the base game's version of the file.

== Modding Held Item Layers ==

Items are the things that can be held in the character's main or off hand and are sometimes stowed behind the character's back when inactive.

=== Layer Definition ===

Inside the item, the layer definition will look something like this:

<pre>
"layers": [
{
"name": "item_axe1Fang_t1A_tint1_50",
"tint": "primary",
"tintAmount": 0.5,
"scaleX": 0.5,
"scaleY": 0.5,
"rigUsage": "rigGeneral",
"grip": "mainHand",
"inactiveGrip": "highBack",
"gripOffset": { "x": 114, "y": 210 }
},
{
"name": "item_axe1Fang_t1B_untinted",
"scaleX": 0.5,
"scaleY": 0.5,
"rigUsage": "rigGeneral",
"grip": "mainHand",
"inactiveGrip": "highBack",
"gripOffset": { "x": 114, "y": 210 }
}
]
</pre>

Some important fields:

* '''name''' ''(required)'': The name of the image to be used. (The game seems to like item images to be prefixed with '''item_''')
* '''depth''' ''(recommended)'': Determines the order of drawing the images. High numbers go above lower numbers.
* '''rigUsage''' ''(recommended)'': Setting this to '''rigGeneral''' means this layer will always be drawn regardless of the rig used by the character.
* '''gripOffset''' ''(recommended)'': Specifies the anchor point where a character will hold this item.
* '''grip''' ''(recommended)'': Which hand a character uses to hold this. Possible values are "mainHand" and "offHand".
* '''inactiveGrip''' ''(recommended for weapons)'': Where to stow this item when inactive. Possible values are "highBack" "midBack" "lowBack" and "hide".
* '''grasp''': How the item is held. Defaults to "closed". Can be set to "book" or "open".
* '''scaleX''': Scaling multiplier to size the item appropriately to the character.
* '''scaleY''': Scaling multiplier to size the item appropriately to the character.
* '''rotation''': Rotates the item.
* '''tint''': Which of the character's ''tint'' colours to apply to this layer. Possible values are ''skin'', ''hair'', ''primary'', ''secondary'' and ''streaks''. (If omitted, no tint will be applied.)
* '''tintAmount''': How strongly the layer should be tinted on a scale from 0.0 (not at all) to 1.0 (full strength). (If omitted, any tint will be applied at full strength.)

=== Canvas Size ===

Item image layers can be any size. Use the ''scaleX'' and ''scaleY'' properties in the layer definition to ensure the item is sized appropriately for the character.

=== Image Location ===

Your mod should place all images for these layers inside the '''assets/figures/images/human/items''' folder of your mod. (The first time you add an image to your mod, you may need to create these folders.)

Any images that share the exact same name as images in the base game's '''assets/figures/images/human/items''' folder will overwrite the base game's version of the file.

== Mods with Special Considerations ==

The following mods use custom setups in some way.

=== [https://steamcommunity.com/sharedfiles/filedetails/?id=2810606541 Drauven PCs] ===
'''Author:''' Drauven Mod Squad (Lead: David Bilsky, AKA Ironskink/BoldestDungeon)

'''Website:''' [https://github.com/BoldestDungeon/wildermyth-drauven-pcs Project Page on GitHub]

'''Primary Contact:''' [https://discord.gg/uftGyUa8GS Dedicated Discord server]

==== New Rigs ====
* DrauvenHunter
* DrauvenMystic
* DrauvenWarrior
* Drauven

'''Notes: '''

The Warrior, Hunter and Mystic rigs are based on the Stump, Haunt and Deeven models, respectively. Raw .psd files for the rigs at the project's public [https://github.com/BoldestDungeon/wildermyth-drauven-pcs/tree/develop/assets/figures/source GitHub] page. The plain ''Drauven'' rig is used for farmers and is an exact copy of the Warrior (Stump) rig.

The Drauven rigs use a larger canvas size for the head layers than the normal human rigs do (256 x 384 px) to better fit all the various head ornamentations that the Drauven have.

=== [https://steamcommunity.com/sharedfiles/filedetails/?id=2978516419 Return of the Centauri]===
'''Author:''' Pinhat

==== New Rigs ====
* centaurWarriorM
* centaurWarriorF
* centaurHunterM
* centaurHunterF
* centaurMysticM
* centaurMysticF

'''Notes:'''

The centaur rig essentially shifts all of the upper-body assets up and to the right to make room for the centaur's lower body. The upper human body is unchanged except for the position.

[[Category:Modding]]

Image layers

2025-06-02T13:34:53Z

Ironskink: Added entry for `expandFaceToExpressions`

Image layers are used by [[Theme|themes]], [[Modding_add_equipment|equipment]] and even regular [[Aspect|aspects]] to affect the appearance of a character. Characters in Wildermyth are created by layering a number of .png files overtop each other based on their "depth" value, with higher values appearing overtop lower values in their group.

Images are clumped into five groups: the main body, the head, the main/equipped weapon, the inactive/stowed weapon, and the offhand weapon/item. Regardless of depth values, image layers within the head group or an item will all be "flat" with respect to the body layers. An axe that uses two layers can have depth values of 1 and 2 and it will always be drawn in front of the body & armour layers when equipped and behind the torso when inactive.

''Note: In most game files, image layers are grouped under a heading called '''"layers"''', while in aspect files they are called '''"skinLayers"'''. This guide applies regardless of which of these headings is used.''

== Default Layer Depths ==

{| class="wikitable"
|+ Layer depths used by the base game
! Layer Depth !! Used for !! Notes
|-
| 10-11 || Cloak Backs ||
|-
| 55-58 || Wings || Includes [[Crowtouched|Crow Wings]], [[Hawksoul|Hawk Wings]], [[Mothly|Moth Wings]], [[Drauven Wings]] and [[Teeny Wings]]
|-
| 70 || Shoulder Pets || Includes [[Drauven Bird]] and [[Netherowl]]
|-
| 100-103 || Tails ||
|-
| 1000 || '''Human Torso''' || Hard-coded, not visible in game files
|-
| 1001-1003 || Bear (Tattoo) Arms, Tree (Willow) Arms ||
|-
| 1100 || '''Left & Right Human Legs''' || Hard-coded, not visible in game files
|-
| 1101-1106 || Theme Legs, some Theme Arms ||
|-
| 1150 || Bandaged & Prosthetic Legs ||
|-
| 1200 || '''Human Right & Left Arms, Human Upper Left Arm (2-handed pose)''' || Hard-coded, not visible in game files
|-
| 1200 || Most Spelltouched (Tattoo) Layers || Exceptions: Torso (1211), Lower 2-Handed Left Arm (3000)
|-
| 1201-1204 || Most Right & Left Theme Arms ||
|-
| 1211 || Spelltouched (Tattoo) Torso ||
|-
| 1212 || Morthagi Captain Torso || Not normally available to players
|-
| 1300 || Bandaged & Prosthetic Arms ||
|-
| 1500-1503 || [[Mortificial Enhancements|Mortificial]] Arms ||
|-
| 2000 || Foothill Neck Tattoos ||
|-
| 2000-2400 || Clothing/Armor || Excluding Clothing/Armor that covers the Lower Left Arm (2-Handed Pose). Some Warrior armor layers go as high as 2500.
|-
| 2490-2491 || Some Sash Augments ||
|-
| 2900-2901 || Belt Augments, Bracelet Augments (1-Handed Pose), Kneepad Augments ||
|-
| 2910 || Starheart Belt ||
|-
| 2940-2495 || Some Sash Augments ||
|-
| 2950-2955 || Some Cloak Augments (Front), Talisman Augments ||
|-
| 2970-2971 || Tortoiseshell Pendant ||
|-
| 3000 || '''Human Lower Left Arm (2-Handed Pose)''' || Hard-coded, not visible in game files
|-
| 3000 || Spelltouched Tattoos - Lower Left Arm (2-Handed Pose) ||
|-
| 3020-3499 || Clothing/Armor Layers, Lower Left Arm (2-Handed Pose) ||
|-
| 3550-3555 || Some Cloak Augments (Front) ||
|-
| 3560-3565 || Some Strap Augments, Some Scarf Augments ||
|-
| 3570-3575 || Necklace Augments ||
|-
| 3580-3582 || Pauldron Augments, Some Theme Arms || Includes [[Child of the Hills]], [[Elmsoul]] and [[Crystalline]]
|-
| 3590-3592 || Broach Augments ||
|-
| 3999 || Neck Theme Layers ||
|-
| 4000-4003 || Bracelet Augments ||
|-
| 4900 || '''Left Hand, Book Grip (Back)''' || Hard-coded, not visible in game files
|-
| 5000+ || '''Held Item (Offhand)''' || Hard-coded, not visible in game files. For multi-layer items, the default layer starts at 5000 and additional layers are added on top of that. For example, if an offhand item draws a shading layer at a depth of 1, when equipped in the off-hand the layer will have a value of 5001.
|-
| 6000 || '''Left Hand: Closed, Open, and Book (front) Grips''' || Hard-coded, not visible in game files
|-
| 6100-6103 || Shield Offhand Items ||
|-
| 7000 || '''Held Item (Main Hand)''' || Hard-coded, not visible in game files. For multi-layer items, the default layer starts at 5000 and additional layers are added on top of that. For example, if an offhand item draws a shading layer at a depth of 1, when equipped in the off-hand the layer will have a value of 7001.
|-
| 8000 || '''Right Hand: Closed, Open and Book Grips''' || Hard-coded, not visible in game files
|-
| 8100-8105 || Ring Augments ||
|}

== Modding Head Layers (Heads, Hair, Faces, Scars, etc.) ==

Head layers are used by the "peopleParts" files (to customize character appearance) and several aspects (such as the various scars).

Head layers are all drawn as a separate group from the body layers, so 'depth' values are only relative to other images being drawn on the head. The base game gives the various possible heads a depth value of 4000, so layers with a lower depth value will be drawn behind the head.

=== Layer Definition ===

Inside the peoplePart or aspect file, the layer definition will look something like this:

<pre>
"layers": [
{
"name": "hairFB3_behind",
"tint": "hair",
"bodyPart": "hair",
"depth": 3900,
"headOffset": true
},
{
"name": "hairFB3",
"tint": "hair",
"bodyPart": "hair",
"depth": 4200,
"rigMode": "femaleHead",
"headOffset": true
},
{
"name": "hairFB3M",
"tint": "hair",
"bodyPart": "hair",
"depth": 4200,
"rigMode": "maleHead",
"headOffset": true
},
{
"name": "hairFB3_streaks",
"tint": "streaks",
"bodyPart": "hair",
"depth": 4201,
"headOffset": true
}
]
</pre>

Some important fields:

* '''name''' ''(required)'': The name of the image to be used, not including the ''.png'' file extension.
* '''headOffset''' (required): Setting this to ''true'' is what defines this as a head layer.
* '''depth''' ''(recommended)'': Determines the order of drawing the images. High numbers go above lower numbers.
* '''tint''': Which of the character's ''tint'' colours to apply to this layer. Possible values are ''skin'', ''hair'', ''primary'', ''secondary'' and ''streaks''. (If omitted, no tint will be applied.)
* '''tintAmount''': How strongly the layer should be tinted on a scale from 0.0 (not at all) to 1.0 (full strength). (If omitted, any tint will be applied at full strength.)
* '''bodyPart''': If set, will only be drawn if the character has that body part and body part hasn't been transformed by a theme.
* '''rigMode''': If set, will only be drawn for the appropriate rig. Possible values are ''maleHead'' and ''femaleHead''
* '''ifOwnerHasPart''': If set, will only draw this layer if the character also has this other body part. (Often used to make beards fit exactly to faces.)
* '''expandFaceToExpressions''': If set and the keyword '''$face''' is used in the "name" value, the game will substitute '''$face''' for the character's current expression (Often used to make beards fit exactly to faces)
* '''facialExpression''': An array of the facial expressions that this layer applies to. (Often used with theme heads to allow the same head to apply to multiple expressions)
* '''ifOwnerAspect''': Only draw this layer if the character also has some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifOwnerAspects''': Character must have ''all'' of these aspects in order for the layer to be drawn.
* '''ifNoOwnerAspect''': Only draw this layer if the character does '''not''' have some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifNoOwnerAspects''': Character must not have ''any'' of these aspects in order for the layer to be drawn.

=== File Names ===

If using '''expandFaceToExpressions''', you will need to provide separate images for all 17 facial expressions ("neutral", "interested", "grim", "sad", "skeptical", "dubious", "open", "surprised", "scared", "angry", "rage", "scheming", "hit", "dead", "happy", "joke" and "joy"). Otherwise, your file name will simply be the name that you specified plus a .png file extension.

=== Canvas Size ===

Head image layers are defined in a rig's associated skeleton file. All human heads are expected to be 192 x
256 pixels. Any images of different dimensions will be stretched or squashed to this size.

'''Known Exceptions:''' Custom rigs may specify custom dimensions for the head layer. See "Mods with Special Considerations" below for known cases where custom head sizes are being used.

=== Image Location ===

Your mod should place all images for these layers inside the '''assets/figures/images/human/misc''' folder of your mod. (The first time you add an image to your mod, you may need to create these folders.)

Any images that share the exact same name as images in the base game's '''assets/figures/images/human/misc''' or '''assets/figures/images/human/unpacked''' folder will overwrite the base game's version of the file.

== Modding Body Layers (Limbs, Augments, Armor, etc.) ==

Most of the layers that appear on your character are part of the body set. The body layer includes the torso, the character's limbs, [[Armor|armour]], [[Augment|augments]], shields, and all of the theme parts that can replace the torso or limbs.

Body layers are '''rig-specific''', meaning that the game will determine which image to use based on the character's rig. The base game has a total of 6 rigs: Male/Female body shapes for each of the three classes (Warrior/Hunter/Mystic), and modders can create their own custom rigs and apply them using the [[Modding alternate rigs|rigOverride]] aspect.

=== Layer Definition ===

Inside the aspect, theme or armour file, the definition of a layer for the body will look something like this:

<pre>
"layers": [
{
"name": "replaceArmL_wolfA_tint",
"tint": "hair",
"depth": 1201,
"ifNoOwnerAspect": "themeSkin_wolf*"
},
{
"name": "replaceArmL_wolfB_untinted",
"depth": 1202,
"ifNoOwnerAspect": "themeSkin_wolf*"
}
],
</pre>

Some important fields:

* '''name''' ''(required)'': The name of the image to be used. (Body layers are special - see below)
* '''depth''' ''(recommended)'': Determines the order of drawing the images. High numbers go above lower numbers. (See below for list of depths used by base-game assets)
* '''tint''': Which of the character's ''tint'' colours to apply to this layer. Possible values are ''skin'', ''hair'', ''primary'', ''secondary'' and ''streaks''. (If omitted, no tint will be applied.)
* '''tintAmount''': How strongly the layer should be tinted on a scale from 0.0 (not at all) to 1.0 (full strength). (If omitted, any tint will be applied at full strength.)
* '''ifOwnerAspect''': Only draw this layer if the character also has some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifOwnerAspects''': Character must have ''all'' of these aspects in order for the layer to be drawn.
* '''ifNoOwnerAspect''': Only draw this layer if the character does '''not''' have some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifNoOwnerAspects''': Character must not have ''any'' of these aspects in order for the layer to be drawn.
* '''rigMode''': If set, only draw this layer in the specified mode. Possible values are ''oneHanded'' and ''twoHanded''.
* '''ifRightHandGrasp''': If set, only draw this layer based on the right hand's grasp value. Possible values are ''open'', ''closed'' and ''book''.
* '''ifLeftHandGrasp''': If set, only draw this layer based on the left hand's grasp value. Possible values are ''open'', ''closed'' and ''book''.

It is possible to create some very complicated effects using the above fields, such as including multiple layers that are each tinted separately, allowing augments or alternate arms/hands to grasp weapons and items, and making layers depend on multiple aspects to have them show or hide automatically based on other factors.

=== File Names and Rigs ===

As mentioned above, body layers are generally '''rig-specific'''. This means that the file the game will look for when drawing the character will be a combination of the name of the rig and the '''name''' specified in your layer, in the form ''<rigName>_<layer name>.png''. For example, if you set the name field for your layer as ''myNewLayer'', a female warrior (which uses the rig ''warriorF'') would use the image file '''warriorF_myNewLayer.png''' while a male mystic (which uses the rig ''mysticM'') would use the image file '''mysticM_myNewLayer.png'''

For body layers, you must therefore provide separate images for each rig that you wish to support.

The six rigs used in the base game are:

* hunterF
* hunterM
* mysticF
* mysticM
* warriorF
* warriorM

It is possible for mods to define and use custom rigs in addition to the base-game rigs above. See "Mods with Special Considerations" below for more information.

=== Canvas Size ===

Body image layers are all expected to be 512 x 512 pixels. Any images of different dimensions will be stretched or squashed to this size.

=== Image Location ===

Your mod should place all images for these layers inside the '''assets/figures/images/human/misc''' folder of your mod. (The first time you add an image to your mod, you may need to create these folders.)

Any images that share the exact same name as images in the base game's '''assets/figures/images/human/misc''' or '''assets/figures/images/human/unpacked''' folder will overwrite the base game's version of the file.

== Modding Held Item Layers ==

Items are the things that can be held in the character's main or off hand and are sometimes stowed behind the character's back when inactive.

=== Layer Definition ===

Inside the item, the layer definition will look something like this:

<pre>
"layers": [
{
"name": "item_axe1Fang_t1A_tint1_50",
"tint": "primary",
"tintAmount": 0.5,
"scaleX": 0.5,
"scaleY": 0.5,
"rigUsage": "rigGeneral",
"grip": "mainHand",
"inactiveGrip": "highBack",
"gripOffset": { "x": 114, "y": 210 }
},
{
"name": "item_axe1Fang_t1B_untinted",
"scaleX": 0.5,
"scaleY": 0.5,
"rigUsage": "rigGeneral",
"grip": "mainHand",
"inactiveGrip": "highBack",
"gripOffset": { "x": 114, "y": 210 }
}
]
</pre>

Some important fields:

* '''name''' ''(required)'': The name of the image to be used. (The game seems to like item images to be prefixed with '''item_''')
* '''depth''' ''(recommended)'': Determines the order of drawing the images. High numbers go above lower numbers.
* '''rigUsage''' ''(recommended)'': Setting this to '''rigGeneral''' means this layer will always be drawn regardless of the rig used by the character.
* '''gripOffset''' ''(recommended)'': Specifies the anchor point where a character will hold this item.
* '''grip''' ''(recommended)'': Which hand a character uses to hold this. Possible values are "mainHand" and "offHand".
* '''inactiveGrip''' ''(recommended for weapons)'': Where to stow this item when inactive. Possible values are "highBack" "midBack" "lowBack" and "hide".
* '''grasp''': How the item is held. Defaults to "closed". Can be set to "book" or "open".
* '''scaleX''': Scaling multiplier to size the item appropriately to the character.
* '''scaleY''': Scaling multiplier to size the item appropriately to the character.
* '''rotation''': Rotates the item.
* '''tint''': Which of the character's ''tint'' colours to apply to this layer. Possible values are ''skin'', ''hair'', ''primary'', ''secondary'' and ''streaks''. (If omitted, no tint will be applied.)
* '''tintAmount''': How strongly the layer should be tinted on a scale from 0.0 (not at all) to 1.0 (full strength). (If omitted, any tint will be applied at full strength.)
*'''expandFaceToExpressions:''' When set to '''true''', you can add '''$face''' to the "name" field and have the game use that to find image files for all of the different facial expressions. For example, if you set the name to "customHead_$face_detail", the game will look for image files named ''customHead_happy_detail'', ''customHead_rage_detail, customHead_default_detail,'' etc. to match the layer to the expression being drawn.

=== Canvas Size ===

Item image layers can be any size. Use the ''scaleX'' and ''scaleY'' properties in the layer definition to ensure the item is sized appropriately for the character.

=== Image Location ===

Your mod should place all images for these layers inside the '''assets/figures/images/human/items''' folder of your mod. (The first time you add an image to your mod, you may need to create these folders.)

Any images that share the exact same name as images in the base game's '''assets/figures/images/human/items''' folder will overwrite the base game's version of the file.

== Mods with Special Considerations ==

The following mods use custom setups in some way.

=== [https://steamcommunity.com/sharedfiles/filedetails/?id=2810606541 Drauven PCs] ===
'''Author:''' Drauven Mod Squad (Lead: David Bilsky, AKA Ironskink/BoldestDungeon)

'''Website:''' [https://github.com/BoldestDungeon/wildermyth-drauven-pcs Project Page on GitHub]

'''Primary Contact:''' [https://discord.gg/uftGyUa8GS Dedicated Discord server]

==== New Rigs ====
* DrauvenHunter
* DrauvenMystic
* DrauvenWarrior
* Drauven

'''Notes: '''

The Warrior, Hunter and Mystic rigs are based on the Stump, Haunt and Deeven models, respectively. Raw .psd files for the rigs at the project's public [https://github.com/BoldestDungeon/wildermyth-drauven-pcs/tree/develop/assets/figures/source GitHub] page. The plain ''Drauven'' rig is used for farmers and is an exact copy of the Warrior (Stump) rig.

The Drauven rigs use a larger canvas size for the head layers than the normal human rigs do (256 x 384 px) to better fit all the various head ornamentations that the Drauven have.

=== [https://steamcommunity.com/sharedfiles/filedetails/?id=2978516419 Return of the Centauri]===
'''Author:''' Pinhat

==== New Rigs ====
* centaurWarriorM
* centaurWarriorF
* centaurHunterM
* centaurHunterF
* centaurMysticM
* centaurMysticF

'''Notes:'''

The centaur rig essentially shifts all of the upper-body assets up and to the right to make room for the centaur's lower body. The upper human body is unchanged except for the position.

[[Category:Modding]]

Mod Injection

2024-09-25T02:02:20Z

Ironskink: Added categories

==What Are Mod Injections?==
For most content in Wildermyth, modding works by creating files at a parallel file structure to the main game within your mod folder, and the mod files either being added to or replacing existing files. (For example, mods/user/myCoolMod/assets/data/themes/wolf.json replacing the original assets/data/themes/wolf.json theme data)

However, sometimes we don't want to replace the whole file! Sometimes we just want to add or change a bit of data to an existing file. Take the "human" aspect, for example. If we want to give all humans a new ability, or change their base stats, we could do it by adding our own version of the assets/data/aspects/humans.json file. That's a pretty common thing that modders might want to do though, and if a player has multiple mods overriding that file, only the highest priority one will have an effect.

Mod Injection lets you make changes to existing json data without needing to overwrite the entire file. This allows multiple mods to edit the humans.json file without overriding each other. Or, if you want to make a change to a certain part of an existing campaign, now that can be done without needing to overwrite the entire campaign or make a separate campaign with that change.

== Mod Injection Data Structure ==
Details on the data for Mod Injections. Most of this is set automatically when creating a mod injection, so if you're just getting started, you may want to skip ahead to "Creating a Mod Injection".

=== Mod Injection Types ===

* '''object''': Complex data, like Outcomes, Targets, Plot Steps, etc
* '''string''': A text string, like "rangeFeedback" in a target's missionFeedback, or modifying a specific index of a string list (not usually recommended; using the remove and addStrings fields for an entire stringList is safer)
* '''expression''': An expression (like the "amount" in a Damage Outcome), or an integer or float (like the "encounterScore" of an effect)
* '''enumeration''': A dropdown value, like "role" in a target, or "type" in the Damage Outcome
* '''bool''': A true/false (boolean) value, like "invalidatesSkin" on an aspect
* '''stringList''': A list of Strings, like the "effects" list of an aspect, or the "addAspects" list of the Aspects Outcome
* '''objectList''': A list of complex objects, like the "outcomes" list of an effect, or the "particles" list of an AttackRoll Outcome
* '''objectMap''': A key/value object map, like the nodeTemplates in a dungeon (Omenroad) scenario
* '''expressionMap''': A key/value expression map, like the "stats" of an aspect or monster, or the "expressions" field in an effect

=== Mod Injection Fields ===

* '''jsonPath''': The json path we want to inject json at. Path uses slashes to indicate stepping into JsonValues with certain names, ids, or index. e.g. "extraRewardTemplates/standard/[0]/rewards". Regular strings will get a child with the given name, or with an "id" field that matches the string. A number within brackets will get a given index of an array.

* '''type''': The type of mod injection, so we can hide irrelevant fields (see list above)
* '''mapKey''': For a map entry, the key for the entry we want to create or replace
* '''addJson''': The json object we want to add. Used any time a more complex object (i.e. non-string and non-expression) is inserted or changed (Outcomes, Targets, Dungeon nodes, etc)
* '''listBehavior''': If this is at the index of a list (the jsonPath ends in "[x]"), the value can be replaced, or a new value can be inserted at this index
* '''bool''': True/False value
* '''string''': For a string or string map, the string value
* '''addStrings''': For a string array, the strings we want to add
* '''remove''': Removes the given strings or keys from the given array or map
* '''expression''': Expression to replace the existing expression at the given jsonPath, or to add/replace in combination with the mapKey
* '''enumeration''': Enum (dropdown) value

==Creating a Mod Injection==
Open the Mod Injections page by navigating to Tools > Open Editor > Content and Comics Editor, and then switching from the "comics" page to the "mod injections" page via the dropdown.

Here you'll see two buttons at the top:

* '''Mod Injection Editor Mode''': When Mod Injection Editor Mode is enabled, "Mod Injection" buttons will show up next to data lines that you can click to create new Mod Injections.
* '''Mod Injections''': Editor setting: When enabled, Mod Injections will be applied across the editor and in-game. When disabled, they'll be ignored, showing the original files instead. (Note that this setting applies in-game as well, so don't forget to turn this back on if you want to test your Mod Injections!)

Click the '''Mod Injection Editor Mode''' button, and now Mod Injection buttons will show up for most lines of the editor!

=== An Example: Changing Human Stats ===
Let's say we want to adjust humans to be a bit less squishy by default, give them a bit more health. Switch over to the aspects tab and view the aforementioned "human" aspect. If you hover over the "HEALTH" stat line, you'll see a "Mod Injection" button.

[[File:ModInjections human health.png|frameless|691x691px]]

Click the Mod Injection button, and a New Mod Injection dialog will pop up. Usually, you shouldn't change anything in this dialog, just go ahead and click Create.

[[File:ModInjections New Mod Injection Dialog human health.png|frameless|505x505px]]

Immediately after clicking Create, you should see the mod injection you've just created. You'll note there's an "expression: 5" line. You can change that to whatever you'd like the health to be!

[[File:ModInjections human health Mod Injection data.png|frameless|319x319px]]

Save the Mod Injection file, and you're done! Mod Injection files are stored in a parallel file structure to the files they modify, in '''[yourModName]/assets/data/modInjections'''. For example, the file I just created is stored at mods/user/MyCoolMod/assets/data/modInjections/aspects/humans.json.

For most Mod Injections, if you want to see the changes in context after creating one, you'll want to press the '''Refresh button''' in the top-right of the editor. This will cause all data and mods to reload, which will apply your mod injections to the data. (It will probably take a few seconds)

If you switch back over to the mod injections page, you can see all the mod injections you've created:

[[File:ModInjections editor page.png|frameless|681x681px]]

'''Mod Injections are stored per file''', so if you add more injections to the human aspect, or even to a different aspect in the aspect/humans.json file (e.g. if you made changes to the "farmer" or "humanFemale" aspects), these would all appear in the modInjections list when selecting aspects/humans on the left.

You can also see the Full Object listed on the right. This shows how the file will look with the mod injections applied. (Again, because mod injections are stored per file, when editing aspects you'll be shown a list of all the aspects in the file, which you can scroll through to find the ones you've modified) You can click the "Show Original" button to display what the base file looks like without any mod injections.

Note that by default, Mod Injections are shown throughout the editor. You can disable them by clicking the "Mod Injections" button in the top left (this will turn off mod injections across the entire game for this session, so be sure to turn it back on again if you want to test things later!)

[[Category:Modding]]
[[Category:Modding Guides]]

Image layers

2024-06-06T13:04:25Z

Ironskink:

Image layers are used by [[Theme|themes]], [[Modding_add_equipment|equipment]] and even regular [[Aspect|aspects]] to affect the appearance of a character. Characters in Wildermyth are created by layering a number of .png files overtop each other based on their "depth" value, with higher values appearing overtop lower values in their group.

Images are clumped into five groups: the main body, the head, the main/equipped weapon, the inactive/stowed weapon, and the offhand weapon/item. Regardless of depth values, image layers within the head group or an item will all be "flat" with respect to the body layers. An axe that uses two layers can have depth values of 1 and 2 and it will always be drawn in front of the body & armour layers when equipped and behind the torso when inactive.

''Note: In most game files, image layers are grouped under a heading called '''"layers"''', while in aspect files they are called '''"skinLayers"'''. This guide applies regardless of which of these headings is used.''

== Default Layer Depths ==

{| class="wikitable"
|+ Layer depths used by the base game
! Layer Depth !! Used for !! Notes
|-
| 10-11 || Cloak Backs ||
|-
| 55-58 || Wings || Includes [[Crowtouched|Crow Wings]], [[Hawksoul|Hawk Wings]], [[Mothly|Moth Wings]], [[Drauven Wings]] and [[Teeny Wings]]
|-
| 70 || Shoulder Pets || Includes [[Drauven Bird]] and [[Netherowl]]
|-
| 100-103 || Tails ||
|-
| 1000 || '''Human Torso''' || Hard-coded, not visible in game files
|-
| 1001-1003 || Bear (Tattoo) Arms, Tree (Willow) Arms ||
|-
| 1100 || '''Left & Right Human Legs''' || Hard-coded, not visible in game files
|-
| 1101-1106 || Theme Legs, some Theme Arms ||
|-
| 1150 || Bandaged & Prosthetic Legs ||
|-
| 1200 || '''Human Right & Left Arms, Human Upper Left Arm (2-handed pose)''' || Hard-coded, not visible in game files
|-
| 1200 || Most Spelltouched (Tattoo) Layers || Exceptions: Torso (1211), Lower 2-Handed Left Arm (3000)
|-
| 1201-1204 || Most Right & Left Theme Arms ||
|-
| 1211 || Spelltouched (Tattoo) Torso ||
|-
| 1212 || Morthagi Captain Torso || Not normally available to players
|-
| 1300 || Bandaged & Prosthetic Arms ||
|-
| 1500-1503 || [[Mortificial Enhancements|Mortificial]] Arms ||
|-
| 2000 || Foothill Neck Tattoos ||
|-
| 2000-2400 || Clothing/Armor || Excluding Clothing/Armor that covers the Lower Left Arm (2-Handed Pose). Some Warrior armor layers go as high as 2500.
|-
| 2490-2491 || Some Sash Augments ||
|-
| 2900-2901 || Belt Augments, Bracelet Augments (1-Handed Pose), Kneepad Augments ||
|-
| 2910 || Starheart Belt ||
|-
| 2940-2495 || Some Sash Augments ||
|-
| 2950-2955 || Some Cloak Augments (Front), Talisman Augments ||
|-
| 2970-2971 || Tortoiseshell Pendant ||
|-
| 3000 || '''Human Lower Left Arm (2-Handed Pose)''' || Hard-coded, not visible in game files
|-
| 3000 || Spelltouched Tattoos - Lower Left Arm (2-Handed Pose) ||
|-
| 3020-3499 || Clothing/Armor Layers, Lower Left Arm (2-Handed Pose) ||
|-
| 3550-3555 || Some Cloak Augments (Front) ||
|-
| 3560-3565 || Some Strap Augments, Some Scarf Augments ||
|-
| 3570-3575 || Necklace Augments ||
|-
| 3580-3582 || Pauldron Augments, Some Theme Arms || Includes [[Child of the Hills]], [[Elmsoul]] and [[Crystalline]]
|-
| 3590-3592 || Broach Augments ||
|-
| 3999 || Neck Theme Layers ||
|-
| 4000-4003 || Bracelet Augments ||
|-
| 4900 || '''Left Hand, Book Grip (Back)''' || Hard-coded, not visible in game files
|-
| 5000+ || '''Held Item (Offhand)''' || Hard-coded, not visible in game files. For multi-layer items, the default layer starts at 5000 and additional layers are added on top of that. For example, if an offhand item draws a shading layer at a depth of 1, when equipped in the off-hand the layer will have a value of 5001.
|-
| 6000 || '''Left Hand: Closed, Open, and Book (front) Grips''' || Hard-coded, not visible in game files
|-
| 6100-6103 || Shield Offhand Items ||
|-
| 7000 || '''Held Item (Main Hand)''' || Hard-coded, not visible in game files. For multi-layer items, the default layer starts at 5000 and additional layers are added on top of that. For example, if an offhand item draws a shading layer at a depth of 1, when equipped in the off-hand the layer will have a value of 7001.
|-
| 8000 || '''Right Hand: Closed, Open and Book Grips''' || Hard-coded, not visible in game files
|-
| 8100-8105 || Ring Augments ||
|}

== Modding Head Layers (Heads, Hair, Faces, Scars, etc.) ==

Head layers are used by the "peopleParts" files (to customize character appearance) and several aspects (such as the various scars).

Head layers are all drawn as a separate group from the body layers, so 'depth' values are only relative to other images being drawn on the head. The base game gives the various possible heads a depth value of 4000, so layers with a lower depth value will be drawn behind the head.

=== Layer Definition ===

Inside the peoplePart or aspect file, the layer definition will look something like this:

<pre>
"layers": [
{
"name": "hairFB3_behind",
"tint": "hair",
"bodyPart": "hair",
"depth": 3900,
"headOffset": true
},
{
"name": "hairFB3",
"tint": "hair",
"bodyPart": "hair",
"depth": 4200,
"rigMode": "femaleHead",
"headOffset": true
},
{
"name": "hairFB3M",
"tint": "hair",
"bodyPart": "hair",
"depth": 4200,
"rigMode": "maleHead",
"headOffset": true
},
{
"name": "hairFB3_streaks",
"tint": "streaks",
"bodyPart": "hair",
"depth": 4201,
"headOffset": true
}
]
</pre>

Some important fields:

* '''name''' ''(required)'': The name of the image to be used, not including the ''.png'' file extension.
* '''headOffset''' (required): Setting this to ''true'' is what defines this as a head layer.
* '''depth''' ''(recommended)'': Determines the order of drawing the images. High numbers go above lower numbers.
* '''tint''': Which of the character's ''tint'' colours to apply to this layer. Possible values are ''skin'', ''hair'', ''primary'', ''secondary'' and ''streaks''. (If omitted, no tint will be applied.)
* '''tintAmount''': How strongly the layer should be tinted on a scale from 0.0 (not at all) to 1.0 (full strength). (If omitted, any tint will be applied at full strength.)
* '''bodyPart''': If set, will only be drawn if the character has that body part and body part hasn't been transformed by a theme.
* '''rigMode''': If set, will only be drawn for the appropriate rig. Possible values are ''maleHead'' and ''femaleHead''
* '''ifOwnerHasPart''': If set, will only draw this layer if the character also has this other body part. (Often used to make beards fit exactly to faces.)
* '''expandFaceToExpressions''': If set and the keyword '''$face''' is used in the "name" value, the game will substitute '''$face''' for the character's current expression (Often used to make beards fit exactly to faces)
* '''facialExpression''': An array of the facial expressions that this layer applies to. (Often used with theme heads to allow the same head to apply to multiple expressions)
* '''ifOwnerAspect''': Only draw this layer if the character also has some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifOwnerAspects''': Character must have ''all'' of these aspects in order for the layer to be drawn.
* '''ifNoOwnerAspect''': Only draw this layer if the character does '''not''' have some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifNoOwnerAspects''': Character must not have ''any'' of these aspects in order for the layer to be drawn.

=== File Names ===

If using '''expandFaceToExpressions''', you will need to provide separate images for all 17 facial expressions ("neutral", "interested", "grim", "sad", "skeptical", "dubious", "open", "surprised", "scared", "angry", "rage", "scheming", "hit", "dead", "happy", "joke" and "joy"). Otherwise, your file name will simply be the name that you specified plus a .png file extension.

=== Canvas Size ===

Head image layers are defined in a rig's associated skeleton file. All human heads are expected to be 192 x
256 pixels. Any images of different dimensions will be stretched or squashed to this size.

'''Known Exceptions:''' Custom rigs may specify custom dimensions for the head layer. See "Mods with Special Considerations" below for known cases where custom head sizes are being used.

=== Image Location ===

Your mod should place all images for these layers inside the '''assets/figures/images/human/misc''' folder of your mod. (The first time you add an image to your mod, you may need to create these folders.)

Any images that share the exact same name as images in the base game's '''assets/figures/images/human/misc''' or '''assets/figures/images/human/unpacked''' folder will overwrite the base game's version of the file.

== Modding Body Layers (Limbs, Augments, Armor, etc.) ==

Most of the layers that appear on your character are part of the body set. The body layer includes the torso, the character's limbs, [[Armor|armour]], [[Augment|augments]], shields, and all of the theme parts that can replace the torso or limbs.

Body layers are '''rig-specific''', meaning that the game will determine which image to use based on the character's rig. The base game has a total of 6 rigs: Male/Female body shapes for each of the three classes (Warrior/Hunter/Mystic), and modders can create their own custom rigs and apply them using the [[Modding alternate rigs|rigOverride]] aspect.

=== Layer Definition ===

Inside the aspect, theme or armour file, the definition of a layer for the body will look something like this:

<pre>
"layers": [
{
"name": "replaceArmL_wolfA_tint",
"tint": "hair",
"depth": 1201,
"ifNoOwnerAspect": "themeSkin_wolf*"
},
{
"name": "replaceArmL_wolfB_untinted",
"depth": 1202,
"ifNoOwnerAspect": "themeSkin_wolf*"
}
],
</pre>

Some important fields:

* '''name''' ''(required)'': The name of the image to be used. (Body layers are special - see below)
* '''depth''' ''(recommended)'': Determines the order of drawing the images. High numbers go above lower numbers. (See below for list of depths used by base-game assets)
* '''tint''': Which of the character's ''tint'' colours to apply to this layer. Possible values are ''skin'', ''hair'', ''primary'', ''secondary'' and ''streaks''. (If omitted, no tint will be applied.)
* '''tintAmount''': How strongly the layer should be tinted on a scale from 0.0 (not at all) to 1.0 (full strength). (If omitted, any tint will be applied at full strength.)
* '''ifOwnerAspect''': Only draw this layer if the character also has some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifOwnerAspects''': Character must have ''all'' of these aspects in order for the layer to be drawn.
* '''ifNoOwnerAspect''': Only draw this layer if the character does '''not''' have some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifNoOwnerAspects''': Character must not have ''any'' of these aspects in order for the layer to be drawn.
* '''rigMode''': If set, only draw this layer in the specified mode. Possible values are ''oneHanded'' and ''twoHanded''.
* '''ifRightHandGrasp''': If set, only draw this layer based on the right hand's grasp value. Possible values are ''open'', ''closed'' and ''book''.
* '''ifLeftHandGrasp''': If set, only draw this layer based on the left hand's grasp value. Possible values are ''open'', ''closed'' and ''book''.

It is possible to create some very complicated effects using the above fields, such as including multiple layers that are each tinted separately, allowing augments or alternate arms/hands to grasp weapons and items, and making layers depend on multiple aspects to have them show or hide automatically based on other factors.

=== File Names and Rigs ===

As mentioned above, body layers are generally '''rig-specific'''. This means that the file the game will look for when drawing the character will be a combination of the name of the rig and the '''name''' specified in your layer, in the form ''<rigName>_<layer name>.png''. For example, if you set the name field for your layer as ''myNewLayer'', a female warrior (which uses the rig ''warriorF'') would use the image file '''warriorF_myNewLayer.png''' while a male mystic (which uses the rig ''mysticM'') would use the image file '''mysticM_myNewLayer.png'''

For body layers, you must therefore provide separate images for each rig that you wish to support.

The six rigs used in the base game are:

* hunterF
* hunterM
* mysticF
* mysticM
* warriorF
* warriorM

It is possible for mods to define and use custom rigs in addition to the base-game rigs above. See "Mods with Special Considerations" below for more information.

=== Canvas Size ===

Body image layers are all expected to be 512 x 512 pixels. Any images of different dimensions will be stretched or squashed to this size.

=== Image Location ===

Your mod should place all images for these layers inside the '''assets/figures/images/human/misc''' folder of your mod. (The first time you add an image to your mod, you may need to create these folders.)

Any images that share the exact same name as images in the base game's '''assets/figures/images/human/misc''' or '''assets/figures/images/human/unpacked''' folder will overwrite the base game's version of the file.

== Modding Held Item Layers ==

Items are the things that can be held in the character's main or off hand and are sometimes stowed behind the character's back when inactive.

=== Layer Definition ===

Inside the item, the layer definition will look something like this:

<pre>
"layers": [
{
"name": "item_axe1Fang_t1A_tint1_50",
"tint": "primary",
"tintAmount": 0.5,
"scaleX": 0.5,
"scaleY": 0.5,
"rigUsage": "rigGeneral",
"grip": "mainHand",
"inactiveGrip": "highBack",
"gripOffset": { "x": 114, "y": 210 }
},
{
"name": "item_axe1Fang_t1B_untinted",
"scaleX": 0.5,
"scaleY": 0.5,
"rigUsage": "rigGeneral",
"grip": "mainHand",
"inactiveGrip": "highBack",
"gripOffset": { "x": 114, "y": 210 }
}
]
</pre>

Some important fields:

* '''name''' ''(required)'': The name of the image to be used. (The game seems to like item images to be prefixed with '''item_''')
* '''depth''' ''(recommended)'': Determines the order of drawing the images. High numbers go above lower numbers.
* '''rigUsage''' ''(recommended)'': Setting this to '''rigGeneral''' means this layer will always be drawn regardless of the rig used by the character.
* '''gripOffset''' ''(recommended)'': Specifies the anchor point where a character will hold this item.
* '''grip''' ''(recommended)'': Which hand a character uses to hold this. Possible values are "mainHand" and "offHand".
* '''inactiveGrip''' ''(recommended for weapons)'': Where to stow this item when inactive. Possible values are "highBack" "midBack" "lowBack" and "hide".
* '''grasp''': How the item is held. Defaults to "closed". Can be set to "book" or "open".
* '''scaleX''': Scaling multiplier to size the item appropriately to the character.
* '''scaleY''': Scaling multiplier to size the item appropriately to the character.
* '''rotation''': Rotates the item.
* '''tint''': Which of the character's ''tint'' colours to apply to this layer. Possible values are ''skin'', ''hair'', ''primary'', ''secondary'' and ''streaks''. (If omitted, no tint will be applied.)
* '''tintAmount''': How strongly the layer should be tinted on a scale from 0.0 (not at all) to 1.0 (full strength). (If omitted, any tint will be applied at full strength.)

=== Canvas Size ===

Item image layers can be any size. Use the ''scaleX'' and ''scaleY'' properties in the layer definition to ensure the item is sized appropriately for the character.

=== Image Location ===

Your mod should place all images for these layers inside the '''assets/figures/images/human/items''' folder of your mod. (The first time you add an image to your mod, you may need to create these folders.)

Any images that share the exact same name as images in the base game's '''assets/figures/images/human/items''' folder will overwrite the base game's version of the file.

== Mods with Special Considerations ==

The following mods use custom setups in some way.

=== [https://steamcommunity.com/sharedfiles/filedetails/?id=2810606541 Drauven PCs] ===
'''Author:''' Drauven Mod Squad (Lead: David Bilsky, AKA Ironskink/BoldestDungeon)

'''Website:''' [https://github.com/BoldestDungeon/wildermyth-drauven-pcs Project Page on GitHub]

'''Primary Contact:''' [https://discord.gg/uftGyUa8GS Dedicated Discord server]

==== New Rigs ====
* DrauvenHunter
* DrauvenMystic
* DrauvenWarrior
* Drauven

'''Notes: '''

The Warrior, Hunter and Mystic rigs are based on the Stump, Haunt and Deeven models, respectively. Raw .psd files for the rigs at the project's public [https://github.com/BoldestDungeon/wildermyth-drauven-pcs/tree/develop/assets/figures/source GitHub] page. The plain ''Drauven'' rig is used for farmers and is an exact copy of the Warrior (Stump) rig.

The Drauven rigs use a larger canvas size for the head layers than the normal human rigs do (256 x 384 px) to better fit all the various head ornamentations that the Drauven have.

=== [https://steamcommunity.com/sharedfiles/filedetails/?id=2978516419 Return of the Centauri]===
'''Author:''' Pinhat

==== New Rigs ====
* centaurWarriorM
* centaurWarriorF
* centaurHunterM
* centaurHunterF
* centaurMysticM
* centaurMysticF

'''Notes:'''

The centaur rig essentially shifts all of the upper-body assets up and to the right to make room for the centaur's lower body. The upper human body is unchanged except for the position.

[[Category:Modding]]

Image layers

2024-06-02T18:23:55Z

Ironskink: Added table of layer depths in the base game

Image layers are used by [[Theme|themes]], [[Modding_add_equipment|equipment]] and even regular [[Aspect|aspects]] to affect the appearance of a character. Characters in Wildermyth are created by layering a number of .png files overtop each other based on their "depth" value, with higher values appearing overtop lower values in their group.

Images are clumped into five groups: the main body, the head, the main/equipped weapon, the inactive/stowed weapon, and the offhand weapon/item. Regardless of depth values, image layers within the head group or an item will all be "flat" with respect to the body layers. An axe that uses two layers can have depth values of 1 and 2 and it will always be drawn in front of the body & armour layers when equipped and behind the torso when inactive.

''Note: In most game files, image layers are grouped under a heading called '''"layers"''', while in aspect files they are called '''"skinLayers"'''. This guide applies regardless of which of these headings is used.''

== Default Layer Depths ==

{| class="wikitable"
|+ Layer depths used by the base game
! Layer Depth !! Used for !! Notes
|-
| 10-11 || Cloak Backs ||
|-
| 55-58 || Wings || Includes [[Crowtouched|Crow Wings]], [[Hawksoul|Hawk Wings]], [[Mothly|Moth Wings]], [[Drauven Wings]] and [[Teeny Wings]]
|-
| 70 || Shoulder Pets || Includes [[Drauven Bird]] and [[Netherowl]]
|-
| 100-103 || Tails ||
|-
| 1000 || '''Human Torso''' || Hard-coded, not visible in game files
|-
| 1001-1003 || Bear (Tattoo) Arms, Tree (Willow) Arms ||
|-
| 1100 || '''Left & Right Human Legs''' || Hard-coded, not visible in game files
|-
| 1101-1106 || Theme Legs, some Theme Arms ||
|-
| 1150 || Bandaged & Prosthetic Legs ||
|-
| 1200 || '''Human Right & Left Arms, Human Upper Left Arm (2-handed pose)''' || Hard-coded, not visible in game files
|-
| 1200 || Most Spelltouched (Tattoo) Layers || Exceptions: Torso (1211), Lower 2-Handed Left Arm (3000)
|-
| 1201-1204 || Most Right & Left Theme Arms ||
|-
| 1211 || Spelltouched (Tattoo) Torso ||
|-
| 1212 || Morthagi Captain Torso || Not normally available to players
|-
| 1300 || Bandaged & Prosthetic Arms ||
|-
| 1500-1503 || [[Mortificial Enhancements|Mortificial]] Arms ||
|-
| 2000 || Foothill Neck Tattoos ||
|-
| 2000-2400 || Clothing/Armor || Excluding Clothing/Armor that covers the Lower Left Arm (2-Handed Pose). Some Warrior armor layers go as high as 2500.
|-
| 2490-2491 || Some Sash Augments ||
|-
| 2900-2901 || Belt Augments, Bracelet Augments (1-Handed Pose), Kneepad Augments ||
|-
| 2910 || Starheart Belt ||
|-
| 2940-2495 || Some Sash Augments ||
|-
| 2950-2955 || Some Cloak Augments (Front), Talisman Augments || Example
|-
| 2970-2971 || Tortoiseshell Pendant ||
|-
| 3000 || '''Human Lower Left Arm (2-Handed Pose)''' || Hard-coded, not visible in game files
|-
| 3000 || Spelltouched Tattoos - Lower Left Arm (2-Handed Pose) ||
|-
| 3020-3499 || Clothing/Armor Layers, Lower Left Arm (2-Handed Pose) ||
|-
| 3550-3555 || Some Cloak Augments (Front) ||
|-
| 3560-3565 || Some Strap Augments, Some Scarf Augments ||
|-
| 3570-3575 || Necklace Augments ||
|-
| 3580-3582 || Pauldron Augments, Some Theme Arms || Includes [[Child of the Hills]], [[Elmsoul]] and [[Crystalline]]
|-
| 3590-3592 || Broach Augments ||
|-
| 3999 || Neck Theme Layers ||
|-
| 4000-4003 || Bracelet Augments ||
|-
| 4900 || '''Left Hand, Book Grip (Back)''' || Hard-coded, not visible in game files
|-
| 5000+ || Held Item (Offhand) || Hard-coded, not visible in game files. For multi-layer items, the default layer starts at 5000 and additional layers are added on top of that. For example, if an offhand item draws a shading layer at a depth of 1, when equipped in the off-hand the layer will have a value of 5001.
|-
| 6000 || Left Hand: Closed, Open, and Book (front) Grips || Hard-coded, not visible in game files
|-
| 6100-6103 || Shield Offhand Items ||
|-
| 7000 || Held Item (Main Hand) || Hard-coded, not visible in game files. For multi-layer items, the default layer starts at 5000 and additional layers are added on top of that. For example, if an offhand item draws a shading layer at a depth of 1, when equipped in the off-hand the layer will have a value of 7001.
|-
| 8000 || Right Hand: Closed, Open and Book Grips || Hard-coded, not visible in game files
|-
| 8100-8105 || Ring Augments ||
|}

== Modding Head Layers (Heads, Hair, Faces, Scars, etc.) ==

Head layers are used by the "peopleParts" files (to customize character appearance) and several aspects (such as the various scars).

Head layers are all drawn as a separate group from the body layers, so 'depth' values are only relative to other images being drawn on the head. The base game gives the various possible heads a depth value of 4000, so layers with a lower depth value will be drawn behind the head.

=== Layer Definition ===

Inside the peoplePart or aspect file, the layer definition will look something like this:

<pre>
"layers": [
{
"name": "hairFB3_behind",
"tint": "hair",
"bodyPart": "hair",
"depth": 3900,
"headOffset": true
},
{
"name": "hairFB3",
"tint": "hair",
"bodyPart": "hair",
"depth": 4200,
"rigMode": "femaleHead",
"headOffset": true
},
{
"name": "hairFB3M",
"tint": "hair",
"bodyPart": "hair",
"depth": 4200,
"rigMode": "maleHead",
"headOffset": true
},
{
"name": "hairFB3_streaks",
"tint": "streaks",
"bodyPart": "hair",
"depth": 4201,
"headOffset": true
}
]
</pre>

Some important fields:

* '''name''' ''(required)'': The name of the image to be used, not including the ''.png'' file extension.
* '''headOffset''' (required): Setting this to ''true'' is what defines this as a head layer.
* '''depth''' ''(recommended)'': Determines the order of drawing the images. High numbers go above lower numbers.
* '''tint''': Which of the character's ''tint'' colours to apply to this layer. Possible values are ''skin'', ''hair'', ''primary'', ''secondary'' and ''streaks''. (If omitted, no tint will be applied.)
* '''tintAmount''': How strongly the layer should be tinted on a scale from 0.0 (not at all) to 1.0 (full strength). (If omitted, any tint will be applied at full strength.)
* '''bodyPart''': If set, will only be drawn if the character has that body part and body part hasn't been transformed by a theme.
* '''rigMode''': If set, will only be drawn for the appropriate rig. Possible values are ''maleHead'' and ''femaleHead''
* '''ifOwnerHasPart''': If set, will only draw this layer if the character also has this other body part. (Often used to make beards fit exactly to faces.)
* '''expandFaceToExpressions''': If set and the keyword '''$face''' is used in the "name" value, the game will substitute '''$face''' for the character's current expression (Often used to make beards fit exactly to faces)
* '''facialExpression''': An array of the facial expressions that this layer applies to. (Often used with theme heads to allow the same head to apply to multiple expressions)
* '''ifOwnerAspect''': Only draw this layer if the character also has some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifOwnerAspects''': Character must have ''all'' of these aspects in order for the layer to be drawn.
* '''ifNoOwnerAspect''': Only draw this layer if the character does '''not''' have some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifNoOwnerAspects''': Character must not have ''any'' of these aspects in order for the layer to be drawn.

=== File Names ===

If using '''expandFaceToExpressions''', you will need to provide separate images for all 17 facial expressions ("neutral", "interested", "grim", "sad", "skeptical", "dubious", "open", "surprised", "scared", "angry", "rage", "scheming", "hit", "dead", "happy", "joke" and "joy"). Otherwise, your file name will simply be the name that you specified plus a .png file extension.

=== Canvas Size ===

Head image layers are defined in a rig's associated skeleton file. All human heads are expected to be 192 x
256 pixels. Any images of different dimensions will be stretched or squashed to this size.

'''Known Exceptions:''' Custom rigs may specify custom dimensions for the head layer. See "Mods with Special Considerations" below for known cases where custom head sizes are being used.

=== Image Location ===

Your mod should place all images for these layers inside the '''assets/figures/images/human/misc''' folder of your mod. (The first time you add an image to your mod, you may need to create these folders.)

Any images that share the exact same name as images in the base game's '''assets/figures/images/human/misc''' or '''assets/figures/images/human/unpacked''' folder will overwrite the base game's version of the file.

== Modding Body Layers (Limbs, Augments, Armor, etc.) ==

Most of the layers that appear on your character are part of the body set. The body layer includes the torso, the character's limbs, [[Armor|armour]], [[Augment|augments]], shields, and all of the theme parts that can replace the torso or limbs.

Body layers are '''rig-specific''', meaning that the game will determine which image to use based on the character's rig. The base game has a total of 6 rigs: Male/Female body shapes for each of the three classes (Warrior/Hunter/Mystic), and modders can create their own custom rigs and apply them using the [[Modding alternate rigs|rigOverride]] aspect.

=== Layer Definition ===

Inside the aspect, theme or armour file, the definition of a layer for the body will look something like this:

<pre>
"layers": [
{
"name": "replaceArmL_wolfA_tint",
"tint": "hair",
"depth": 1201,
"ifNoOwnerAspect": "themeSkin_wolf*"
},
{
"name": "replaceArmL_wolfB_untinted",
"depth": 1202,
"ifNoOwnerAspect": "themeSkin_wolf*"
}
],
</pre>

Some important fields:

* '''name''' ''(required)'': The name of the image to be used. (Body layers are special - see below)
* '''depth''' ''(recommended)'': Determines the order of drawing the images. High numbers go above lower numbers. (See below for list of depths used by base-game assets)
* '''tint''': Which of the character's ''tint'' colours to apply to this layer. Possible values are ''skin'', ''hair'', ''primary'', ''secondary'' and ''streaks''. (If omitted, no tint will be applied.)
* '''tintAmount''': How strongly the layer should be tinted on a scale from 0.0 (not at all) to 1.0 (full strength). (If omitted, any tint will be applied at full strength.)
* '''ifOwnerAspect''': Only draw this layer if the character also has some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifOwnerAspects''': Character must have ''all'' of these aspects in order for the layer to be drawn.
* '''ifNoOwnerAspect''': Only draw this layer if the character does '''not''' have some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifNoOwnerAspects''': Character must not have ''any'' of these aspects in order for the layer to be drawn.
* '''rigMode''': If set, only draw this layer in the specified mode. Possible values are ''oneHanded'' and ''twoHanded''.
* '''ifRightHandGrasp''': If set, only draw this layer based on the right hand's grasp value. Possible values are ''open'', ''closed'' and ''book''.
* '''ifLeftHandGrasp''': If set, only draw this layer based on the left hand's grasp value. Possible values are ''open'', ''closed'' and ''book''.

It is possible to create some very complicated effects using the above fields, such as including multiple layers that are each tinted separately, allowing augments or alternate arms/hands to grasp weapons and items, and making layers depend on multiple aspects to have them show or hide automatically based on other factors.

=== File Names and Rigs ===

As mentioned above, body layers are generally '''rig-specific'''. This means that the file the game will look for when drawing the character will be a combination of the name of the rig and the '''name''' specified in your layer, in the form ''<rigName>_<layer name>.png''. For example, if you set the name field for your layer as ''myNewLayer'', a female warrior (which uses the rig ''warriorF'') would use the image file '''warriorF_myNewLayer.png''' while a male mystic (which uses the rig ''mysticM'') would use the image file '''mysticM_myNewLayer.png'''

For body layers, you must therefore provide separate images for each rig that you wish to support.

The six rigs used in the base game are:

* hunterF
* hunterM
* mysticF
* mysticM
* warriorF
* warriorM

It is possible for mods to define and use custom rigs in addition to the base-game rigs above. See "Mods with Special Considerations" below for more information.

=== Canvas Size ===

Body image layers are all expected to be 512 x 512 pixels. Any images of different dimensions will be stretched or squashed to this size.

=== Image Location ===

Your mod should place all images for these layers inside the '''assets/figures/images/human/misc''' folder of your mod. (The first time you add an image to your mod, you may need to create these folders.)

Any images that share the exact same name as images in the base game's '''assets/figures/images/human/misc''' or '''assets/figures/images/human/unpacked''' folder will overwrite the base game's version of the file.

== Modding Held Item Layers ==

Items are the things that can be held in the character's main or off hand and are sometimes stowed behind the character's back when inactive.

=== Layer Definition ===

Inside the item, the layer definition will look something like this:

<pre>
"layers": [
{
"name": "item_axe1Fang_t1A_tint1_50",
"tint": "primary",
"tintAmount": 0.5,
"scaleX": 0.5,
"scaleY": 0.5,
"rigUsage": "rigGeneral",
"grip": "mainHand",
"inactiveGrip": "highBack",
"gripOffset": { "x": 114, "y": 210 }
},
{
"name": "item_axe1Fang_t1B_untinted",
"scaleX": 0.5,
"scaleY": 0.5,
"rigUsage": "rigGeneral",
"grip": "mainHand",
"inactiveGrip": "highBack",
"gripOffset": { "x": 114, "y": 210 }
}
]
</pre>

Some important fields:

* '''name''' ''(required)'': The name of the image to be used. (The game seems to like item images to be prefixed with '''item_''')
* '''depth''' ''(recommended)'': Determines the order of drawing the images. High numbers go above lower numbers.
* '''rigUsage''' ''(recommended)'': Setting this to '''rigGeneral''' means this layer will always be drawn regardless of the rig used by the character.
* '''gripOffset''' ''(recommended)'': Specifies the anchor point where a character will hold this item.
* '''grip''' ''(recommended)'': Which hand a character uses to hold this. Possible values are "mainHand" and "offHand".
* '''inactiveGrip''' ''(recommended for weapons)'': Where to stow this item when inactive. Possible values are "highBack" "midBack" "lowBack" and "hide".
* '''grasp''': How the item is held. Defaults to "closed". Can be set to "book" or "open".
* '''scaleX''': Scaling multiplier to size the item appropriately to the character.
* '''scaleY''': Scaling multiplier to size the item appropriately to the character.
* '''rotation''': Rotates the item.
* '''tint''': Which of the character's ''tint'' colours to apply to this layer. Possible values are ''skin'', ''hair'', ''primary'', ''secondary'' and ''streaks''. (If omitted, no tint will be applied.)
* '''tintAmount''': How strongly the layer should be tinted on a scale from 0.0 (not at all) to 1.0 (full strength). (If omitted, any tint will be applied at full strength.)

=== Canvas Size ===

Item image layers can be any size. Use the ''scaleX'' and ''scaleY'' properties in the layer definition to ensure the item is sized appropriately for the character.

=== Image Location ===

Your mod should place all images for these layers inside the '''assets/figures/images/human/items''' folder of your mod. (The first time you add an image to your mod, you may need to create these folders.)

Any images that share the exact same name as images in the base game's '''assets/figures/images/human/items''' folder will overwrite the base game's version of the file.

== Mods with Special Considerations ==

The following mods use custom setups in some way.

=== [https://steamcommunity.com/sharedfiles/filedetails/?id=2810606541 Drauven PCs] ===
'''Author:''' Drauven Mod Squad (Lead: David Bilsky, AKA Ironskink/BoldestDungeon)

'''Website:''' [https://github.com/BoldestDungeon/wildermyth-drauven-pcs Project Page on GitHub]

'''Primary Contact:''' [https://discord.gg/uftGyUa8GS Dedicated Discord server]

==== New Rigs ====
* DrauvenHunter
* DrauvenMystic
* DrauvenWarrior
* Drauven

'''Notes: '''

The Warrior, Hunter and Mystic rigs are based on the Stump, Haunt and Deeven models, respectively. Raw .psd files for the rigs at the project's public [https://github.com/BoldestDungeon/wildermyth-drauven-pcs/tree/develop/assets/figures/source GitHub] page. The plain ''Drauven'' rig is used for farmers and is an exact copy of the Warrior (Stump) rig.

The Drauven rigs use a larger canvas size for the head layers than the normal human rigs do (256 x 384 px) to better fit all the various head ornamentations that the Drauven have.

=== [https://steamcommunity.com/sharedfiles/filedetails/?id=2978516419 Return of the Centauri]===
'''Author:''' Pinhat

==== New Rigs ====
* centaurWarriorM
* centaurWarriorF
* centaurHunterM
* centaurHunterF
* centaurMysticM
* centaurMysticF

'''Notes:'''

The centaur rig essentially shifts all of the upper-body assets up and to the right to make room for the centaur's lower body. The upper human body is unchanged except for the position.

[[Category:Modding]]

Image layers

2023-07-28T15:49:20Z

Ironskink: Initial page creation

Image layers are used by [[Theme|themes]], [[Modding_add_equipment|equipment]] and even regular [[Aspect|aspects]] to affect the appearance of a character. Characters in Wildermyth are created by layering a number of .png files overtop each other based on their "depth" value, with higher values appearing overtop lower values in their group.

Images are clumped into five groups: the main body, the head, the main/equipped weapon, the inactive/stowed weapon, and the offhand weapon/item. Regardless of depth values, image layers within the head group or an item will all be "flat" with respect to the body layers. An axe that uses two layers can have depth values of 1 and 2 and it will always be drawn in front of the body & armour layers when equipped and behind the torso when inactive.

''Note: In most game files, image layers are grouped under a heading called '''"layers"''', while in aspect files they are called '''"skinLayers"'''. This guide applies regardless of which of these headings is used.''

== Modding Head Layers (Heads, Hair, Faces, Scars, etc.) ==

Head layers are used by the "peopleParts" files (to customize character appearance) and several aspects (such as the various scars).

Head layers are all drawn as a separate group from the body layers, so 'depth' values are only relative to other images being drawn on the head. The base game gives the various possible heads a depth value of 4000, so layers with a lower depth value will be drawn behind the head.

=== Layer Definition ===

Inside the peoplePart or aspect file, the layer definition will look something like this:

<pre>
"layers": [
{
"name": "hairFB3_behind",
"tint": "hair",
"bodyPart": "hair",
"depth": 3900,
"headOffset": true
},
{
"name": "hairFB3",
"tint": "hair",
"bodyPart": "hair",
"depth": 4200,
"rigMode": "femaleHead",
"headOffset": true
},
{
"name": "hairFB3M",
"tint": "hair",
"bodyPart": "hair",
"depth": 4200,
"rigMode": "maleHead",
"headOffset": true
},
{
"name": "hairFB3_streaks",
"tint": "streaks",
"bodyPart": "hair",
"depth": 4201,
"headOffset": true
}
]
</pre>

Some important fields:

* '''name''' ''(required)'': The name of the image to be used, not including the ''.png'' file extension.
* '''headOffset''' (required): Setting this to ''true'' is what defines this as a head layer.
* '''depth''' ''(recommended)'': Determines the order of drawing the images. High numbers go above lower numbers.
* '''tint''': Which of the character's ''tint'' colours to apply to this layer. Possible values are ''skin'', ''hair'', ''primary'', ''secondary'' and ''streaks''. (If omitted, no tint will be applied.)
* '''tintAmount''': How strongly the layer should be tinted on a scale from 0.0 (not at all) to 1.0 (full strength). (If omitted, any tint will be applied at full strength.)
* '''bodyPart''': If set, will only be drawn if the character has that body part and body part hasn't been transformed by a theme.
* '''rigMode''': If set, will only be drawn for the appropriate rig. Possible values are ''maleHead'' and ''femaleHead''
* '''ifOwnerHasPart''': If set, will only draw this layer if the character also has this other body part. (Often used to make beards fit exactly to faces.)
* '''expandFaceToExpressions''': If set and the keyword '''$face''' is used in the "name" value, the game will substitute '''$face''' for the character's current expression (Often used to make beards fit exactly to faces)
* '''facialExpression''': An array of the facial expressions that this layer applies to. (Often used with theme heads to allow the same head to apply to multiple expressions)
* '''ifOwnerAspect''': Only draw this layer if the character also has some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifOwnerAspects''': Character must have ''all'' of these aspects in order for the layer to be drawn.
* '''ifNoOwnerAspect''': Only draw this layer if the character does '''not''' have some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifNoOwnerAspects''': Character must not have ''any'' of these aspects in order for the layer to be drawn.

=== File Names ===

If using '''expandFaceToExpressions''', you will need to provide separate images for all 17 facial expressions ("neutral", "interested", "grim", "sad", "skeptical", "dubious", "open", "surprised", "scared", "angry", "rage", "scheming", "hit", "dead", "happy", "joke" and "joy"). Otherwise, your file name will simply be the name that you specified plus a .png file extension.

=== Canvas Size ===

Head image layers are defined in a rig's associated skeleton file. All human heads are expected to be 192 x
256 pixels. Any images of different dimensions will be stretched or squashed to this size.

'''Known Exceptions:''' Custom rigs may specify custom dimensions for the head layer. See "Mods with Special Considerations" below for known cases where custom head sizes are being used.

=== Image Location ===

Your mod should place all images for these layers inside the '''assets/figures/images/human/misc''' folder of your mod. (The first time you add an image to your mod, you may need to create these folders.)

Any images that share the exact same name as images in the base game's '''assets/figures/images/human/misc''' or '''assets/figures/images/human/unpacked''' folder will overwrite the base game's version of the file.

== Modding Body Layers (Limbs, Augments, Armor, etc.) ==

Most of the layers that appear on your character are part of the body set. The body layer includes the torso, the character's limbs, [[Armor|armour]], [[Augment|augments]], shields, and all of the theme parts that can replace the torso or limbs.

Body layers are '''rig-specific''', meaning that the game will determine which image to use based on the character's rig. The base game has a total of 6 rigs: Male/Female body shapes for each of the three classes (Warrior/Hunter/Mystic), and modders can create their own custom rigs and apply them using the [[Modding alternate rigs|rigOverride]] aspect.

=== Layer Definition ===

Inside the aspect, theme or armour file, the definition of a layer for the body will look something like this:

<pre>
"layers": [
{
"name": "replaceArmL_wolfA_tint",
"tint": "hair",
"depth": 1201,
"ifNoOwnerAspect": "themeSkin_wolf*"
},
{
"name": "replaceArmL_wolfB_untinted",
"depth": 1202,
"ifNoOwnerAspect": "themeSkin_wolf*"
}
],
</pre>

Some important fields:

* '''name''' ''(required)'': The name of the image to be used. (Body layers are special - see below)
* '''depth''' ''(recommended)'': Determines the order of drawing the images. High numbers go above lower numbers. (See below for list of depths used by base-game assets)
* '''tint''': Which of the character's ''tint'' colours to apply to this layer. Possible values are ''skin'', ''hair'', ''primary'', ''secondary'' and ''streaks''. (If omitted, no tint will be applied.)
* '''tintAmount''': How strongly the layer should be tinted on a scale from 0.0 (not at all) to 1.0 (full strength). (If omitted, any tint will be applied at full strength.)
* '''ifOwnerAspect''': Only draw this layer if the character also has some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifOwnerAspects''': Character must have ''all'' of these aspects in order for the layer to be drawn.
* '''ifNoOwnerAspect''': Only draw this layer if the character does '''not''' have some other aspect on them. Ending the value with a wildcard character ('''*''') will match any aspect beginning with everything before the *.
* '''ifNoOwnerAspects''': Character must not have ''any'' of these aspects in order for the layer to be drawn.
* '''rigMode''': If set, only draw this layer in the specified mode. Possible values are ''oneHanded'' and ''twoHanded''.
* '''ifRightHandGrasp''': If set, only draw this layer based on the right hand's grasp value. Possible values are ''open'', ''closed'' and ''book''.
* '''ifLeftHandGrasp''': If set, only draw this layer based on the left hand's grasp value. Possible values are ''open'', ''closed'' and ''book''.

It is possible to create some very complicated effects using the above fields, such as including multiple layers that are each tinted separately, allowing augments or alternate arms/hands to grasp weapons and items, and making layers depend on multiple aspects to have them show or hide automatically based on other factors.

=== File Names and Rigs ===

As mentioned above, body layers are generally '''rig-specific'''. This means that the file the game will look for when drawing the character will be a combination of the name of the rig and the '''name''' specified in your layer, in the form ''<rigName>_<layer name>.png''. For example, if you set the name field for your layer as ''myNewLayer'', a female warrior (which uses the rig ''warriorF'') would use the image file '''warriorF_myNewLayer.png''' while a male mystic (which uses the rig ''mysticM'') would use the image file '''mysticM_myNewLayer.png'''

For body layers, you must therefore provide separate images for each rig that you wish to support.

The six rigs used in the base game are:

* hunterF
* hunterM
* mysticF
* mysticM
* warriorF
* warriorM

It is possible for mods to define and use custom rigs in addition to the base-game rigs above. See "Mods with Special Considerations" below for more information.

=== Canvas Size ===

Body image layers are all expected to be 512 x 512 pixels. Any images of different dimensions will be stretched or squashed to this size.

=== Image Location ===

Your mod should place all images for these layers inside the '''assets/figures/images/human/misc''' folder of your mod. (The first time you add an image to your mod, you may need to create these folders.)

Any images that share the exact same name as images in the base game's '''assets/figures/images/human/misc''' or '''assets/figures/images/human/unpacked''' folder will overwrite the base game's version of the file.

== Modding Held Item Layers ==

Items are the things that can be held in the character's main or off hand and are sometimes stowed behind the character's back when inactive.

=== Layer Definition ===

Inside the item, the layer definition will look something like this:

<pre>
"layers": [
{
"name": "item_axe1Fang_t1A_tint1_50",
"tint": "primary",
"tintAmount": 0.5,
"scaleX": 0.5,
"scaleY": 0.5,
"rigUsage": "rigGeneral",
"grip": "mainHand",
"inactiveGrip": "highBack",
"gripOffset": { "x": 114, "y": 210 }
},
{
"name": "item_axe1Fang_t1B_untinted",
"scaleX": 0.5,
"scaleY": 0.5,
"rigUsage": "rigGeneral",
"grip": "mainHand",
"inactiveGrip": "highBack",
"gripOffset": { "x": 114, "y": 210 }
}
]
</pre>

Some important fields:

* '''name''' ''(required)'': The name of the image to be used. (The game seems to like item images to be prefixed with '''item_''')
* '''depth''' ''(recommended)'': Determines the order of drawing the images. High numbers go above lower numbers.
* '''rigUsage''' ''(recommended)'': Setting this to '''rigGeneral''' means this layer will always be drawn regardless of the rig used by the character.
* '''gripOffset''' ''(recommended)'': Specifies the anchor point where a character will hold this item.
* '''grip''' ''(recommended)'': Which hand a character uses to hold this. Possible values are "mainHand" and "offHand".
* '''inactiveGrip''' ''(recommended for weapons)'': Where to stow this item when inactive. Possible values are "highBack" "midBack" "lowBack" and "hide".
* '''grasp''': How the item is held. Defaults to "closed". Can be set to "book" or "open".
* '''scaleX''': Scaling multiplier to size the item appropriately to the character.
* '''scaleY''': Scaling multiplier to size the item appropriately to the character.
* '''rotation''': Rotates the item.
* '''tint''': Which of the character's ''tint'' colours to apply to this layer. Possible values are ''skin'', ''hair'', ''primary'', ''secondary'' and ''streaks''. (If omitted, no tint will be applied.)
* '''tintAmount''': How strongly the layer should be tinted on a scale from 0.0 (not at all) to 1.0 (full strength). (If omitted, any tint will be applied at full strength.)

=== Canvas Size ===

Item image layers can be any size. Use the ''scaleX'' and ''scaleY'' properties in the layer definition to ensure the item is sized appropriately for the character.

=== Image Location ===

Your mod should place all images for these layers inside the '''assets/figures/images/human/items''' folder of your mod. (The first time you add an image to your mod, you may need to create these folders.)

Any images that share the exact same name as images in the base game's '''assets/figures/images/human/items''' folder will overwrite the base game's version of the file.

== Mods with Special Considerations ==

The following mods use custom setups in some way.

=== [https://steamcommunity.com/sharedfiles/filedetails/?id=2810606541 Drauven PCs] ===
'''Author:''' Drauven Mod Squad (Lead: David Bilsky, AKA Ironskink/BoldestDungeon)

'''Website:''' [https://github.com/BoldestDungeon/wildermyth-drauven-pcs Project Page on GitHub]

'''Primary Contact:''' [https://discord.gg/uftGyUa8GS Dedicated Discord server]

==== New Rigs ====
* DrauvenHunter
* DrauvenMystic
* DrauvenWarrior
* Drauven

'''Notes: '''

The Warrior, Hunter and Mystic rigs are based on the Stump, Haunt and Deeven models, respectively. Raw .psd files for the rigs at the project's public [https://github.com/BoldestDungeon/wildermyth-drauven-pcs/tree/develop/assets/figures/source GitHub] page. The plain ''Drauven'' rig is used for farmers and is an exact copy of the Warrior (Stump) rig.

The Drauven rigs use a larger canvas size for the head layers than the normal human rigs do (256 x 384 px) to better fit all the various head ornamentations that the Drauven have.

=== [https://steamcommunity.com/sharedfiles/filedetails/?id=2978516419 Return of the Centauri]===
'''Author:''' Pinhat

==== New Rigs ====
* centaurWarriorM
* centaurWarriorF
* centaurHunterM
* centaurHunterF
* centaurMysticM
* centaurMysticF

'''Notes:'''

The centaur rig essentially shifts all of the upper-body assets up and to the right to make room for the centaur's lower body. The upper human body is unchanged except for the position.

[[Category:Modding]]

Modding alternate races

2023-02-23T02:12:01Z

Ironskink: Adding categories

In the base game, all of your heroes are humans. Though they can undergo various transformattions through certain events, they still remain fundamentally human. Fantasy is full of weird and wonderful sentient species though, and this guide will walk you through the process using the [https://steamcommunity.com/sharedfiles/filedetails/?id=2810606541 Drauven PCs mod] as an example & reference.

This guide assumes that you have already created a mod and are familiar with the basics. Check out the [[Modding Guide]] if you need help getting started.

== Creating the Base History & Aspects ==

To begin, create a new history entry. Create a file in the <code>assets/data/history</code> of your mod (creating any missing folders as necessary), then make a new blank text file and give it a name like <code>drauvenBase.json</code>

To start, make a placeholder object with a category and ID. This history entry is going to add and remove aspects to our heroes, so let's also go ahead and add placeholders for these as well. You can copy this template in and change the name from <code>drauven</code> to your race's name:

<pre>
{
"id": "drauvenBase.001",
"category": "drauvenBase",
"impliedAspects": [],
"removeAspects": [],
"showInSummary": false
}
</pre>

=== Removing the Human Skin Layers ===

First step for any good nonhuman race will be to remove all of the human visuals. We can do this by removing the <code>humanSkin</code> aspects associated with the various limbs and adding a few more <code>humanSkin</code> aspects to suppress the rest.

To remove all the limbs, we set up our <code>removeAspects</code> list to remove the following:

<pre>
"removeAspects": [
"humanSkin_naturalLeftArm",
"humanSkin_naturalLeftHand",
"humanSkin_naturalRightArm",
"humanSkin_naturalRightHand",
"humanSkin_naturalLeftLeg",
"humanSkin_naturalRightLeg",
"humanSkin_naturalHead"
]
</pre>

To remove the torso, we need to ''add'' an aspect in the <code>impliedAspects</code> list:

<pre>
"impliedAspects": [
"humanSkin_suppressTorso"
]
</pre>

With these aspects added & removed, our character should now be a completely blank slate!

Some other aspects that you may consider adding, depending on the nature of your race, include:

* <code>humanSkin_suppressClothes</code>: Clothing layers will not be drawn, but the character can still use armour (it will just be invisible)
* <code>ATTACHMENTS_suppressArmor</code>: Character cannot wear armour (so will be relying on other aspects for their defence)

=== Non-Human Base Stats & the <code>nonhuman</code> Aspect ===

For our Drauven mod, we wanted to give Drauven characters a different set of base stats compared to what humans get. To accomplish this, we created an aspect called <code>nonhuman</code>, whose role it is to reverse certain features that are granted to humans by default and to check for non-human characters in events so that we can require or forbid normal humans from being assigned to various roles.

Please feel free to use this aspect and add it to any new races you create! You can create a text file called <code>assets/data/aspects/races.json</code> and paste the following code:

<pre>
[
{
"id": "nonhuman",
"stats": {
"ARMOR": 0,
"BLOCK": -45,
"CHARISMA": -15,
"DODGE": -45,
"HEALTH": -5,
"MELEE_ACCURACY": -100,
"PERCEPTION": -10,
"PHYSICAL_DAMAGE_BONUS": 0,
"POTENCY": 0,
"RANGE_ACCURACY": -100,
"RECOVERY_RATE": -25,
"RETIREMENT_AGE": -45,
"SPEED": -1,
"STUNT_CHANCE": -15,
"TENACITY": -15,
"WARDING": 0
},
"importance": -1
}
]
</pre>

The above stats will zero-out all the basic human ones, leaving you free to define your own without having to worry about mental math to subtract out the human baseline. You can then add your own racial stats, giving you something that might look like this: ''(Remember that if you're editing a JSON file directly, you will need to make sure there is a comma between each entry in a list, such as between two aspect definitions)''

<pre>
{
"id": "drauven_pc",
"effects": [],
"stats": {
"ARMOR": 0,
"BLOCK": 55,
"CHARISMA": 10,
"DODGE": 35,
"HEALTH": 3,
"MELEE_ACCURACY": 100,
"PERCEPTION": 12,
"PHYSICAL_DAMAGE_BONUS": 0,
"POTENCY": 0,
"RANGE_ACCURACY": 100,
"RECOVERY_RATE": 40,
"RETIREMENT_AGE": 65,
"SPEED": 1,
"STUNT_CHANCE": 15,
"TENACITY": 20,
"WARDING": 0
},
"voice": "defaultDrauven"
}
</pre>

Now go back to your "base" history entry above and add the two new aspects to your <code>impliedAspects</code> list. It should look something like this:

<pre>
"impliedAspects": [
"humanSkin_suppressTorso",
"nonhuman",
"drauven_pc"
]
</pre>

=== Creating an Effect for Faster Character Generation ===

It is possible to create an effect associated with an initialization aspect to help make generating NPCs of your race faster and more consistent. This is especially if you have multiple steps involved in your race assignment such as setting history, applying a theme, and triggering a re-randomization of Customization fields. Whenever an NPC is being generated through <code>implications</code>, you initialization effect will run before the comic starts, so new NPCs will have all of the desired traits.

For example, the Drauven PCs mod uses the following initialization aspect & effect:

<pre>
{
"modId": "wildermyth-drauven-pcs",
"id": "drauven_pc_init",
"effects": [ "drauven_pc_init" ],
"importance": -1,
"showChangeInComics": "never",
"invalidatesSkin": true,
"lifespan": "all"
}
</pre>
<pre>
{
"id": "drauven_pc_init",
"info": {
"dataVersion": 1,
"sourceFile": "drauven_pc_init",
"modId": "wildermyth-drauven-pcs",
"author": "justEthaniguess & Ironskink",
"STUB": "Initialize our Drauven characters"
},
"type": "ABILITIES_CHANGED",
"targets": [
{ "template": "SELF" }
],
"outcomes": [
{
"class": "Aspects",
"removeAspects": [ "drauven_pc_init" ]
},
{
"class": "AddHistory",
"target": "self",
"addHistory": [
[ "drauvenBase" ]
]
},
{ "class": "ApplyTheme", "theme": "drauven", "piece": "torso" },
{
"class": "CustomizeHero",
"randomizeSlots": [ "drauven01_Head", "drauven02_Feathers", "drauven03_Horns", "drauven04_Whiskers" ],
"randomizeColors": [ "skin" ]
}
]
}
</pre>

== Adding Skin Layers ==

Skin layers can be added either using a theme, using aspects, or by a combination of both.

* Layers that are applied to the head or face will include the field <code>"headOffset": true</code>. Names for the files will be exactly the same as the names defined in the layers.
* Layers that are applied to the body will generally be "rig-specific." Names for the image files need to be prefixed with the rig being used for the character. (For example, if the layer is named <code>alternatTorso</code>, the game will look for files named <code>hunterF_alternateTorso.png</code>, etc.

By default, the 6 rigs are <code>hunterF</code>, <code>hunterM</code>, <code>mysticF</code>, <code>mysticM</code>, <code>warriorF</code> and <code>warriorM</code>.

=== Using a Theme ===

A theme is a fast way to set up layers for a character and will automatically overwrite human visuals. Theme parts can also be set to automatically apply if specific other part(s) are present, allowing you to fully transform a character into a member of your custom race by only applying a single part.

A theme allows you to specify other themes that are incompatible with your racial theme (eg: our Drauven are ineligible to get the Wolf, Bear, Gem or Skeletal themes for various lore and graphical reasons). However, if you transform ''all'' of a character's limbs using theme parts, your custom race won't be eligible for any other themes as there are no free slots that can further be transformed.

The easiest way to create a theme is to start from an existing theme (such as Wolf). Copy the file into your mod folder at <code>assets/data/themes</code>, then open the file in either the in-game editor or your favourite text or code editor to change the layer names to match the names of the assets you have created/are creating for your race.

'''If your alternate race will be holding weapons,''' make sure to go to the "arms" layers and remove the <code>leftGrip</code> and <code>rightGrip</code> from the "replaces" list.

=== Using Aspects ===

Aspects can be given an array of <code>skinLayers</code> that work just like the <code>layers</code> in a theme file. An advantage of setting up your skin layers through aspects is that the character's limbs remain free for transformations, thus allowing your custom race to gain transformations just like a human can.

Skin layers can be defined with list of aspects that are required for the layer to show and a list of aspects that should block a layer from showing. This allows you to automatically turn off layers for limbs if that limb is transformed.

For example, our <code>drauvenSkin_naturalLeftLeg</code> aspect is defined to replace the default <code>humanSkin_naturalLeftLeg</code> aspect. It is set to display as long as the leg is not being replaced by a theme limb, bandaged limb or prosthetic limb.

<pre>
{
"modId": "wildermyth-drauven-pcs",
"id": "drauvenSkin_naturalLeftLeg",
"stats": { "SPEED": 1.7 },
"importance": -1,
"invalidatesSkin": true,
"skinLayers": [
{
"name": "Drauv_LegL",
"tint": "skin",
"ifNoOwnerAspects": ["themeSlotFilled_leftLeg", "drauvenSkin_bandagedLeftLeg", "drauvenSkin_prostheticLeftLeg"],
"depth": 1101
}
]
}
</pre>

=== Posing: Heads, Hands & Weapons ===

If your alternate race will be holding items, you will want to make sure you have created one & two handed arm poses plus open, closed, book, and two-handed (closed) hand poses for both the left and right arms/hands. You can check the <code>rigMode</code> to see if the model is being drawn with a one or two handed weapon, and the <code>ifRightHandGrasp</code> and <code>ifLeftHandGrasp</code> attributes to see what the character is holding.

To help with layer ordering, you may want to separate the arms into 'upper' and 'lower' sections and separate the closed & book hands & thumb layers so that they can overlap the items being held appropriately.

Here is an example of layer definitions for the right arm and hand of our Drauven characters:

<pre>
{
"modId": "wildermyth-drauven-pcs",
"id": "drauvenSkin_naturalRightArm",
"importance": -1,
"invalidatesSkin": true,
"skinLayers": [
{
"name": "Drauv_ArmR_upper",
"tint": "skin",
"ifNoOwnerAspects": ["themeSlotFilled_rightArm"],
"depth": 1350,
"rigMode": "oneHanded"
},
{
"name": "Drauv_ArmR_lower",
"tint": "skin",
"ifNoOwnerAspects": ["themeSlotFilled_rightArm"],
"depth": 3000,
"rigMode": "oneHanded"
},
{
"name": "Drauv_ArmR_2handed_upper",
"tint": "skin",
"ifNoOwnerAspects": ["themeSlotFilled_rightArm"],
"depth": 1350,
"rigMode": "twoHanded"
},
{
"name": "Drauv_ArmR_2handed_lower",
"tint": "skin",
"ifNoOwnerAspects": ["themeSlotFilled_rightArm"],
"depth": 8000,
"rigMode": "twoHanded"
}
]
},
{
"modId": "wildermyth-drauven-pcs",
"id": "drauvenSkin_naturalRightHand",
"importance": -1,
"invalidatesSkin": true,
"skinLayers": [
{
"name": "Drauv_handR_open",
"tint": "skin",
"ifNoOwnerAspects": ["themeSlotFilled_rightArm", "drauvenSkin_bandagedRightArm", "drauvenSkin_prostheticRightArm"],
"depth": 6000,
"ifRightHandGrasp": "open",
"rigMode": "oneHanded"
},
{
"name": "Drauv_handR_closed",
"tint": "skin",
"ifNoOwnerAspects": ["themeSlotFilled_rightArm", "drauvenSkin_bandagedRightArm", "drauvenSkin_prostheticRightArm"],
"depth": 8001,
"ifRightHandGrasp": "weapon",
"rigMode": "oneHanded"
},
{
"name": "Drauv_handR_closed_thumb",
"tint": "skin",
"ifNoOwnerAspects": ["themeSlotFilled_rightArm", "drauvenSkin_bandagedRightArm", "drauvenSkin_prostheticRightArm"],
"depth": 6000,
"ifRightHandGrasp": "weapon",
"rigMode": "oneHanded"
},
{
"name": "Drauv_handR_book",
"tint": "skin",
"ifNoOwnerAspects": ["themeSlotFilled_rightArm", "drauvenSkin_bandagedRightArm", "drauvenSkin_prostheticRightArm"],
"depth": 6000,
"ifRightHandGrasp": "book",
"rigMode": "oneHanded"
},
{
"name": "Drauv_handR_book_thumb",
"tint": "skin",
"ifNoOwnerAspects": ["themeSlotFilled_rightArm", "drauvenSkin_bandagedRightArm", "drauvenSkin_prostheticRightArm"],
"depth": 8001,
"ifRightHandGrasp": "book",
"rigMode": "oneHanded"
},
{
"name": "Drauv_handR_2handed",
"tint": "skin",
"ifNoOwnerAspects": ["themeSlotFilled_rightArm", "drauvenSkin_bandagedRightArm", "drauvenSkin_prostheticRightArm"],
"depth": 8002,
"rigMode": "twoHanded"
},
{
"name": "Drauv_handR_2handed_thumb",
"tint": "skin",
"ifNoOwnerAspects": ["themeSlotFilled_rightArm", "drauvenSkin_bandagedRightArm", "drauvenSkin_prostheticRightArm"],
"depth": 6000,
"rigMode": "twoHanded"
}
]
}</pre>

=== Creating Race-Specific Customizations ===

An arbitrary number of customization categories and parts can be defined by creating files in your mod's <code>assets/data/peopleParts</code> file. Each part should be given <code>"type": "extra"</code> and a value for <code>"extraSlot"</code>. All parts that have the same <code>extraSlot</code> value will be grouped together on the customization page, and customizations will be listed in alphabetical order of their <code>extraSlot</code> value.

As of Version 1.10 (Suna Lo Haster), you can specify aspects required for the customization to be displayed in the customization menu, thereby allowing you to hide your racial customizations from normal humans, by adding a <code>requireAspects</code> field. If set, the part will only be available to characters that have all of the aspects listed.

Here is an example of one of our Drauven heads:

<pre>
{
"type": "extra",
"extraSlot": "drauven01_Head",
"requireAspects": ["drauvenSkin_naturalHead"],

"groups": [
{"groupIndex": 0, "male": true, "maleWeight": 1, "female": true, "femaleWeight": 1},
{"groupIndex": 1, "male": true, "maleWeight": 1, "female": true, "femaleWeight": 1},
{"groupIndex": 2, "male": true, "maleWeight": 1, "female": true, "femaleWeight": 1},
{"groupIndex": 3, "male": true, "maleWeight": 1, "female": true, "femaleWeight": 1}
],
"layers": [
{
"name": "replaceHead_drauven_stump",
"tint": "skin",
"depth": 4000,
"headOffset": true,
"ifOwnerAspect": "drauvenSkin_naturalHead",
"ifNoOwnerAspects": ["themePiece_crow_head", "themePiece_wolf_head", "themePiece_tree_head", "themePiece_frog_head"],
"facialExpression": ["neutral", "interested", "grim", "sad", "skeptical", "dubious", "open", "surprised", "scared", "angry", "rage", "scheming", "hit", "dead", "happy", "joke", "joy"]
}
]
}
</pre>

To give user-friendly names to your customization slots, open (or create) a text file as <code>assets/text/dynamic/dynamic.properties</code> and add translations for your extraSlots. For example, the definitions might look something like this:

<pre>
extraPartSlot.drauven01_Head=Head
extraPartSlot.drauven02_Feathers=Feathers
extraPartSlot.drauven03_Horns=Horns
extraPartSlot.drauven04_Whiskers=Whiskers
</pre>

=== Defining a Custom Skin or Hair Palette ===

As of Version 1.10 (Suna Lo Haster), it is possible to define custom skin & hair colour palettes through aspects.

<blockquote>
<code>skinColorPaletteOverride|COLORS</code>
"Override the colors shown in the customization palette. Takes any number of hex parameters, e.g. "skinColorPaletteOverride|ff3333|33ff33|55aaff" (Can give an individual a random one of these colors by using the Customize Outcome)"
</blockquote>

<blockquote>
<code>hairColorPaletteOverride|COLORS</code>
"Override the colors shown in the customization palette. Takes any number of hex parameters, e.g. "skinColorPaletteOverride|ff3333|33ff33|55aaff" (Can give an individual a random one of these colors by using the Customize Outcome)"
</blockquote>

To have these custom palettes apply to your alternate race characters, we recommend adding these aspects to your base racial history entry.

=== The <code>Customize</code> Outcome ===

If your customization aspects are hidden from humans, then they won't be randomly generated when an NPC is created. You can solve this by using the <code>Customize</code> outcome, which will allow you to set or randomize a character's skin colour, hair colour, and one or more of the extra slots. You can see an example of the Customize action in our sample initialization effect above.

=== Alternate Rigs ===

'''COMING SOON'''

Rig Override Aspect: <code>overrideRig|RIG</code>

<blockquote>Override the rig used for this individual (see assets\data\generation\rigs.json) Will search for class and body-type specific versions first, appending Warrior/Hunter/Mystic and M/F to the id.

For example, if RIG is "myRig" and the hero is a male warrior, in order it'll search for myRigWarriorM > myRigWarrior > myRigM > myRig</blockquote>

Rigs are defined in <code>assets/data/generation/rigs.json</code>
<hr />

Once the rig override is available, modders will be able to specify their own rigs - which will make it a lot easier to line up weapons, items, etc!
Note that if you override the rig, the game will be looking for image assets using that new rig name - which means none of the base-game assets will automatically apply to the body of your character! You will need to provide new copies of all files - such as theme limbs, gear, and anything else that begins with a rig-specific prefix for anything that your new rig will support.

== Non-Human Name Generation ==

You can specify a name formula using a history entry that sets the <code>humanName</code>:

For example, to generate a character that uses a name algorithm called <code>drauvenName</code> you could make a history entry that looks like this:

'''Note: This method can cause some buggy behaviour when customizing the character! A better method of assigning the algorithm is in the works and will be available soon!'''

<pre>
{
"id": "bornDrauven.default",
"weight": 0.95,
"category": "bornDrauven",
"humanName": "drauvenName",
"showInSummary": false
}
</pre>

'''COMING SOON:''' A better way to override the name generation algorithm via aspects!

Name Algorithm Aspect: <code>"nameFormulaOverride|ALGORITHM_NAME"</code>

Example: <code>"nameFormulaOverride|drauvenName"</code>

<hr/>

Name formulas are defined in the file <code>assets/data/generation/human.names.json</code>

To create new name definitions for your race, add or edit a file with this name in the same relative location in your mod. This file will be structured as an object where the keys are all of your translation keys and the values define the parts used to construct the names.

Sample name generator:

<pre>
{
"drauvenName": ["<DrauvenFirstName> <DrauvenConstructedSurnamePrefix><DrauvenSurname>"],
"drauvenFirstName": ["_OR_", [2, "<PredefinedDrauvenFirstName>"], [7, "<ConstructedDrauvenFirstName>"], [1, "<DrauvenFirstNameBegin><drauvenFirstNameBegin><drauvenFirstNameEnd>"]],

"predefinedDrauvenFirstName": ["Thuvayn", "Pyarc", "Vrsawl", "Zuvyac", "Colr", "Tranyen", "Mulsc"],

"constructedDrauvenFirstName": ["<DrauvenFirstNameBegin><drauvenFirstNameEnd>"],
"drauvenFirstNameBegin": ["lwa", "lau", "zve", "xar", "vyx", "styx", "ghirr", "tsyx", "mexx", "idgr", "thog", "thuv", "py", "vrs", "zu", "kyv", "ksu", "dra", "ts", "dee", "vra", "tsyr", "mul", "tran", "co", "du", "kyo", "kree", "cv", "ady", "boh", "dorb", "dar", "dra", "bor", "groz", "ylc", "kal", "uvz", "dyg", "auk", "yvy", "kve", "cas", "marz", "kras", "lju", "rost", "zbyh", "ves", "srbi", "zahv", "zby", "jaro", "zyz", "osor", "przby", "tych", "vla", "vyas", "zvez"],
"drauvenFirstNameEnd": ["ysl", "yn", "ayn", "arc", "rc", "rn", "orr", "rek", "ra", "reth", "veth", "xis", "eth", "rok", "xra", "rel", "duk", "yrn", "ish", "ysh", "wn", "osk", "ysk", "ssl", "xol", "awl", "vyac", "orr", "arr", "lr", "lrr", "yen", "sc", "st", "mpv", "yost", "esna", "ka", "jek", "rig", "rut", "myr", "oza", "zet", "ska", "vak", "wia", "cno", "acz", "ki", "cko"],

"drauvenConstructedSurnamePrefix": ["_OR_", [2, ""], [1, ""]],
"drauvenSurname": ["_OR_", [2, ""], [1, ""]],

"drauvenHostileFaction": ["_OR_", [1, "Zagarac"], [1, "Druvimos"]],
"drauvenOutpostName": ["<DrauvenFirstNameBegin><drauvenFirstNameEnd> Outpost"],

}
</pre>

When we tell the game to use the `drauvenName` generator, the code will read the entry and see that we need to pick a ''DrauvenFirstName'', a ''DrauvenConstructedSurnamePrefix'' and a ''DrauvenSurname''. Capitalization comes from the capitalization of the various pieces: specifying ''DrauvenFirstName'' will capitalize whatever is chosen, but using ''drauvenFirstName'' will not.

The ''drauvenFirstName'' entry showcases an example of the <code>_OR_</code> option. Everything following the OR is an array with two values. The first value specifies the relative weight/probability of that option being chosen, and the second entry specifies what to generate when that entry is selected. In this case, ''drauvenFirstName'' has a 2-in-10 chance of selecting a ''PredefinedName'', a 7-in-10 chance of a ''ConstructedDrauvenName'', which is later defined to be one beginning-sound followed by an ending-sound, and a 1-in-10 chance of combining two beginning-sounds with one ending-sound.

As of Version 1.10 (Suna Lo Haster), the name generator will no longer wipe out other name generators if they have different keys, thereby allowing multiple mods to create arbitrary name generation algorithms. (If your mod includes a key that is identical to one in the base game or another mod, the new definition will overwrite the old one.)

== Non-Human Abilities & Skills ==

You can create a skill deck for your mod and use that to create custom abilities that your characters can select at level-up. Skills are granted by <code>aspects</code>, so start by creating a new file in your <code>assets/data/aspects</code> folder to hold your skill selections. (For example, you might call it <code>assets/data/aspects/drauvenDeck.json</code>)

=== Adding Race-Specific Skills ===

A race-specific skill with an upgrade might look something like this:

<pre>
{
"modId": "wildermyth-drauven-pcs",
"id": "drauvenDeck_common_battleyell",
"effects": [ "drauven_pc_battleyell" ],
"boostType": "ABILITY_CLASS",
"legacyAbilityChoice": true,
"abilityRequiresOneAspectOf": [ "drauven_pc" ],
"info": { "abilityDeckUsage": "common", "abilityDeckIcon": "bloodrage" }
},
{
"modId": "wildermyth-drauven-pcs",
"id": "drauvenDeck_common_battleyell_upgrade",
"legacyAbilityChoice": true,
"abilityRequiresOneAspectOf": [ "drauven_pc" ],
"info": {
"abilityDeckUsage": "upgrade",
"upgradeForAbility": "drauvenDeck_common_battleyell",
"abilityDeckIcon": "bloodrage"
}
}
</pre>

* Using <code>abilityRequiresOneAspectOf</code> we can specify our custom race aspect so that the ability is only offered to our custom characters
* The <code>effects</code> entry will point to the ID of the actual ability (effect) being granted. (See [[Modding monster abilities]] for some additional info on creating ability effects)
* The <code>abilityDeckUsage</code> can be set to <code>common</code> to make it available to all members of your race, or <code>warrior</code>, <code>hunter</code> or <code>mystic</code> to make it both race and class specific.

=== Blocking Human-Only Skills ===

As of Version 1.10 (Suna Lo Haster), if there are skills in the game that you want to keep as human-only you can find those skills in the base game files and copy them into your mod's skill deck file to add a <code>abilityForbidAspects</code> field to them.

<blockquote>
<code>abilityForbidAspects</code>
If this is an ability aspect, this ability will only be granted to a hero if that hero has none of these aspects.
</blockquote>

For example, if you want to block Wolfcall from being offered to your custom race, you would add the following to your aspect file:

<pre>
{
"id": "warriorDeck_wolfcall",
"effects": [ "warrior_wolfcallTriggerOnKill" ],
"boostType": "ABILITY_CLASS",
"legacyAbilityChoice": true,
"abilityForbidAspects": ["drauven_pc"],
"showInTooltip": true,
"info": { "abilityDeckUsage": "warrior", "abilityDeckIcon": "wolfcall" }
}
</pre>

== Relatives: Parents & Children ==

Wildermyth is all about family legacies - and when adding a custom race, it is also possible to update events so that any relatives will also be members of your custom race!

=== Children Joining the Party ===

Children are added to the party through the file <code>assets/data/effects/kidRecruit/officialNotification.json</code>. The child's primary parent has the role of <code>sponsor</code>.

In the <code>outcomes</code> section of this file, you can add a <code>Test</code> for the race of the character in the <code>sponsor</code> role and apply your initialization effect if appropriate. For example, in our Drauven mod we use the following:

<pre>
{
"class": "Test",
"value": "sponsor.drauven",
"threshold": "1",
"onPass": {
"class": "Aspects",
"target": "hero",
"addAspects": [
{ "id": "drauven_pc_init", "value": "1" }
]
}
}
</pre>

=== Parents in Comics ===
Many events generate parents or relatives for characters. To find events that might be generating related characters, use a tool that allows you to search for text in multiple files (such as the project-search feature in VS Code) for instances of <code>"looksSimilarTo"</code>.

If the role being generated is a relative of one of your heroes, copy the event to your mod (following the same folder structure that the original event was found in) and duplicate the NPC generation code. We will add a <code>test</code> to each version of the NPC to check if the character they look similar to is of our custom race and apply the initialization effect we made if true.

For example, "Family Business" (<code>encounter_wilderness_familyBusiness_revision.json</code>) defines Parent1 as:

<pre>
{
"npcId": "familyBusiness_Parent1",
"createEntity": {
"query": {
"baseTag": "human",
"inRelationTo": "hero",
"setClass": "farmer",
"setAge": "veryOldAge",
"looksSimilarTo": "hero"
},
"additionalOutcome": {
"class": "DoAll",
"outcomes": [
null,
{ "class": "AddGear", "itemById": "farmerGarbRough" }
]
}
}
</pre>

To make the parent Drauven if the hero is themselves Drauven, we update this section by adding a copy of the initial version. The version that tests for <code>1 - \[our race aspect\]</code> will be executed if the character is ''not'' a member of our customer race, and the version that simply tests for our racial aspect will generate if the hero in question is a member of our custom race. For example:

<pre>
{
"npcId": "familyBusiness_Parent1",
"test": "1-hero.drauven",
"createEntity": {
"query": {
"baseTag": "human",
"inRelationTo": "hero",
"setClass": "farmer",
"setAge": "veryOldAge",
"looksSimilarTo": "hero"
},
"additionalOutcome": {
"class": "DoAll",
"outcomes": [
null,
{ "class": "AddGear", "itemById": "farmerGarbRough" }
]
}
}
},
{
"npcId": "familyBusiness_Parent1",
"test": "hero.drauven",
"createEntity": {
"query": {
"baseTag": "human",
"inRelationTo": "hero",
"setClass": "farmer",
"setAge": "veryOldAge",
"looksSimilarTo": "hero"
},
"addAspects": [
{ "id": "drauven_pc_init", "value": "1" }
]
}
}
</pre>

=== Mod Conflicts & Coordination ===

If multiple mods are installed that overwrite these files & check for relatedness, only one mod will be able to win. Is there a way that we can coordinate our efforts to test for race more generically and apply the appropriate effect across multiple mods? Feel free to join the Wildermyth Discord to discuss this in the #tools-and-modding channel!

[[Category:Modding]]
[[Category:Modding Guides]]

Modding alternate races

2022-12-12T16:06:28Z

Ironskink: Initial page creation