---

🧭 PingCompass

A lightweight Minecraft plugin that displays player ping using a compass-like indicator, helping players and server admins quickly visualize network performance. Perfect for competitive servers, mini-games, or survival communities that value smooth gameplay.

---

✨ Features

• 🎯 Compass-Based Ping Display — See your ping visually represented through compass directions or colors.
• 📊 Live Ping Updates — Updates automatically as ping changes.
• ⚙️ Customizable Display — Choose between chat, action bar, boss bar, or scoreboard display.
• 🧩 Optimized for Performance — Designed to be lightweight and efficient on Paper, Spigot, and Purpur servers.
• 🔒 Permission-Based Access — Control who can view or use the ping compass.
• 💬 Fully Configurable Messages — Edit every message and color via messages.yml.

---

🧱 Requirements

• Minecraft: 1.16+
• Server Software: Paper, Purpur, or Spigot
• Java: 17 or newer

---

⚙️ Commands

Command	Description	Permission
/pingcompass	Toggles the ping compass on or off for the player.	pingcompass.use
/pingcompass reload	Reloads the configuration and messages.	pingcompass.admin

---

🔒 Permissions

Permission Node	Description
pingcompass.use	Allows players to toggle or view their ping compass.
pingcompass.admin	Allows reloading the plugin configuration.

---

🧾 Configuration

# PingCompass Configuration
settings:
  update-interval: 2  # seconds between ping updates
  display-mode: actionbar  # options: actionbar, chat, bossbar, scoreboard
  messages:
    prefix: "&6PingCompass &7» "
    ping-display: "&eYour ping: &a%ping%ms"

---

🪄 Usage

• Use /pingcompass to toggle your compass display.
• The compass or overlay updates automatically to reflect real-time ping changes.
• Admins can customize update intervals and display methods.

---

🧩 Compatibility

• Works seamlessly with Paper, Spigot, and Purpur.
• No dependencies required — simple drop-in installation.

---

💬 Support

Need help or found a bug? Join our Discord community for support and updates.

---

🏷️ Tags

ping · utility · performance · hud · minecraft-plugin

---