MinecraftAura

MinecraftAura is a lightweight, configurable greeting and farewell plugin designed for Paper-based servers. It focuses on clarity, permission control, and predictable behavior without unnecessary complexity.

No magic hacks. Just server-side logic.

---

✨ Features

• Custom join and quit messages
• /greet and /bye commands with optional target players
• Central /aura command with subcommands
• Fully permission-based behavior (LuckPerms compatible)
• Configurable cooldowns to prevent spam
• Optional file-based message pools (.txt)
• Supports & color codes in custom files
• Controlled broadcasting (no accidental global spam)
• Autocompletion for commands and player names
• Debug mode for detailed logging

---

📦 Compatibility

• Platform: Paper & Paper forks (Purpur, Pufferfish, etc.)
• Minecraft Versions: 1.20.x
• Java: 17+
• Not compatible with Forge or Fabric (this is a server plugin)

---

🚀 Installation

1. Download the latest .jar from Releases

2. Place it in:

   /plugins/
   

3. Restart/Start the server

4. (Optional) Edit:

   plugins/MinecraftAura/config.yml
   

5. (Optional) Add custom message files in plugins/MinecraftAura/ folder (ONLY .txt files allowed)

6. APPLY /aura reloadconfig WITH op permissions

7. You are good to go! You don't need to handle the plugin until an update now!

---

⚙️ Commands

Main Command

/aura

Subcommands:

/aura help
/aura greet [player]
/aura bye [player]
/aura reload

Player Commands

/greet [player]
/bye [player]

Aliases:

/greeting
/goodbye

Console behavior:

• ✅ /aura greet <player>
• ❌ /greet <player> (intentional)

---

🔐 Permissions

Permission	Description
aura.main	Access /aura
aura.greet	Receive join greetings
aura.bye	Receive quit messages
aura.cmd.greet	Use /greet
aura.cmd.bye	Use /bye
aura.reloadconfig	Reload configuration
aura.cooldown.bypass	Ignore cooldowns
aura.aura	Full admin override

All permissions are compatible with LuckPerms.

---

🧠 Configuration (config.yml)

enable-join-messages: true
enable-quit-messages: true
hide-vanilla-messages: true

broadcast-command-messages: true
debug: false

greet-bye-cooldown-seconds: 30
reload-cooldown-seconds: 60

greetings-file: greetings.txt
byes-file: byes.txt

Notes

• -1 disables a feature
• 0 removes cooldowns
• Cooldowns are internally capped for safety
• Debug mode provides verbose logging for troubleshooting

---

📄 Custom Message Files

Place .txt files inside:

plugins/MinecraftAura/

Rules

• One message per line
• Lines starting with # are ignored
• Supports & color codes
• Use %player% as a placeholder

Example:

&aWelcome back, %player%!
&7Another player has joined the server.

---

🧪 Building from Source

Requirements

• Java 17+
• Maven

mvn clean package

Output:

target/MinecraftAura-<version>.jar

---

📌 Design Philosophy

• Predictable behavior over clever tricks
• Permissions first
• Configurable without recompiling
• No silent failures
• Minimal overhead

Built for servers that prefer control over chaos.

---

🧾 License

The Unlicense

This software is released into the public domain. Do whatever you want with it. (THIS IS NOT LEGAL ADVISE. REFER to LICENSE file for details.)

---

👤 Author & Contact

IND_is_Here GitHub: https://github.com/indishere Discord: ind_is_here