Guide · Mod compatibility

Immersive Melodies Instrument Animations

Since 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.

How Immersive Melodies Integration Works

Immersive Melodies animations work as conditional hand animations that trigger when a player holds and plays a supported instrument. Instead of playing a static loop, YSM reads real-time audio and note data from the Immersive Melodies mod to drive bone movements.

Why it matters: Using live performance data makes your character look like they are actually playing the song rather than repeating a stiff, pre-baked motion. Note that this integration requires YSM version 2.6.0 or newer.

Setting Up the Animation File

By default, all instrument animations are stored in a dedicated file named im.animation.json. Because there are many individual animation clips required for every instrument state, the best way to start is by copying or referencing the im.animation.json file from the default YSM model.

If you want to store your instrument animations in a custom folder or under a different file name, you must register the path in your ysm.json file. You can do this by adding the immersive_melodies key inside the animation object.

  1. Open your model pack's ysm.json file.
  2. Locate the animation object.
  3. Add the immersive_melodies property and point it to your custom animation file path.
"animation": {
    "main": "animations/main.animation.json",
    "immersive_melodies": "animations/im.animation.json"
}
Always inspect the default model's im.animation.json file to see the exact animation clip names required for each instrument.

Supported Instrument IDs

Each instrument in Immersive Melodies has a specific English ID used to match animations to the held item. When naming or editing your animations in im.animation.json, you will see these identifiers used for each instrument type.

Here is the complete list of supported instruments and their corresponding IDs:

Bagpipe       -> bagpipe
Didgeridoo    -> didgeridoo
Flute         -> flute
Lute          -> lute
Piano         -> piano
Triangle      -> triangle
Trumpet       -> trumpet
Tiny Drum     -> tiny_drum
Vielle        -> vielle
Ender Bass    -> ender_bass
Handpan       -> handpan

Driving Details with Molang Variables

YSM provides five dedicated Molang variables that let you control fine animation details like finger pressure, body sway, and breathing rhythm. You can use these variables inside your bone rotation and position expressions in Blockbench.

Understanding what each variable outputs allows you to link specific musical changes to physical movements on your model:

  1. ctrl.im_current: The current signal level intensity, ranging from 0 to 1. Great for mouth movement, chest expansion, or glowing effects while sound is actively playing.
  2. ctrl.im_delta: The time elapsed since the last note was played, measured in milliseconds (ms). Useful for returning hands to a resting pose during pauses.
  3. ctrl.im_pitch: The pitch of the current note, typically ranging from 0 to 2 depending on the note being played. Ideal for moving a hand up and down a flute, lute neck, or piano keyboard.
  4. ctrl.im_volume: The strength or velocity of the note, typically ranging from 0 to 2. Use this to scale how hard the character strikes a drum or strums strings.
  5. ctrl.im_time: The total accumulated time since the performance started, measured in milliseconds (ms). Helpful for driving continuous background motions like foot tapping or body swaying.
ctrl.im_current
ctrl.im_delta
ctrl.im_pitch
ctrl.im_volume
ctrl.im_time
Combine ctrl.im_pitch with bone position offsets so your character's fingers slide higher or lower along an instrument neck as the melody changes pitch.

Questions

Which version of YSM do I need for Immersive Melodies animations?

You need Yes Steve Model version 2.6.0 or higher for the Immersive Melodies integration and its Molang variables to work.

Where can I find the full list of animation names for every instrument?

Because there are many animations involved, they are not listed manually in the documentation. Open the im.animation.json file inside the default YSM model pack to see the complete list of required animation names.

Do I have to declare immersive_melodies in ysm.json?

You only need to add the immersive_melodies key in ysm.json if you want to change the default file path of im.animation.json.

How do I make my character's hand move harder when a loud note is played?

Multiply your bone's rotation or position keyframe value by ctrl.im_volume, which outputs a value typically between 0 and 2 based on the note's strength.

Next: Iron's Spells 'n Spellbooks Animations →

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
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.
C
SlashBlade Animations GuideStarting from version 2.3.0, Yes Steve Model (YSM) includes native animation compatibility for the SlashBlade mod, supporting both the legacy SlashBlade and SlashBlade: Resharped. This guide covers how to set up the required bone locators in your model, register the animation file in your configuration, and use in-game debugging tools to identify specific sword skill animation names.