NPC Attachments
NPC attachments define customizable parts that can be attached to character models, including eyes, ears, hair, beards, and faces. These are primarily used for player character customization but can also be applied to humanoid NPCs.
Asset Locations
Section titled “Asset Locations”DirectoryAssets/Common/Characters/
DirectoryBody_Attachments/
DirectoryEyes/
- Eyes.blockymodel
- Eyes_Fullbright_Pupil.blockymodel
DirectoryEyes_Textures/
- …
DirectoryEars/
- Ears1.blockymodel
- Elf_Ear_Small.blockymodel
DirectoryEyebrows/
- …
DirectoryMouths/
- …
DirectoryFaces/
- Player_Face_Detached.blockymodel
DirectoryBeards/
- Full.blockymodel
- VikingBeard.blockymodel
- (35+ beard styles)
DirectoryHaircuts/
- GenericShort.blockymodel
- PonyTail.blockymodel
- Mohawk.blockymodel
- (180+ hairstyles)
- Player.blockymodel
DirectoryPlayer_Textures/
- …
Attachment Types
Section titled “Attachment Types”Eye attachments define the eye shapes and textures for characters.
| Model | Description |
|---|---|
Eyes.blockymodel | Standard eyes |
Eyes_Fullbright_Pupil.blockymodel | Eyes with bright pupils |
Available Textures:
Greyscale.png- Standard grayscale (for tinting)Greyscale_Large.png- Larger eye variantAlmond_Greyscale.png- Almond-shaped eyesPlain_Greyscale.png- Simple eye designEyes_Square_Pupil.png- Square pupil styleOutlander_Brown.png- Brown outlander eyesOutlander_Red.png- Red outlander eyes
Ear attachments provide different ear shapes.
| Model | Description |
|---|---|
Ears1.blockymodel | Standard ears |
Elf_Ear_Small.blockymodel | Small elven ears |
Beards
Section titled “Beards”Beard attachments for facial hair customization.
| Category | Styles |
|---|---|
| Short | Goatee, SoulPatch, ThinGoatee |
| Medium | Full, Trimmed, Groomed, Medium |
| Long | Full_Long, GoateeLong, Large |
| Styled | Curly, Wavy, Handlebar, TwirlyMoustache |
| Braided | DoubleBraid, TripleBraid |
| Themed | PirateBeard, PirateGoatee, VikingBeard, Soldier |
| Simple | Simple, SimpleLong, ShortTrimmed |
Full Beard List:
- ChinCurtain, Curly, Full, Full_Long
- Goatee, GoateeLong, Groomed, Groomed_Large
- Handlebar, Hip, Large, Medium
- Moustache, PirateBeard, PirateGoatee
- ShortTrimmed, Simple, SimpleLong
- Soldier, SoulPatch, Stylish
- ThinGoatee, Trimmed, TripleBraid
- TwirlyMoustache, VikingBeard, Wavy
Most beards use _Greyscale.png textures for color tinting.
Haircuts
Section titled “Haircuts”Over 180 hairstyle options organized by category:
| Category | Examples |
|---|---|
| Short | GenericShort, SuperShort, Short, Quiff, QuiffLeft |
| Medium | GenericMedium, BobCut, SimpleBobcut, MessyBobcut |
| Long | GenericLong, Long, LongCurly, WavyLong, LongBangs |
| Ponytails | PonyTail, SidePonytail, PuffyPonytail, WavyPonytail, WidePonytail |
| Braids | Braid, BraidDouble, ThickBraid, WavyBraids, BraidedPonytail |
| Buns | Bun, FighterBuns, PonyBuns, SideBuns, StraightHairBun, RoseBun, ElfBackBun |
| Pigtails | Pigtails, LongPigtails, SmallPigtails, LongHairPigtail, SingleSidePigtail |
| Curly | Curly, CurlyShort, MediumCurly, LongCurly, FrizzyLong |
| Wavy | WavyShort, WavyLong, MessyWavy, EmoWavy, OmbreWavy |
| Mohawks | Mohawk, RaiderMohawk |
| Dreadlocks | Dreadlocks, Dreadlocks02, Dreadlocks03, ShortDreads |
| Bangs | Bangs, LongBangs, EmoBangs, CuteEmoBangs, BangsShavedBack, Fringe |
| Slicked | Slickback, SuperSlickback, Sideslick, SuperSideSlick |
| Cultural | Cornrows, BantuKnot, AfroPuffs, Frizzy_Volume |
| Themed | Viking, VikingWarrior, Viking_TopKnot, Samurai, Berserker |
| Emo/Scene | Emo, EmoBangs, EmoWavy, CuteEmoBangs |
| Fantasy | Cat, Wings, Witch, MaleElf, ElfBackBun |
Detached face attachments for special character types.
| Model | Description |
|---|---|
Player_Face_Detached.blockymodel | Detached face for customization |
Eyebrows & Mouths
Section titled “Eyebrows & Mouths”Additional facial feature attachments.
| Type | Location |
|---|---|
| Eyebrows | Body_Attachments/Eyebrows/ |
| Mouths | Body_Attachments/Mouths/ |
Texture Conventions
Section titled “Texture Conventions”Greyscale Textures
Section titled “Greyscale Textures”Most attachments use grayscale textures (*_Greyscale.png) that are tinted at runtime:
Beard_Greyscale.png → Tinted to match hair colorHaircut_Greyscale.png → Tinted to match selected colorEyes_Greyscale.png → Tinted to match eye colorThis allows a single model/texture to support multiple colors.
Color Textures
Section titled “Color Textures”Some attachments have pre-colored textures:
Outlander_Brown.png → Fixed brown colorOutlander_Red.png → Fixed red colorCreating Custom Attachments
Section titled “Creating Custom Attachments”Hair Attachment
Section titled “Hair Attachment”MyPlugin_Haircut.blockymodelMyPlugin_Haircut_Greyscale.pngRequirements:
- Model anchored to head bone
- Grayscale texture for color tinting
- Proper UV mapping
Beard Attachment
Section titled “Beard Attachment”MyPlugin_Beard.blockymodelMyPlugin_Beard_Greyscale.pngRequirements:
- Model anchored to jaw/chin area
- Grayscale texture for tinting
- Compatible with face animations
Eye Attachment
Section titled “Eye Attachment”MyPlugin_Eyes.blockymodelMyPlugin_Eyes_Greyscale.pngRequirements:
- Model positioned at eye sockets
- Support for blinking animations
- Grayscale for iris color tinting
Best Practices
Section titled “Best Practices”- Use grayscale textures - Enables color customization
- Follow bone naming - Match existing attachment points
- Test with animations - Verify attachments move correctly
- Optimize geometry - Keep polygon count reasonable
- Match art style - Follow Hytale’s voxel aesthetic
- Consider clipping - Test with various body types
- Support tinting - Use grayscale for customizable colors
Related
Section titled “Related”- NPC Overview - NPC system overview
- Model Definitions - NPC model configuration
- NPC Behaviors - Behavior system
- NPC Groups - Group membership