Teleport Compass

Adds a special compass that lets players save lodestone locations and teleport to them through a simple menu.

---

Overview

The Teleport Compass allows players to quickly return to important places in their world.

Players can:

• Left click a lodestone to save it as a location
• Right click the compass to open a teleport menu
• Select a saved location to teleport there instantly

Each compass stores its own locations, so every player can manage their own set of waypoints.

---

How It Works

Saving a Location

1. Hold the Teleport Compass
2. Left click a Lodestone
3. The location is saved to the compass

If the lodestone has a custom name (renamed in an anvil), that name will appear in the teleport menu.

---

Opening the Menu

• Right click the compass to open the waypoint menu.

The menu shows every saved lodestone location stored inside the compass.

Click a location to teleport to it.

---

Custom Menu Icons

You can customize how a waypoint appears in the menu.

If an item frame is placed on top of the lodestone, the item inside the frame will be used as the icon in the teleport menu.

Example:

• Put a diamond in the frame → the waypoint shows a diamond
• Put a sword in the frame → the waypoint shows a sword

If no item frame is present, a default icon is used.

---

Crafting

The Teleport Compass is crafted with the following recipe:

A A A
A B A
A A A

Where:

• A = Diamond
• B = Compass

This recipe can be fully changed in the configuration.

---

Configuration

The plugin uses MiniMessage, so colors, gradients, and formatting can be fully customized.

item:
  displayname: "<b><gradient:#FF0C0C:#9504FD:#00FF6E>Teleport Compass</gradient></b>"
  lore:
    - "<#0C26FF>Right click to open menu"
    - "<#0C26FF>Left click on Lodestone to add location"

crafting:
  shape:
    - "AAA"
    - "ABA"
    - "AAA"
  ingredients:
    A: DIAMOND
    B: COMPASS

menu:
  rows: 3
  item:
    displayname: "<blue>Lodestone"
    lore:
      - "in {WORLD}"
      - "X: {X}"
      - "Y: {Y}"
      - "Z: {Z}"

messages:
  unsafe: "<red>This waypoint is unsafe to teleport to."
  max: "<red>This teleport compass has reached the limit."

---

Features

• Save multiple lodestone locations
• Simple teleport menu
• MiniMessage support
• Custom crafting recipe
• Custom waypoint icons using item frames
• Lodestone names automatically shown
• Each compass stores its own locations

---

Compatibility

• Minecraft 1.21+
• Paper
• Folia compatible
• No database required
• Lightweight and simple to use

---

Typical Use Cases

• Mark player bases
• Save important survival locations
• Create simple teleport networks
• Improve survival quality of life