# \u2699\ufe0f BetterSettings
\n**The ultimate lightweight, API-first player settings management system for Paper, Purpur, and Folia servers.**<\/p>\n
\n
\n
\n<\/p>\n
<\/p>\n
## \ud83c\udf1f What is BetterSettings?<\/p>\n
**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**.\n\nOut 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.\n\n\n\n## \u2728 Key Features\n\n* **\ud83d\ude80 High Performance:** Built with Async I\/O and smart caching. File operations are non-blocking, ensuring your TPS stays high.\n* **\ud83c\udf10 Folia Ready:** Full support for Folia's regionized threading model.\n* **\ud83c\udfa8 Beautiful GUI:** A categorized menu with glass pane borders, pagination, and sound effects.\n* **\ud83d\udcdd Highly Configurable:** Customize every message, icon, color, and layout via YAML.\n* **\ud83d\udd0c Developer API:** Extensive API with cancellable events (`PlayerToggleSettingEvent`) for deep integration.\n* **\u274c No Dependencies:** Just drop the JAR in and go.\n\n## \ud83c\udfaf The Settings\n\nBetterSettings comes with **60 settings** built into the configuration. They are divided into two types:\n\n### \u2705 Plug & Play (29 Settings)\n*These work immediately upon installation:*\n\n* **Gameplay:** Auto-Pickup, Auto-Sprint, Auto-Respawn, Flight, God Mode, PvP Toggle, Speed\/Jump Boost, Night Vision.\n* **Protection:** Drop Protection (Sneak to drop), Inventory Protection, Fall Damage Toggle, Mob Targeting.\n* **Display:** Scoreboard Toggle, Player Visibility (Hide Players), Weather\/Time (Client-side), Tab List Visibility.\n* **Communication:** Global Chat, Private Messages, Death Messages, Join\/Leave Messages.\n\n### \ud83d\udd0c API Framework (31 Settings)\n*These are registered and savable, waiting for other plugins to utilize them:*\n\n* **Social:** Teleport\/Trade\/Friend requests, Chat Mentions.\n* **Notifications:** Mob spawns, Achievements, Action Bar, Boss Bar, Titles.\n* **Advanced:** Coordinates display, Biome display, AFK status.\n\n## \ud83d\udd27 Configuration\n\nEverything is customizable in `plugins\/BetterSettings\/`:\n* `config.yml`: Main plugin settings.\n* `settings.yml`: Configure icons, descriptions, and default states for all settings.\n* `ui.yml`: Change the GUI layout, size, and items.\n* `messages.yml`: Translate or change every message.\n* `performance.yml`: Tune I\/O threading and auto-save intervals.\n\n## \ud83d\udcbb For Developers\n\nBetterSettings is designed to be the backbone of your server's setting management.\n\n**Register a custom setting:**\n```java\nSettingsRegistry.getInstance().registerSetting(new MyCustomSetting());\n````\n\n**Check a player's preference:**\n\n```java\nPlayerDataManager dataManager = BetterSettings.getInstance().getDataManager();\nif (dataManager.getSetting(player.getUniqueId(), \"bettersettings_tprequest\", true)) {\n \/\/ Send teleport request\n}\n```\n\n## \ud83d\udce5 Installation\n\n1. **Download** the latest JAR.\n2. **Drop** it into your `plugins` folder.\n3. **Restart** your server.\n4. Type `\/settings` to open the menu!\n\n**Requirements:**\n\n * Paper\/Purpur\/Folia 1.20.5+\n\n-----\n\n## \ud83e\udd1d Support & Community\n\nFound a bug? Have a feature request? Join our community!\n\n * **Join the Discord** for support.\n * **GitHub Issues** for bug reports.\n * **Wiki** for full documentation.\n<\/p>\n","protected":false},"excerpt":{"rendered":"
The ultimate API-first player settings framework with 50+ built-in toggles, full Folia support, and a unified GUI.<\/p>\n","protected":false},"featured_media":30299,"template":"","meta":{"_minecraft_slug":"bettersettings","_minecraft_project_id":"SVixlQx7","_minecraft_author":"mattbaconz","_minecraft_license":"MIT","_minecraft_downloads":221,"_minecraft_follows":1,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"bettersettings.zip","_minecraft_size_bytes":90910,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-16T12:27:13.096562Z","_minecraft_date_created":"2025-11-22T10:40:17.032065Z","_minecraft_date_modified":"2025-11-21T12:04:11.884235Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/bettersettings","_minecraft_icon_attachment_id":30299,"_minecraft_imported_at":"2026-06-01T12:52:00+00:00","_minecraft_import_hash":"69dc3c1ba4b25ee295517a480d992322","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[125,873,126,127,128,92],"mod_loader":[131,132,133],"minecraft_version":[101,102,62,37,40,73,74,38,78,79,80,81,82],"class_list":["post-30298","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-folia","mod_category-library","mod_category-management","mod_category-paper","mod_category-purpur","mod_category-utility","mod_loader-folia","mod_loader-paper","mod_loader-purpur","minecraft_version-1-20-5","minecraft_version-1-20-6","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9"],"yoast_head":"\n