FrameUI Documentation

FrameUI

FrameUI adds animated transitions after joining a server, teleporting or changing worlds. Start with 50 animation templates and 10 ready-made designs, then customize colors, images, captions, timing and loading indicators in FrameUI Studio.

Get FrameUI on Plugin Hub.

The plugin requires Java 25 or newer on the server and Paper 1.21.11–26.3, inclusive. Use a matching vanilla first-person Minecraft Java Edition client in that range. Players must accept its generated resource pack. Effects start after the client world and resource pack are available; Minecraft controls its own startup and terrain-download screens.

FrameUI Signature, rendered in Studio. Browse every design in the effect gallery.

Start Here

Getting Started Install FrameUI, accept the resource pack and preview your first effect.

Effect Gallery Watch all 60 bundled designs and find their exact preview commands.

Automatic Playback Assign joins, teleports, world changes and optional plugin events.

FrameUI Studio Create, preview, import and save effects from the browser editor.

Configure Your Server

Each effect has its own YAML file. Global and individual filters combine to control who sees it, where it plays and how often it can run. Higher priorities win; weights choose between equally prioritized candidates.

Commands and Permissions Every command, alias, default permission and runnable example.

config.yml Languages, common filters, legacy playback pools and resource-pack delivery.

Effect Files Timing, palettes, captions, images, screen elements and validation rules.

Filters and Selection Worlds, permissions, cooldowns, distance, time, weather and event destinations.

Messages and Languages Customize chat panels and choose from 28 bundled languages.

Plugin Integrations Homes, warps, portals, towns, lands, islands and PlaceholderAPI.

For connection, pack or playback problems, use Troubleshooting. FrameUI is proprietary; Studio is a separate, open-source browser editor. The editor is not included in the plugin JAR.