Configuration

Configuration

Applies to Teleport Animation across all supported versions.

The file

<gamedir>/config/teleport_animation-client.toml

Generated on first launch with every option commented and defaulted. No option needs changing to use the mod.

It is a client config, because everything the mod does — camera, mixins, sounds — is client-side.

There is no in-game configuration screen. Despite /ta with no arguments setting a flag named for one, the mod registers no config screen, and running it merely closes whatever screen is open. Edit the TOML. See Commands.

Master switches

Option	Default	Effect
effectEnabled	true	Master switch for the whole transition.
playerFreezeEnabled	true	Freeze yourself while it plays.
crossDimensionTravelEnabled	false	Play the transition when the destination is in another dimension.
customSoundsEnabled	false	Use the mod's custom sounds.

crossDimensionTravelEnabled is off by default. Teleporting between dimensions plays no animation unless you turn this on. Most people find the camera move is wrong for a dimension change — there is no continuous space to glide through — so it is opt-in.

customSoundsEnabled is off by default because the bundled audio is third-party; see Credits and License.

The white flash

Option	Default	Effect
stepFlashIntensity	as shipped	Opacity multiplier on the flash at each zoom stage.

0 disables the flash entirely, 1 is the original intensity. It has a defined range.

This is the most subjective part of the effect and the first thing to change if it irritates you. See The Transition.

[zoomStageTicks]

Tick length of each zoom stage, three for zoom-out and three for zoom-in:

Option
zoomOutStage1 · zoomOutStage2 · zoomOutStage3
zoomInStage1 · zoomInStage2 · zoomInStage3

Larger numbers are slower. All six share one min/max range.

[zoomStageGlide]

Option	Effect
zoomStageGlideHeight	Extra upward glide applied between zoom stages.
zoomStageGlideTicks	How long that glide takes.

This is what makes the camera read as a move rather than a plain zoom. If the effect looks like nothing but a zoom, this is the setting to increase.

Camera heights

Six values — the camera height at each zoom stage, three out and three in — with a linked switch:

Option	Default
linked	true

With linked = true, editing one height adjusts the others to keep the arc consistent. Set it to false to control all six independently, which is what you want if you want the camera to return closer than it left.

Every height has a defined range, and they are not symmetric: each stage has slightly different minimum and maximum bounds, which is what keeps the arc valid.

[body]

The body transition is a second, distinct move from the zoom stages.

Option	Effect
bodyCameraHeight	Camera height above the player's feet during the body transition.
bodyGlideHeight	Upward glide at the end of the body transition.
bodyGlideTicks	How long that glide takes.

Plus localPlayerHideTicks, which controls how long your own model is hidden during the move — it exists to stop the inside of your own head blocking the view at some camera angles.

[sounds]

Option	Default	Effect
customSoundsEnabled	false	Use the mod's own camera and step sounds.
customSoundVolume	as shipped	Volume multiplier for the mod's custom sounds.
minecraftSoundVolume	as shipped	Volume multiplier for vanilla's teleport sounds.

Both volumes have a defined range. Vanilla's teleport sound plays regardless of customSoundsEnabled, so minecraftSoundVolume is the one to use if you find the vanilla noise intrusive.

[transitions]

What triggers the animation.

Option	Default	Effect
warpPlateTransitionsEnabled	true	Play it when teleporting through a warp plate.
externalTeleportTransitionsEnabled	true	Play it for teleports triggered by other mods.
fallbackChunkFadeEnabled	false	Use a vanilla/Sodium chunk-mask fade as a fallback for chunk rendering.

Vanilla /tp and portals are not animated regardless of this option.

fallbackChunkFadeEnabled is off by default and is a fallback for when the mod's own chunk handling cannot cover a case; enabling it swaps in a vanilla or Sodium mask fade instead. See Compatibility.

Tuning order

If the effect is not quite right, this is the order that converges fastest:

1. stepFlashIntensity = 0 — remove the flash, the most opinionated element.
2. zoomStageGlideHeight up a little — if it reads as a zoom instead of a move.
3. The six stage ticks — for pacing.
4. linked = false, then the heights — for framing.
5. customSoundsEnabled — last, since it is a licensing choice as much as a taste one.