Overlay Animation API

This library is specifically designed for MCreator users and provides tools for working with screen animations and overlays.

Main Features

The library includes built-in effects: static overlays, hypnotic patterns, and screen color tints. Custom animations and overlays are also supported.

How It Works

Animation management is done through commands for maximum convenience. Simply execute a command as an entity to activate the desired effect.

External Overlays and Animations

/overlayapi external <key> <red> <green> <blue> <alpha> <max_frames> <delay> <file_path>
Example: " /overlayapi external blueFire .0 0 .4 1 32 1 minecraft:textures/block/fire_1.png "

Built-in Effects

/overlayapi internal static <key> <red> <green> <blue> <alpha> <delay>
/overlayapi internal tint <key> <red> <green> <blue> <alpha>
/overlayapi internal swirl <key> <background_red> <background_green> <background_blue> <foreground_red> <foreground_green> <foreground_blue> <alpha> <delay>

Standard Minecraft Effects

/overlayapi minecraft pumpkin <key> <alpha>

Removing Effects

/overlayapi clear all
/overlayapi clear key <key>

Compatibility

The library supports Minecraft versions starting from 1.16.5 and above. Support for different versions may vary.

Usage in Modpacks

Since this is a library, it can be freely used in mod packs.