Getting Started

Requirements

Requirement	Supported setup
Server	Paper 1.21.11 through 26.3, including both endpoints
Java	Java 25 or newer on the server, including Paper 1.21.11
Client	Matching vanilla first-person Minecraft Java Edition 1.21.11 through 26.3, inclusive
Resource pack	Players must accept the FrameUI pack
Connected editor	Outbound HTTPS access from the Minecraft server

Bedrock/Geyser clients and rendering mods have not been qualified. Check the finished effect in the client configuration your players use.

The supported release range includes 1.21.11, 26.1, 26.1.1, 26.1.2, 26.2 and 26.3. The generated resource pack automatically selects the appropriate shader files for the player’s client version.

Install the Plugin

Download the plugin from FrameUI on Plugin Hub.

Stop the server and place FrameUI.jar in plugins/.
Start the server. FrameUI creates plugins/FrameUI/ with configuration, effects, images, languages and addon settings.
Join with an operator account and accept the required resource pack.
Run /frameui, then /frameui preview aurora.
Run /frameui stop to close an active or pending preview.

The default maintained connection handles Studio and resource-pack delivery. You do not need to open an inbound port or change the loopback pack URL for this default setup. The direct resource-pack.public-url is used when editor.relay.enabled is false.

Browse the Effects

/frameui effects
/frameui effects animations 1
/frameui effects presets 1
/frameui preview aurora
/frameui preview random

Selecting an effect row in the catalog runs its preview when you have preview permission. Catalog access and preview access are separate permissions. The effect gallery includes a video and command for every bundled effect.

Enable an Automatic Effect

Automatic event assignments are empty by default. A working manual preview does not automatically enable join or teleport playback.

Run /frameui editor and open your personal link.
Select an animation or preset and customize it.
Open Events → When to play and select Join, Teleport or World change.
Click Import to server. Editing a bundled design creates a custom copy.
Accept the refreshed pack, then trigger the selected event.

Existing custom effects use Save to server. Filters and cooldowns still apply to automatic effects and manual previews. See Automatic Playback.

Install an Exported ZIP

Studio also works without a server connection. Click Export effect, extract the ZIP into plugins/FrameUI/, and merge its effects/ and optional images/ folders with the existing folders. Run /frameui reload, accept the refreshed pack and test /frameui preview <id>.

Keep a backup before replacing an existing ID. A new ID creates a separate effect. See Import and Export for the complete workflow.