Skip to content

Animation Overview

MasuHolograms features a fully file-based animation system. All animations are defined as JSON files in config/masuholograms/animations/. You can modify the default animations and create entirely new ones.

How Animations Work

Animations cycle through visual states on each tick. The speed parameter controls how many ticks pass between each animation step, and the pause parameter adds a delay after the animation completes before restarting.

The animation system processes text within {#ANIM:name}...{/#ANIM} tags, replacing the content with the animated version based on the current step.

Animation Syntax

Standard Syntax

{#ANIM:animationName}Your text here{/#ANIM}

Alternative Syntax

<#ANIM:animationName>Your text here</#ANIM>

Both syntaxes are equivalent. Use whichever you prefer.

Color Shortcut

The &u code is a shortcut for the colors animation:

&uRainbow cycling text

This is equivalent to {#ANIM:colors}Rainbow cycling text{/#ANIM}, except &u applies to the rest of the line (no closing tag needed).

Animation Parameters

All animation types share these parameters:

Parameter Type Default Description
type string Required Animation algorithm (typewriter, wave, burn, scroll, colors, frames)
speed int varies Ticks between animation steps (higher = slower)
pause int varies Ticks to pause after animation completes

Additional parameters depend on the animation type. See Built-in Animations and Custom Animations.

Using Animations

In Commands

/mh line set myHolo 1 1 {#ANIM:typewriter}&6Welcome to the Server!{/#ANIM}
/mh line set myHolo 1 1 {#ANIM:wave}Colorful Wave Effect{/#ANIM}
/mh line set myHolo 1 1 &uRainbow Color Cycling

With Placeholders

By default, placeholders inside animations are not resolved. Enable this in config.json:

{
  "allowPlaceholdersInsideAnimations": true
}

Then you can use:

/mh line set myHolo 1 1 {#ANIM:typewriter}Online: {online}/{max_players}{/#ANIM}

Multiple Animations Per Line

You can have multiple animation segments in a single line:

/mh line set myHolo 1 1 {#ANIM:wave}Hello{/#ANIM} &7- {#ANIM:colors}World{/#ANIM}

Disabling Animations

Per Hologram

/mh hologram addflag myHolo DISABLE_ANIMATIONS

Per Line

/mh line addflag myHolo 1 1 DISABLE_ANIMATIONS

Globally

Animations are always active unless disabled via flags. There is no global disable toggle — use flags on individual holograms.

File Location

All animation files live in:

config/masuholograms/animations/

On first startup, 6 default animation files are generated. You can modify these or add new ones. Run /mh reload after making changes.

Next Steps