⚙️ EasySettings
EasySettings 是一款专为现代服务器设计的、美观且完全模块化的 Minecraft GUI 设置插件,适用于 Spigot / Paper (1.20+)。它提供了一个精致的游戏内玩家设置菜单、完整的交互式游戏内 GUI 编辑器、流畅的 Unicode 小型大写字母排版,以及可扩展的 Developer API,使其他插件能够轻松注入自定义设置和回调函数。
✨ Features
-
? Aesthetic Player GUI (/settings):
- 采用现代柔和色与赛博朋克十六进制颜色(
BFCF1, 3CF66, &#FF6B6B)的简洁卡片式描述文本布局。
- 原生支持 Unicode Small Caps 排版(
<sc>text</sc>)。
- 支持
TOGGLE 设置(具有持久开/关状态及 %status% 占位符)和 ACTION 设置(一键按钮)。
- 响应式单槽更新 —— 无库存闪烁或卡顿。
-
?️ Visual In-Game Editor (/settings editor):
- 实时镜像你的设置库存布局。
- 点击任意绿色空槽位(
+ Add Setting)即可在该确切位置创建设置。
- 左键点击设置以打开 Inspector Menu(更改名称、图标、类型、光泽、权限、描述文本、动作)。
- Shift+左键点击以拾取并将设置移动到其他任意槽位。
- 支持实时聊天输入捕获及
cancel 功能。
-
⚡ Powerful Action Engine:
[player] <command> — 以玩家身份运行命令
[console] <command> — 从服务器控制台运行命令(支持 %player%)
[message] <text> — 向玩家发送带颜色的消息
[broadcast] <text> — 向全服广播
[sound] <SOUND:VOL:PITCH> — 播放音效
[close] & [refresh] — 控制 GUI 流程
[api] <tag> — 触发自定义插件挂钩
-
? Comprehensive Developer API:
- 使用流畅构建器在代码中注册设置(
Setting.builder("auto_pickup")...build())。
- 仅需 3 行代码即可附加 Java 回调(
.onToggle(...) 和 .onClick(...))。
- 注册自定义动作标签(
[myplugin] doSomething)。
- 以编程方式查询或设置玩家设置(
EasySettingsAPI.isSettingEnabled(...))。
-
? Plugman / PlugmanX Safe:
- 强化的重载与卸载例程。
- 自动关闭打开的菜单、刷新持久化存储、取消计划任务、注销监听器并清除静态引用,以防止内存泄漏。
- 内置实时重载命令:
/settings reload 可实时更新活跃玩家的菜单。
-
? PlaceholderAPI Ready:
? Commands & Permissions
| Command |
Permission |
Description |
/settings |
easysettings.use |
打开玩家设置 GUI |
/settings editor |
easysettings.admin |
打开交互式视觉 GUI 编辑器 |
/settings edit <id> |
easysettings.admin |
打开特定设置的 Inspector GUI |
/settings add <id> |
easysettings.admin |
在下一个可用槽位添加新设置 |
/settings delete <id> |
easysettings.admin |
永久删除设置 |
/settings list |
easysettings.admin |
列出所有已注册设置、槽位和来源 |
/settings reload |
easysettings.admin |
重载 config.yml 和 settings.yml |
(别名: /setting, /settings, /esettings, /easysettings)
? Quick Developer API Example
只需几秒钟即可从你的插件中添加自定义设置:
import com.easysettings.api.EasySettingsAPI;
import com.easysettings.api.Setting;
import com.easysettings.api.SettingType;
import org.bukkit.Material;
import java.util.List;
Setting mySetting = Setting.builder("auto_pickup")
.displayName("BFCF1&l<sc>Auto Pickup</sc>")
.slot(13)
.type(SettingType.TOGGLE)
.item(Material.HOPPER)
.defaultState(false)
.description(List.of(
"ͤE96Automatically collect mined items directly",
"ͤE96into your inventory.",
"",
"񸷑│ ͤE96Status: %status%",
"",
"BFCF1▸ Click to toggle"
))
.onToggle((player, setting, newState) -> {
player.sendMessage("Auto Pickup: " + (newState ? "ON" : "OFF"));
})
.build();
EasySettingsAPI.registerSetting(mySetting);
有关涵盖 Maven/Gradle、现成插件(EssentialsX, Vault, PvP plugins)、自定义动作标签和事件的完整集成指南,请查看我们的 Integration Guide on GitHub!
⚙️ EasySettings
EasySettings is an aesthetic, fully modular Minecraft GUI settings plugin for Spigot / Paper (1.20+) designed for modern servers. It provides a sleek in-game player settings menu, a complete interactive in-game GUI editor, smooth Unicode small-caps typography, and an extensible Developer API so other plugins can effortlessly inject custom settings and callbacks.
✨ Features
-
? Aesthetic Player GUI (/settings):
- Clean card-style lore layout with modern pastel & cyber hex colors (
BFCF1, 3CF66, &#FF6B6B).
- Native Unicode Small Caps typography (
<sc>text</sc>).
- Supports both
TOGGLE settings (persistent ON/OFF state with %status% placeholder) and ACTION settings (one-click buttons).
- Responsive per-slot updating — no inventory flickering or lag spikes.
-
?️ Visual In-Game Editor (/settings editor):
- Live mirror of your settings inventory layout.
- Click any green empty slot (
+ Add Setting) to create a setting at that exact slot.
- Left-Click settings to open the Inspector Menu (change name, icon, type, glint, permission, lore, actions).
- Shift-Left-Click to pick up and move a setting to any other slot.
- Real-time chat input capture with
cancel support.
-
⚡ Powerful Action Engine:
[player] <command> — Run command as the player
[console] <command> — Run command from server console (%player% supported)
[message] <text> — Send colorized message to player
[broadcast] <text> — Broadcast to the whole server
[sound] <SOUND:VOL:PITCH> — Play sound effect
[close] & [refresh] — Control GUI flow
[api] <tag> — Trigger custom plugin hooks
-
? Comprehensive Developer API:
- Register settings in code using a fluent builder (
Setting.builder("auto_pickup")...build()).
- Attach Java callbacks (
.onToggle(...) and .onClick(...)) in 3 lines of code.
- Register custom action tags (
[myplugin] doSomething).
- Programmatically query or set player settings (
EasySettingsAPI.isSettingEnabled(...)).
-
? Plugman / PlugmanX Safe:
- Hardened reload and unload routines.
- Automatically closes open menus, flushes persistent storage, cancels scheduled tasks, unregisters listeners, and clears static references to prevent memory leaks.
- Built-in live reload command:
/settings reload refreshes active player menus in real time.
-
? PlaceholderAPI Ready:
- Native soft-dependency integration for titles, display names, and lore.
? Commands & Permissions
| Command |
Permission |
Description |
/settings |
easysettings.use |
Opens the player settings GUI |
/settings editor |
easysettings.admin |
Opens the interactive visual GUI editor |
/settings edit <id> |
easysettings.admin |
Opens the Inspector GUI for a specific setting |
/settings add <id> |
easysettings.admin |
Adds a new setting at the next available slot |
/settings delete <id> |
easysettings.admin |
Permanently deletes a setting |
/settings list |
easysettings.admin |
Lists all registered settings, slots, and sources |
/settings reload |
easysettings.admin |
Reloads config.yml and settings.yml |
(Aliases: /setting, /settings, /esettings, /easysettings)
? Quick Developer API Example
Add custom settings from your plugin in seconds:
import com.easysettings.api.EasySettingsAPI;
import com.easysettings.api.Setting;
import com.easysettings.api.SettingType;
import org.bukkit.Material;
import java.util.List;
Setting mySetting = Setting.builder("auto_pickup")
.displayName("BFCF1&l<sc>Auto Pickup</sc>")
.slot(13)
.type(SettingType.TOGGLE)
.item(Material.HOPPER)
.defaultState(false)
.description(List.of(
"ͤE96Automatically collect mined items directly",
"ͤE96into your inventory.",
"",
"񸷑│ ͤE96Status: %status%",
"",
"BFCF1▸ Click to toggle"
))
.onToggle((player, setting, newState) -> {
player.sendMessage("Auto Pickup: " + (newState ? "ON" : "OFF"));
})
.build();
EasySettingsAPI.registerSetting(mySetting);
For the complete integration guide covering Maven/Gradle, ready-made plugins (EssentialsX, Vault, PvP plugins), custom action tags, and events, check out our Integration Guide
on GitHub!
评论 0
登录后参与评分
还没有评论,来抢沙发吧