Getting Started

Getting Started

Applies to Teleport Animation across all supported versions. Version numbers differ per branch — see the table on Home.

Requirements

Waystones	optional
Create: Kinetic Waypoints	optional, NeoForge 1.21.1 only
Loader	NeoForge, Forge or Fabric, per branch
Java	21

The mod only animates teleports from supported mods — Waystones (all builds) and Create: Kinetic Waypoints (NeoForge 1.21.1 only). Without at least one of them there is nothing to animate.

Install it

Drop the JAR in mods/ on the client. Make sure Waystones (or, on NeoForge 1.21.1, Create: Kinetic Waypoints) is installed too.

This is a client-side visual effect. Installing it on a dedicated server does nothing useful — the camera work, the mixins and the sounds all happen on the client that performs the teleport.

Using it

That is the whole setup. Teleport through a Waystone — a warp plate, a warp stone, or a scroll — and the transition plays automatically.

There is no activation step, no keybind and no GUI.

Turning it off

Either of these:

/ta off

…for yourself, or set effectEnabled = false in the config to disable it more thoroughly.

To stop it for everyone on a server, that is the config route — there is no server-side enforcement of the effect, because the effect is entirely client-side.

The four commands

All under /ta:

Command	Does
/ta on	Enable the effect
/ta off	Disable the effect
/ta status	Show the current state
/ta player_freeze on | off	Whether the player is frozen during the transition

See Commands.

If nothing happens

In order of likelihood:

1. Not teleporting through a supported mod. The trigger is a Waystones teleport (or a Kinetic Waypoint on NeoForge 1.21.1). Vanilla /tp, portals and other mods do not play it.
2. effectEnabled is false, or you ran /ta off earlier in the session.
3. The transition is playing but you cannot see it. It is a fast camera move; if it is too subtle for your taste, the stage durations in the config control how long it takes. See The Transition.
4. Something else is fighting the camera. See Compatibility.

Config file

<gamedir>/config/teleport_animation-client.toml

Generated on first launch with every option commented and defaulted. No option needs changing.

Uninstalling

Remove the JAR. The mod adds no blocks or items and stores no world data, so nothing needs cleaning up and saves are untouched.