EN 1 Quick Start

1 Quick Start

中文版本 | English version

This page is intended for first-time installation checks of TeleportCommandsFabric. You can complete the minimum startup and validation first, then confirm common commands, and finally perform an initial tuning pass for your server.

If you already know this kind of server mod, you can jump directly to the command and config examples below. If you are not sure what each module does yet, continue with 2 Features Overview.

Installation and First Startup

Two build variants are available:

• The Standard build contains all teleport features plus bundled Xaero, JourneyMap, and BlueMap integrations. This is the recommended choice for most users.
• The Core build contains the same core teleport commands and storage behavior, but no bundled map integrations. Choose it for a command-only server or when map integration is not needed.

Base commands and storage behavior are identical in both builds. BlueMap integration runs on the server; Xaero and JourneyMap waypoint integration also requires the Standard build and the corresponding map mod on the client.

Place the mod into the server mods/ directory, then start the server once. The first startup is mainly for generating default config and storage files. After startup, verify that at least this file exists:

• config/teleport_commands.json

If the server enters normal running state and the config file is generated, the mod has loaded correctly and you can continue to basic verification.

Run a Basic Validation Pass

As admin, run:

/tpc help
/tpc reload
/tpc config teleporting delay 0
/tpc config teleporting cooldown 0

This confirms two things: admin commands are registered correctly, and global teleport delay/cooldown can be adjusted. Setting both to 0 makes module validation easier.

Then test with a normal player account:

/sethome base
/home base
/worldspawn
/rtp
/wild

If all commands return normally and teleport behavior is correct, the core functionality is ready. If a command is unavailable, check whether that module is disabled, then check config and admin command output.

What to Understand First

Before production use, it helps to keep these points in mind:

• delay and cooldown affect many teleport commands.
• Modules such as home, warp, tpa, worldspawn, rtp, and wild can be enabled/disabled independently.
• Most common values can be changed online via /tpc config ..., without editing JSON every time.

If you just want to enable functionality quickly for local/small servers, getting commands working first is usually more important than fine-tuning every value from day one.

A Good Starter Configuration

The following matches the current generated defaults and works as a practical baseline. It also enables map integration sync. For backward compatibility, the corresponding config field is still named xaero:

{
  "version": 3,
  "debugEnabled": false,
  "teleporting": {
    "delay": 0,
    "cooldown": 3,
    "preloadEnabled": false,
    "preloadRadiusChunks": 1,
    "defaultSafetyCheck": false,
    "teleportEffects": true,
    "restoreRotation": true
  },
  "back": {
    "enabled": true,
    "deleteAfterTeleport": true
  },
  "home": {
    "enabled": true,
    "playerMaximum": 10,
    "deleteInvalid": false,
    "temporaryHomeTtlSeconds": 604800,
    "sharedHomeMaximum": 1,
    "sharedHomeBroadcastCooldownSeconds": 60
  },
  "tpa": {
    "enabled": true,
    "requestExpireTime": 120
  },
  "warp": {
    "enabled": true,
    "maximum": 0,
    "deleteInvalid": false
  },
  "worldSpawn": {
    "enabled": true,
    "world_id": "minecraft:overworld"
  },
  "rtp": {
    "enabled": true,
    "maxRadius": 32,
    "minRadius": 4
  },
  "wild": {
    "enabled": true,
    "minRadius": 512,
    "maxRadius": 4096
  },
  "xaero": {
    "enabled": true,
    "syncIntervalSeconds": 10,
    "persistWaypointSets": true,
    "warpSetName": "Default",
    "homeSetName": "Default"
  },
  "storage": {
    "autoSaveIntervalSeconds": 15
  }
}

This is not the only valid setup, but it is a solid starting point. If your server wants stricter pacing, raise delay/cooldown; if you want smoother destination chunk loading, enable preloadEnabled and tune preloadRadiusChunks. The default target teleport safety check is controlled by defaultSafetyCheck and only runs when target preloading is enabled; RTP and Wild use their own independent random-destination logic.

What to Read Next

1. 2 Features Overview to understand module relationships.
2. 3 Commands and Configuration to confirm what players/admins will use.
3. 4 Configuration File to tune values for your server.