Guide · Mod compatibility

Touhou Little Maid Animations

Starting from YSM version 2.4.0, you can apply YSM character models directly to maids from the Touhou Little Maid mod. This guide covers how to set up backpack attachment points, register the maid animation file in your configuration, and create custom poses for maid-specific interactions like riding brooms, playing board games, and sitting on cushions.

Overview and Version Requirements

Full compatibility with the Touhou Little Maid mod was introduced in YSM 2.4.0. This feature allows players to replace standard maid appearances with any custom YSM model while retaining all maid behaviors.

To make a model look natural when used by a maid, creators can define a dedicated bone for maid accessories and supply a specialized animation file that handles unique maid activities.

Setting Up the Backpack Locator Bone

You must create a bone named BackpackLocator in your model to properly display maid backpacks and back accessories. Without this locator group, items equipped on the maid's back will not align correctly with your custom character's spine.

Position the BackpackLocator pivot point right between the character's shoulders. In addition to rendering maid backpacks, the mod also uses this exact bone as the attachment reference when a maid has a banner or a SlashBlade placed in her cosmetic slot.

Registering the Maid Animation File

To enable custom maid animations, you must declare the tlm animation key inside your model's ysm.json file. Typically, this key points to an animation file named animations/tlm.animation.json.

You can inspect the default model's tlm.animation.json file as a template when building your own poses.

  1. Open your model's ysm.json configuration file.
  2. Locate the animation object.
  3. Add the tlm key and point it to animations/tlm.animation.json.
  4. Create or edit tlm.animation.json inside your animations folder.
"animation": {
    "main": "animations/main.animation.json",
    "arm": "animations/arm.animation.json",
    "extra": "animations/extra.animation.json",
    "tac": "animations/tac.animation.json",
    "carryon": "animations/carryon.animation.json",
    "parcool": "animations/parcool.animation.json",
    "swem": "animations/swem.animation.json",
    "slashblade": "animations/slashblade.animation.json",
    "tlm": "animations/tlm.animation.json"
}
If you edit your maid animations and they fail to play in-game, always verify that the tlm entry is properly declared in ysm.json first.

Maid Activity and Furniture Animations

All animations inside tlm.animation.json are set to loop continuously while the maid performs a specific task or interacts with furniture. Creating these poses prevents your model from clipping into mod blocks.

Use the following animation names for furniture and travel interactions:

gomoku: Plays when the maid sits next to a Gomoku board, Xiangqi (Chinese chess) board, or international chess board.

bookshelf: Plays when the maid is sitting on a bookshelf.

computer: Plays when the maid sits at a computer desk.

keyboard: Plays when the maid sits at an electronic keyboard.

picnic: Plays when the maid sits on a picnic mat.

broom: Plays while the maid is flying on a broom.

chair: The fallback animation that plays when the maid sits on any standard cushion.

Reactions and Display Animations

You can customize how the maid reacts to the player or appears when turned into a decorative block. Like the furniture poses, all of these animations loop while active.

beg: Plays continuously when a player stands near the maid while holding a cake.

game_win: Plays when the maid wins a board game match.

game_lost: Plays when the maid loses a board game match.

statue: Controls the pose used when the maid model is rendered as a statue.

garage_kit: Controls the pose used when the maid model is rendered as a miniature figurine (garage kit).

Conditional Cushion Animations

You can assign unique sitting animations to different Touhou Little Maid cushions by appending $ and the cushion's model ID to the chair animation name. Even though all cushions in the maid mod share the exact same entity ID, YSM supports conditional matching based on the cushion's visual model.

This matters because sitting on a classroom chair requires a completely different posture than straddling a motorcycle cushion. Name your animation starting with chair, followed by $, and then the full resource ID of the cushion model.

chair$touhou_little_maid:class_chair
chair$touhou_little_maid:moto
Always keep a basic chair animation in your file as a fallback for cushions that do not have a dedicated conditional animation.

Questions

Why are my custom maid animations not showing up in the game?

Check your ysm.json file and make sure you added "tlm": "animations/tlm.animation.json" inside the "animation" block. Without this declaration, YSM will ignore your custom maid animation file.

Where on the skeleton should I put the BackpackLocator bone?

Place the BackpackLocator bone right between the model's shoulders. This ensures maid backpacks, decorative banners, and cosmetic SlashBlades sit naturally on the character's back.

How do I make my maid sit differently on the motorcycle cushion compared to a normal chair?

Create a conditional animation named chair$touhou_little_maid:moto inside your tlm.animation.json file. YSM will play that specific animation when the maid rides the motorcycle cushion while using the standard chair animation for other seats.

What version of YSM do I need to use models on Touhou Little Maid entities?

You need Yes Steve Model version 2.4.0 or newer.

Next: Common Molang Snippets and Tricks for YSM Models →

More in Mod compatibility

C
Better Combat Animations in Yes Steve ModelStarting from version 2.6.0, Yes Steve Model (YSM) features improved compatibility with the Better Combat mod. Weapon swings now properly trigger YSM animations without first-person head clipping issues, and creators can use new Molang variables to build custom, dynamic combat animation controllers.
C
Carry On Mod Compatibility AnimationsYes Steve Model (YSM) includes built-in animation support for the popular Carry On mod, which lets players pick up blocks, mobs, and other players by holding Shift and right-clicking. By adding a dedicated animation file to your model pack, you can create custom poses for both the carrier and the player being carried.
C
Gun animations for TaCZ and Superb WarfareYes Steve Model includes built-in animation support for popular firearm mods, allowing your custom character models to hold, aim, reload, and fire weapons naturally. All gun animations are stored in a dedicated tac.animation.json file and use a split upper-body and lower-body system to save you animation work.
C
Immersive Melodies Instrument AnimationsSince version 2.6.0, Yes Steve Model (YSM) includes deep integration with the Immersive Melodies mod. This feature allows your custom character models to react dynamically to live performance data, such as note pitch, volume, and timing. By setting up these animations, your model can realistically strum, blow, or strike instruments in sync with the music.
C
Iron's Spells 'n Spellbooks AnimationsSince version 2.6.0, Yes Steve Model (YSM) supports custom spellcasting animations for the Iron's Spells 'n Spellbooks mod. By linking a dedicated animation file in your model configuration, your character can perform unique movements for projectiles, slashes, and long chants. This guide covers how to register the animation file and lists every available spell animation trigger.
C
ParCool Parkour AnimationsYes Steve Model (YSM) includes built-in compatibility for the ParCool mod starting since version 2.2.2, allowing custom models to display dynamic parkour movements. By linking a dedicated animation file in your configuration, you can customize wall runs, vaults, rolls, and flips to fit your character's unique proportions.