waveTextLib

waveTextLib

waveTextLib is an incomplete, personal Minecraft Forge library for creating animated and stylized text.

It provides simple APIs for combining text effects such as wave motion, gradients, animated gradients, and per-character effects.

The library was originally created for my own projects, so it may not always be designed with general-purpose use in mind. The API and implementation may change as the project develops.

Please note that some features described here may be incomplete, experimental, or not yet fully implemented. The documentation may also get ahead of the actual implementation from time to time.

If you find it useful, feel free to use it. If it doesn’t fit your needs, you’re also free to use another library or modify this one under the MIT License.

Example

AnimatedText text = AnimatedText.of("TestHalo")
        .wave(3.0f, 1.00f, 0.50f)
        .gradient(0xFFFFFF, 0x00FFFF)
        .gradientSpeed(1.00f)
        .gradientPhase(0.50f);

Effects can be chained together to create animated text without having to implement each effect separately.

Features

• Animated text rendering
• Per-character wave effects
• Gradient and animated gradient effects
• Extensible position and color effects
• Unicode code point-based rendering
• Minecraft Font-based character width calculation

Compatibility

• Minecraft Java Edition 1.20.1
• Forge 47.x

This library is primarily made for my own projects. If it happens to be useful to you, that’s great!