enabled

Master switch. Set to false to disable the mod entirely without removing it.
Default: true

useLuckPerms

Enable LuckPerms permission checks when the luckperms mod is installed.

If true and LuckPerms is present, TpWithMe checks:

• tpwithme.use
• tpwithme.crossdimensionalteleport
• tpwithme.enderpearlteleport
• tpwithme.chorusfruitteleport

When LuckPerms is active, players must be explicitly granted these permissions.
If LuckPerms is not installed, TpWithMe automatically falls back to allowing everyone to use the mod.
Default: false

crossDimensionalTeleport

Allow mounts to follow through dimension changes (Overworld ↔ Nether ↔ End).
When false, only same-dimension teleports carry the mount.
Default: true

enderPearlTeleport

Allow ender pearls to take your mount along.
When false, mounted ender pearls use vanilla behaviour and only teleport the player.
Default: true

chorusFruitTeleport

Allow chorus fruit to take your mount along.
Grounding uses actual collision surfaces, including slabs, and respects Minecraft's consumable_does_not_teleport_to block tag (including datapack additions). When false, mounted chorus fruit uses vanilla behaviour and only teleports the player.
Default: true

respectOpenPartiesAndClaims

Respect Open Parties and Claims claim protection when it is installed.

TpWithMe checks claim access before moving the mount into a claim. For mounted chorus fruit it respects OPAC's chorus fruit exception option. For mounted ender pearls it respects OPAC's configured Ender Pearls entity barrier group when present.

Disable this only if you deliberately want TpWithMe to ignore OPAC claim protection. If OPAC is installed but its API fails, mount carry is blocked until the server restarts or this setting is explicitly disabled. The mod does not silently allow protected destinations. Default: true

requireSaddle

Only teleport a mount if it has the appropriate control item equipped:

• Saddle — Horse, Donkey, Mule, Skeleton Horse, Zombie Horse, Camel, Camel Husk, Pig, Strider, Nautilus, Zombie Nautilus
• Harness — Happy Ghast
• Exempt — Llama and Trader Llama (lead-controlled, no saddle slot)

Default: true

checkSafety

Before teleporting, check whether there is enough room at the destination for the mount to stand upright and the rider to sit on top.
If the space is too small, the mount stays behind and a message is sent to the player.

Uses direct block collision shape iteration — reliable even for large mounts like Happy Ghast (4×4×4 blocks).
Default: true

applyTeleportProtection

Apply Resistance V to the mount for protectionDurationTicks ticks immediately after teleporting. This prevents death from suffocation or fall damage during the transition.
Default: true

protectionDurationTicks

Duration of the post-teleport damage immunity in game ticks (20 ticks = 1 second).
Default: 60 (3 seconds)

safetySearchRadius

When checkSafety is true and the exact destination is blocked, the mod searches for a safe nearby position within this radius (in blocks).

Searches horizontally, upward and downward, choosing the nearest safe candidate by distance. Actual collision surfaces (including slabs) are considered, so fractional pearl impact heights can be adjusted to the ground. The radius limits displacement on each axis. The selected destination still undergoes world-border and OPAC checks; searching does not load new chunks.

Set to 0 to disable the search and only check the exact destination.
Allowed range: 0 to 4. Larger values are clamped to prevent excessive server tick work.
Default: 2

blacklistedEntities

A list of entity type IDs that must never teleport, regardless of other settings.
Use namespaced IDs, e.g. "minecraft:horse" or "mymod:custom_mount".
Default: [] (empty)

Example groups

group.default:
  permissions:
    - tpwithme.use

group.vip:
  permissions:
    - tpwithme.use
    - tpwithme.crossdimensionalteleport
    - tpwithme.enderpearlteleport
    - tpwithme.chorusfruitteleport

Example commands

/lp group default permission set tpwithme.use true
/lp group default permission set tpwithme.crossdimensionalteleport false
/lp group default permission set tpwithme.enderpearlteleport false
/lp group default permission set tpwithme.chorusfruitteleport false

/lp group vip permission set tpwithme.use true
/lp group vip permission set tpwithme.crossdimensionalteleport true
/lp group vip permission set tpwithme.enderpearlteleport true
/lp group vip permission set tpwithme.chorusfruitteleport true