Compass Сoordinates

Compass Coordinates — a lightweight Paper/Spigot plugin that shows your coordinates only while you are holding a compass. It renders coordinates in the action bar and toggles F3 coordinates visibility via a “fake” reduceDebugInfo using ProtocolLib. When no compass is in hand, coordinates are hidden everywhere (including F3).

Features

• Action bar coordinates while holding a compass (either hand).
• F3 coordinates on/off via ProtocolLib without touching server configs.
• Fully customizable message format, colors, update interval, and direction labels.

Requirements

• Java 17+
• Paper or Spigot matching your Minecraft version
• ProtocolLib on the server

Installation

• Put the plugin .jar into your server’s plugins folder.
• Ensure ProtocolLib is installed and compatible.
• Start or restart the server.
• Edit plugins/CompassCoords/config.yml if needed and restart.
• Run the command: /gamerule reducedDebugInfo

Behavior:

• Coordinates appear only while a compass is held.
• When no compass is held, the plugin hides coordinates in both Action Bar and F3 via ProtocolLib.

Config file

# This file explains every option. Copy the keys to `plugins/CompassCoords/config.yml`.
#
# Placeholders available in the `text` value:
#   %x, %y, %z          - player coordinates (integers)
#   %dx, %dy, %dz       - player coordinates with one decimal
#   %world              - world name
#   %yaw, %pitch        - player rotation (integers)
#   %dyaw, %dpitch      - player rotation with one decimal
#   %dir                - cardinal direction derived from yaw (uses `directions` mapping below)
#
# Color codes:
#   Use `&`-codes (e.g. &6, &r). They will be converted to §-codes at runtime.
#   You can also write §-codes directly if you prefer.

# Whether the plugin is enabled at all.
enabled: true

# How often to update the Action Bar (in ticks). 20 ticks = 1 second.
# Lower values update more frequently but may be noisier.
delay: 5

# The Action Bar message format shown while holding a compass.
# Combine any placeholders listed above. Colors: use &-codes or §-codes.
# Example with integer coords:
#   "&6%dir&r | &6X:&r %x &6Y:&r %y &6Z:&r %z"
# Example with one-decimal coords:
#   "§6%dir§r | §6X:§r %dx §6Y:§r %dy §6Z:§r %dz"
text: "§6%dir§r | §6X:§r %x §6Y:§r %y §6Z:§r %z"

# Labels for the 8 compass directions used by %dir.
# Customize them to your language or style if you want.
directions:
  north: "N"
  northeast: "NE"
  east: "E"
  southeast: "SE"
  south: "S"
  southwest: "SW"
  west: "W"
  northwest: "NW"