⚙️ BetterSettings

The ultimate lightweight, API-first player settings management system for Paper, Purpur, and Folia servers.

🌟 What is BetterSettings?

BetterSettings gives your players complete control over their gameplay experience through a beautiful, categorized GUI. It is designed to be extremely lightweight (<100KB), Folia-compatible, and API-first.

Out of the box, it provides 29 fully functional settings (like flight, auto-pickup, and private messages) that work immediately without any extra dependencies. Additionally, it offers a framework of 31 API settings that developers can integrate into their own plugins.

✨ Key Features

• 🚀 High Performance: Built with Async I/O and smart caching. File operations are non-blocking, ensuring your TPS stays high.
• 🌐 Folia Ready: Full support for Folia's regionized threading model.
• 🎨 Beautiful GUI: A categorized menu with glass pane borders, pagination, and sound effects.
• 📝 Highly Configurable: Customize every message, icon, color, and layout via YAML.
• 🔌 Developer API: Extensive API with cancellable events (PlayerToggleSettingEvent) for deep integration.
• ❌ No Dependencies: Just drop the JAR in and go.

🎯 The Settings

BetterSettings comes with 60 settings built into the configuration. They are divided into two types:

✅ Plug & Play (29 Settings)

These work immediately upon installation:

• Gameplay: Auto-Pickup, Auto-Sprint, Auto-Respawn, Flight, God Mode, PvP Toggle, Speed/Jump Boost, Night Vision.
• Protection: Drop Protection (Sneak to drop), Inventory Protection, Fall Damage Toggle, Mob Targeting.
• Display: Scoreboard Toggle, Player Visibility (Hide Players), Weather/Time (Client-side), Tab List Visibility.
• Communication: Global Chat, Private Messages, Death Messages, Join/Leave Messages.

🔌 API Framework (31 Settings)

These are registered and savable, waiting for other plugins to utilize them:

• Social: Teleport/Trade/Friend requests, Chat Mentions.
• Notifications: Mob spawns, Achievements, Action Bar, Boss Bar, Titles.
• Advanced: Coordinates display, Biome display, AFK status.

🔧 Configuration

Everything is customizable in plugins/BetterSettings/:

• config.yml: Main plugin settings.
• settings.yml: Configure icons, descriptions, and default states for all settings.
• ui.yml: Change the GUI layout, size, and items.
• messages.yml: Translate or change every message.
• performance.yml: Tune I/O threading and auto-save intervals.

💻 For Developers

BetterSettings is designed to be the backbone of your server's setting management.

Register a custom setting:

SettingsRegistry.getInstance().registerSetting(new MyCustomSetting());

Check a player's preference:

PlayerDataManager dataManager = BetterSettings.getInstance().getDataManager();
if (dataManager.getSetting(player.getUniqueId(), "bettersettings_tprequest", true)) {
    // Send teleport request
}

📥 Installation

1. Download the latest JAR.
2. Drop it into your plugins folder.
3. Restart your server.
4. Type /settings to open the menu!

Requirements:

• Paper/Purpur/Folia 1.20.5+

---

🤝 Support & Community

Found a bug? Have a feature request? Join our community!

• Join the Discord for support.
• GitHub Issues for bug reports.
• Wiki for full documentation.