Text Effects

This library adds text effects which can be used by servers and mods to add unique effects to component-based text.

Integrated effects:

• Wobble

• Shake

• Marquee

  ... and more

Usage

Add Dependency

build.gradle.kts:

repositories { // ... maven("https://maven.axolotlclient.com/releases") } dependencies { // ... // use modImplementation for versions <26.1 if on fabric implementation("io.github.moehreag:text-effects:<VERSION>") }

Apply Effects

// A few other pre-made effects are available in the `TextEffects` class. // Usage may differ slightly depending on game version. var text = Component.literal("This is a text with effect!").withStyle(Style.EMPTY.text_effects$withEffect(TextEffects.WOBBLE));

Create your own effects

A few factory methods for common operations are provided in the TextEffect class. Some pre-made effects are provided in the TextEffects class, with a few additional helper methods as well as registration handling. If you'd like to build on top of another effect you can use TextEffect#combine.

public static TextEffect CUSTOM_EFFECT = TextEffects.register(Identifier.fromNamespaceAndPath("modid", "custom_effect"), TextEffect.constantYOffset(-2));

Effects are automatically able to be de/serialized in components using their id provided at registration.

{ text: "text with a nice effect", text-effects: "text-effects:wobble" }

This component works for 26.1, it may not for earlier minecraft versions.

This format can also be used in commands, for example /tellraw.