** UltimateLobby - 完整插件文档
? 插件概览
UltimateLobby 是一款功能强大的一体化大厅/等待区管理插件,专为运行在 Minecraft 1.21.1 - 1.21.4 版本的 PaperMC 服务器设计。该插件通过将所有必要的大厅功能整合到一个单一、优化且完全可配置的解决方案中,取代了以往需要 30 多个独立插件的需求。
? 什么是 UltimateLobby?
UltimateLobby 将你的服务器大厅/等待区转变为专业且功能丰富的出生点区域。无论你是运营小型社区服务器还是拥有多种游戏模式的大型网络,UltimateLobby 都能为你提供一切所需,为你的玩家打造引人入胜的第一印象。
为什么选择 UltimateLobby?
| 问题 |
UltimateLobby 解决方案 |
| 插件过多导致冲突 |
单一插件处理所有事务 |
| 多插件导致高资源占用 |
经过优化、轻量级的代码 |
| 配置不一致 |
统一的 YAML 配置系统 |
| 缺乏游戏内编辑能力 |
完整的 GUI 编辑器用于物品和菜单 |
| 自定义困难 |
每个功能均可开关和配置 |
| 设置过程复杂 |
开箱即用,具备合理的默认值 |
✨ 完整功能列表
?️ 世界保护系统
使用 30 多项可配置的保护规则,保护你的大厅世界免受破坏和不需要的修改:
| 功能 |
描述 |
| 方块保护 |
防止破坏和放置方块 |
| 坠落伤害 |
完全禁用坠落伤害 |
| 虚空保护 |
当玩家掉入虚空时传送至出生点 |
| 天气锁定 |
保持天气始终晴朗 |
| 饥饿禁用 |
玩家永远不会失去饥饿值 |
| 生物生成 |
阻止敌对/所有生物生成 |
| 火焰蔓延 |
阻止火焰蔓延 |
| 树叶腐烂 |
防止树叶腐烂 |
| PvP 开关 |
启用或禁用玩家战斗 |
| 物品掉落/拾取 |
控制物品交互 |
| 交互阻断 |
防止访问箱子/门/容器 |
| 爆炸保护 |
阻挡 TNT 和苦力怕造成的伤害 |
| 作物踩踏 |
保护农田 |
| 反 WDL |
检测 World Downloader 模组用户 |
关键优势: 每条规则都可以单独开关,拥有 bypass 权限的玩家也可以覆盖保护。
? 加入体验
通过可定制的加入动作,创造令人难忘的第一印象:
欢迎消息 (MOTD)
带有占位符的多行欢迎消息
- "&6&l★ &e欢迎来到 &6&lYOUR SERVER&e! &6&l★"
- "&7在线人数: %server_online% | 等级: %vault_prefix%"
标题显示
- 可自定义标题和副标题
- 可配置的淡入、停留和淡出时间
- 支持 PlaceholderAPI
加入音效
烟花效果
- 可自定义颜色和效果
- 多种烟花类型(球形、星形、爆裂等)
- 轨迹和闪烁选项
首次加入
- 新玩家的特殊欢迎消息
- 自动烟花庆祝
- 首次加入时执行命令(给予物品等)
? 大厅物品系统
通过革命性的游戏内编辑器为玩家提供交互式快捷栏物品:
默认物品
| 槽位 |
物品 |
功能 |
| 0 |
指南针 |
服务器选择器 |
| 1 |
箱子 |
小工具菜单 |
| 2 |
玩家头颅 |
个人资料菜单 |
| 4 |
染料 |
隐身切换开关 |
| 7 |
比较器 |
设置菜单 |
| 8 |
书 |
服务器信息 |
游戏内物品编辑器
/ul setjoinitems
- 在你的背包中排列物品
- 运行命令
- 物品会自动保存材质、名称、描述和附魔!
支持的操作
[menu] server-selector 打开自定义菜单
[server] survival 连接服务器(代理)
[world] lifesteal 连接到某个世界
[command] fly 玩家执行命令
[console] give %player% 控制台执行命令
[message] &a你好! 发送消息
[sound] UI_BUTTON_CLICK 播放音效
[player-hider] 切换可见性
[spawn] 传送至出生点
[url] https://... 发送可点击链接
? 自定义菜单系统
通过强大的游戏内菜单编辑器创建无限数量的自定义 GUI:
创建菜单
/ul createmenu <name> <rows>
/ul createmenu shop 6
在游戏内编辑菜单
/ul editmenu <name>
- 以编辑模式打开菜单
- 自由拖放物品
- 关闭即可自动保存!
设置物品操作
/ul setaction <menu> <slot> <action>
/ul setaction shop 0 [server] survival
菜单功能
- 支持 1-6 行(9-54 个槽位)
- 名称/描述中使用 PlaceholderAPI
- 打开音效
- 权限要求
- 分页支持
- 确认对话框
预建菜单
- 服务器选择器 - 连接到游戏服务器
- 小工具菜单 - 有趣的装饰效果
- 个人资料菜单 - 玩家统计数据
- 设置菜单 - 切换偏好设置
- 语言菜单 - 多语言支持
? 记分板系统
专业、无闪烁的记分板,带有动画效果:
功能
- 无闪烁更新 - 使用基于团队的渲染技术
- 动画标题 - 循环播放多个标题
- PlaceholderAPI 支持 - 显示任意占位符
- 按玩家内容 - 为每个玩家提供独特数据
- 切换命令 - 玩家可以隐藏/显示
示例配置
scoreboard:
enabled: true
update-interval: 20
title: "&6&lYOUR SERVER"
lines:
- "&7&m "
- "&f玩家: &e%player_name%"
- "&f等级: &e%vault_prefix%"
- ""
- "&f在线: &a%server_online%"
- "&7&m "
? Tablist 系统
可定制的玩家列表,支持等级排序:
功能
- 自定义头部/尾部 - 支持多行
- 等级排序 - 高等级玩家优先显示
- PlaceholderAPI - 动态内容
- 动画内容 - 旋转消息
- 前缀/后缀显示 - 来自 Vault
权重等级系统
rank-weights:
owner: 100 排在最前面
admin: 90
moderator: 80
vip: 50
default: 10 排在最后面
? 聊天管理系统
完整的聊天控制,包含管理工具:
聊天格式化
format: "%vault_prefix%&f%player_name%%vault_suffix%&7: &f%message%"
反脏话过滤器
- 可配置的违禁词列表
- 火星文检测(a→@, e→3 等)
- 自定义替换文本
- 管理员通知
- 玩家警告
聊天锁定
/ul chatlock [reason]
- 即时锁定/解锁聊天
- 自定义锁定消息
- 管理员拥有权限绕过
慢速模式
/ul slowmode <seconds>
清除聊天
/ul clearchat
- 清除所有玩家的聊天历史
- 管理员可以查看被清除的内容
命令拦截器
拦截如 /pl, /plugins, /ver 等命令:
blocked-commands:
- "/pl"
- "/plugins"
- "/version"
- "/?"
? 隐身系统
功能齐全的管理员隐身模式:
功能
| 功能 |
描述 |
| 完全隐形 |
对所有玩家隐藏 |
| 标签页隐藏 |
从玩家列表中移除 |
| 无声加入/离开 |
伪造离开/加入消息 |
| 启用飞行 |
隐身时自动启用飞行 |
| 夜视 |
在黑暗中也能看见 |
| 无怪物仇恨 |
怪物无视你 |
| 无法拾取 |
不会拾取物品 |
| 无敌 |
隐身期间无敌 |
| 动作栏 |
持续显示隐身提醒 |
命令
/vanish 切换隐身状态
/vanish on 开启隐身
/vanish off 关闭隐身
/vanish list 列出已隐身的玩家
/vanish <player> 切换其他玩家的隐身状态
? 移动系统
大厅趣味移动功能:
二段跳
- 在空中按空格键激活
- 可配置的力量和高度
- 冷却系统
- 粒子效果
- 自定义音效
弹射板
- 压力板 + 基座方块检测
- 可配置发射力量
- 每个弹射板可自定义方向
- 发射时的粒子效果
加速垫
?️ 玩家可见性控制系统
让玩家控制对其他玩家的可见性:
三种可见状态
| 状态 |
图标 |
描述 |
| 全部可见 |
绿色染料 |
看到所有玩家 |
| 全部隐藏 |
灰色染料 |
看不到任何玩家 |
| 仅 VIP |
黄色染料 |
仅看到 VIP 玩家 |
功能
- 点击循环切换状态
- 记住偏好设置(可选)
- 快捷栏物品动态更新
- 粒子指示器(可选)
? 代理/网络支持
将你的大厅连接到网络:
BungeeCord/Velocity 支持
- 将玩家发送到其他服务器
- 获取服务器玩家数量
- 服务器状态检测
服务器组(负载均衡)
server-groups:
survival:
- "survival-1"
- "survival-2"
自动发送到人口最少的服务器
排队系统
? 小道具系统
供玩家使用的趣味装饰小道具:
| 小道具 |
效果 |
冷却时间 |
| 烟花 |
发射彩色烟花 |
10秒 |
| 跳跃提升 |
临时高跳 |
30秒 |
| 烟雾弹 |
产生烟雾粒子云 |
15秒 |
| 彩虹尾迹 |
身后留下彩色尾迹 |
60秒 |
| TNT 跳跃 |
爆炸推进 |
5秒 |
| 冰冻射线 |
冻结原地并产生冰霜效果 |
20秒 |
| 速度提升 |
临时加速 |
30秒 |
| 粒子效果 |
各种粒子光环 |
40秒 |
功能
- 每个小道具独立的冷却时间
- 基于权限的访问控制
- VIP 专属小道具
- 视觉冷却指示器
? 全息图系统
创建悬浮文字展示:
命令
/ul hologram create <id> <text>
/ul hologram delete <id>
/ul hologram list
/ul hologram addline <id> <text>
/ul hologram setline <id> <line> <text>
/ul hologram tp <id>
功能
- 支持多行文本
- 支持 PlaceholderAPI
- 内容自动更新
- 持久化存储
- Text Display 实体 (1.19.4+)
以下是根据您提供的 plugin.yml 更新的 命令参考 和 权限参考 部分。
? 命令参考
?️ 大厅设置与管理命令
| 命令 |
别名 |
描述 |
权限 |
/ultimatelobby |
/ul, /lobbymanager |
用于子功能(菜单、全息图、重载)的主管理命令。 |
ultimatelobby.admin |
/setlobby |
/setuplobby, /createlobby |
设置 Lobby 出生点并将世界添加到大厅列表。 |
ultimatelobby.setlobby |
/sethub |
/setuphub, /createhub |
设置 Hub 出生点并将世界添加到大厅列表。 |
ultimatelobby.setlobby |
/addlobbyworld |
/addlobby |
手动将世界添加到大厅世界列表。 |
ultimatelobby.admin |
/removelobbyworld |
/dellobbyworld |
从大厅世界列表中移除世界。 |
ultimatelobby.admin |
/listlobbyworlds |
/lobbyworlds |
列出所有配置的大厅世界。 |
ultimatelobby.admin |
?️ 子命令(通过 /ul 调用)
这些作为主 /ul 命令的参数运行。
| 子命令 |
描述 |
权限 |
reload |
重载所有配置文件。 |
ultimatelobby.reload |
setjoinitems |
将当前物品栏保存为默认加入物品。 |
ultimatelobby.setjoinitems |
createmenu <name> |
创建新的 GUI 菜单。 |
ultimatelobby.menu.admin |
editmenu <name> |
打开游戏内菜单编辑器。 |
ultimatelobby.menu.admin |
hologram <...> |
管理全息图(创建/删除/编辑)。 |
ultimatelobby.hologram.admin |
chatlock |
切换全局聊天锁定。 |
ultimatelobby.chat.admin |
clearchat |
清除全局聊天历史。 |
ultimatelobby.chat.admin |
slowmode <sec> |
设置聊天冷却时间。 |
ultimatelobby.chat.admin |
? 玩家命令
| 命令 |
别名 |
描述 |
权限 |
/fly |
- |
切换飞行模式。 |
ultimatelobby.fly |
/gm <mode> |
/gamemode |
更改游戏模式(生存、创造等)。 |
ultimatelobby.gamemode |
/vanish |
/v, /invisible |
切换管理员隐身模式。 |
ultimatelobby.vanish |
/spawn |
- |
传送至出生点。 |
ultimatelobby.spawn |
/lobby |
/hub, /l, /leave |
传送至大厅/主厅出生点。 |
ultimatelobby.spawn |
/openmenu |
/menu, /gui |
按名称打开特定的自定义菜单。 |
ultimatelobby.menu |
? 权限参考
? 管理员权限
| 权限 |
描述 |
ultimatelobby.admin |
通配符: 拥有插件所有功能的完全访问权限。 |
ultimatelobby.reload |
允许重新加载配置文件。 |
ultimatelobby.setspawn |
允许设置出生点。 |
ultimatelobby.setlobby |
允许使用设置命令(/setlobby, /sethub)。 |
ultimatelobby.setjoinitems |
允许保存加入物品栏。 |
ultimatelobby.protection.bypass |
绕过所有世界保护(破坏/放置/交互)。 |
ultimatelobby.staff.notify |
接收警报(反脏话、更新、警告)。 |
ultimatelobby.hologram.admin |
创建和管理全息图。 |
? 游戏模式权限
| 权限 |
描述 |
ultimatelobby.gamemode |
/gm 的基础权限。 |
ultimatelobby.gamemode.survival |
允许切换到生存模式。 |
ultimatelobby.gamemode.creative |
允许切换到创造模式。 |
ultimatelobby.gamemode.adventure |
允许切换到冒险模式。 |
ultimatelobby.gamemode.spectator |
允许切换到旁观者模式。 |
ultimatelobby.gamemode.others |
更改其他玩家的游戏模式。 |
? 隐身权限
| 权限 |
描述 |
ultimatelobby.vanish |
对自己进行隐身切换。 |
ultimatelobby.vanish.others |
对其他玩家进行隐身切换。 |
ultimatelobby.vanish.see |
查看其他隐身玩家。 |
ultimatelobby.vanish.list |
通过命令列出隐身玩家。 |
ultimatelobby.vanish.auto |
自动以隐身状态加入服务器。 |
? 聊天管理权限
| 权限 |
描述 |
ultimatelobby.chat.admin |
使用锁定、清除和慢速模式命令。 |
ultimatelobby.chat.color |
在聊天消息中使用颜色代码。 |
ultimatelobby.chat.bypass |
通配符: 绕过所有聊天限制。 |
ultimatelobby.chat.bypass.lock |
在全局聊天锁定时仍可发言。 |
ultimatelobby.chat.bypass.cooldown |
忽略慢速模式冷却时间。 |
ultimatelobby.chat.bypass.swear |
忽略反脏话过滤器。 |
ultimatelobby.chat.bypass.spam |
忽略反垃圾信息过滤器。 |
ultimatelobby.chat.bypass.clear |
在聊天记录被清除后仍可查看历史。 |
ultimatelobby.command-blocker.bypass |
使用被阻止的命令(例如 /pl)。 |
? 菜单权限
| 权限 |
描述 |
ultimatelobby.menu.admin |
创建、编辑和删除菜单。 |
ultimatelobby.menu.* |
可打开所有自定义菜单。 |
ultimatelobby.menu.server-selector |
可访问服务器选择器。 |
ultimatelobby.menu.gadgets |
可访问小工具菜单。 |
ultimatelobby.menu.settings |
可访问设置菜单。 |
ultimatelobby.menu.profile |
可访问个人资料菜单。 |
ultimatelobby.openmenu.others |
强制为其他玩家打开菜单。 |
? 小工具与功能权限
| 权限 |
描述 |
ultimatelobby.fly |
使用飞行命令。 |
ultimatelobby.fly.others |
对其他玩家切换飞行模式。 |
ultimatelobby.spawn.bypass-delay |
无需等待预热即可立即传送。 |
ultimatelobby.doublejump |
在大厅世界中可以使用二段跳。 |
ultimatelobby.vip |
VIP 状态(用于“仅限 VIP”玩家可见性)。 |
ultimatelobby.gadget.* |
可访问所有装饰性小工具。 |
ultimatelobby.gadget.firework |
使用烟花小工具。 |
ultimatelobby.gadget.jumpboost |
使用跳跃强化小工具。 |
ultimatelobby.gadget.smokebomb |
使用烟雾弹小工具。 |
ultimatelobby.gadget.rainbowtrail |
使用彩虹轨迹小工具。 |
ultimatelobby.gadget.tntjump |
使用 TNT 跳跃小工具。 |
? PlaceholderAPI 占位符
UltimateLobby 注册了 30 多个自定义占位符:
隐身占位符
| 占位符 |
返回值 |
%ultimatelobby_vanished% |
true/false |
%ultimatelobby_vanished_status% |
&cVanished / &aVisible |
%ultimatelobby_vanished_count% |
隐身玩家数量 |
%ultimatelobby_real_online% |
在线人数(排除隐身玩家) |
玩家隐藏占位符
| 占位符 |
返回值 |
%ultimatelobby_hider_state% |
all/none/vip |
%ultimatelobby_hider_status% |
格式化状态文本 |
%ultimatelobby_visible_players% |
可见玩家数量 |
%ultimatelobby_hidden_players% |
隐藏玩家数量 |
聊天占位符
| 占位符 |
返回值 |
%ultimatelobby_chat_locked% |
true/false |
%ultimatelobby_chat_status% |
&cLocked / &aOpen |
%ultimatelobby_slowmode% |
慢速模式秒数 |
服务器占位符
| 占位符 |
返回值 |
%ultimatelobby_in_lobby% |
true/false |
%ultimatelobby_network_online% |
网络总在线人数 |
%ultimatelobby_server_<name>_online% |
服务器在线人数 |
%ultimatelobby_server_<name>_status% |
Online/Offline/Full |
队列占位符
| 占位符 |
返回值 |
%ultimatelobby_queue_position% |
队列位置或 N/A |
%ultimatelobby_queue_server% |
排队中的服务器或 None |
玩家占位符
| 占位符 |
返回值 |
%ultimatelobby_flying% |
true/false |
%ultimatelobby_fly_status% |
&aFlying / &7Walking |
%ultimatelobby_gamemode% |
survival/creative/etc |
%ultimatelobby_scoreboard_visible% |
true/false |
? 依赖项
必需
- PaperMC 1.21.1 - 1.21.11(或兼容分支)
- Java 21
可选(软依赖)
| 插件 |
用途 |
| PlaceholderAPI |
所有文本中的占位符支持 |
| Vault |
经济、权限、聊天前缀 |
| ProtocolLib |
阻止 Tab 补全、数据包功能 |
? 配置文件
| 文件 |
用途 |
config.yml |
主插件配置(850+ 行) |
messages.yml |
所有可自定义消息 |
menus.yml |
自定义菜单定义 |
items.yml |
大厅物品配置 |
scoreboards.yml |
记分板模板(可选) |
? 安装指南
步骤 1:下载
从发布页面下载 UltimateLobby-1.0.0.jar。
步骤 2:安装
将 JAR 文件放入服务器的 plugins 文件夹中。
步骤 3:启动服务器
启动或重启服务器。默认配置文件将会生成。
步骤 4:配置
- 编辑
config.yml 以设置你的大厅世界
- 使用
/ul setspawn 设置出生点位置
- 摆放物品并使用
/ul setjoinitems
- 使用
/ul createmenu 创建菜单
步骤 5:权限
使用你的权限插件设置权限(推荐使用 LuckPerms)。
? 开发者 API
其他插件可以接入 UltimateLobby:
// 检查 API 是否可用
if (UltimateLobbyAPI.isInitialized()) {
// 隐身 API
boolean vanished = UltimateLobbyAPI.isVanished(player);
UltimateLobbyAPI.vanish(player);
UltimateLobbyAPI.unvanish(player);
// 菜单 API
UltimateLobbyAPI.openMenu(player, "server-selector");
UltimateLobbyAPI.createMenu("custom", 3);
// 代理 API
UltimateLobbyAPI.sendToServer(player, "survival");
UltimateLobbyAPI.addToQueue(player, "pvp");
// 聊天 API
UltimateLobbyAPI.lockChat("Maintenance");
UltimateLobbyAPI.clearChat();
// 记分板 API
UltimateLobbyAPI.createScoreboard(player);
UltimateLobbyAPI.removeScoreboard(player);
}
Maven 依赖
<dependency>
<groupId>com.ultimatelobby</groupId>
<artifactId>UltimateLobby</artifactId>
<version>1.0.0</version>
<scope>provided</scope>
</dependency>
❓ 常见问题
Q:这能在 Spigot 上运行吗?
A: UltimateLobby 专为 PaperMC 设计,并使用了 Paper 特定的 API。不支持 Spigot。
Q:我可以在单服务器设置上使用它吗?
A: 可以!只需在 config.yml 中禁用代理功能即可。所有大厅功能均可独立工作。
Q:如何创建自定义菜单?
A: 使用 /ul createmenu <name> <rows>,然后使用 /ul editmenu <name> 打开游戏内编辑器。放置物品后关闭即可保存!
Q:为什么占位符不起作用?
A: 确保已安装 PlaceholderAPI。UltimateLobby 软依赖于此以提供占位符支持。
Q:如何设置弹射台?
A: 在红石块上方放置一个压力板。玩家踩上去就会被弹射出去!
Q:玩家可以绕过保护吗?
A: 是的,给他们 ultimatelobby.protection.bypass 权限,或者切换到创造模式。
Q:如何禁用特定功能?
A: 每个功能在 config.yml 中都有一个 enabled: true/false 开关。将其设置为 false 即可禁用。
Q:隐身状态在重新加入后会保留吗?
A: 默认情况下不会,但你可以在 config.yml 中启用 vanish.persist-on-rejoin: true。
Q:如何添加更多被屏蔽的词?
A: 编辑 config.yml 中的 chat.anti-swear.words 列表,然后运行 /ul reload。
Q:我可以为不同等级设置不同的物品吗?
A: 可以!在 items.yml 中启用 rank-items 并配置按等级划分的物品覆盖。
? 性能
UltimateLobby 经过性能优化:
- 异步操作 - 记分板和标签页列表异步更新
- 缓存 - 配置值和服务器信息会被缓存
- 条件加载 - 禁用的功能根本不会加载
- 高效事件 - 非大厅世界立即返回
- 最小内存占用 - 清晰的数据结构
资源使用情况
- 内存: 约 5-15 MB,取决于启用的功能
- CPU: 影响极小,主要为事件驱动
- 存储: 配置文件约 100 KB
?️ 故障排除
插件未加载
- 检查控制台错误
- 验证 Java 21 已安装
- 确保使用 PaperMC 1.21.1+
物品未给予
- 检查
items.enabled: true
- 验证世界是否在
lobby-worlds 列表中
- 检查玩家是否有冲突的插件
菜单未打开
- 验证菜单是否存在:
/ul listmenus
- 检查权限:
ultimatelobby.menu.<name>
- 查看控制台中的错误
记分板未显示
- 启用:
scoreboard.enabled: true
- 检查世界是否在大厅世界中
- 验证没有冲突的记分板插件
感谢您选择 UltimateLobby! ?
** UltimateLobby - Complete Plugin Documentation
? Plugin Overview
UltimateLobby is a powerful, all-in-one hub/lobby management plugin designed for PaperMC servers running Minecraft 1.21.1 - 1.21.4. This plugin replaces the need for 30+ separate plugins by combining all essential lobby features into a single, optimized, and fully configurable solution.
? What is UltimateLobby?
UltimateLobby transforms your server's hub/lobby into a professional, feature-rich spawn area. Whether you're running a small community server or a large network with multiple game modes, UltimateLobby provides everything you need to create an engaging first impression for your players.
Why Choose UltimateLobby?
| Problem |
UltimateLobby Solution |
| Too many plugins causing conflicts |
Single plugin handles everything |
| High resource usage from multiple plugins |
Optimized, lightweight code |
| Inconsistent configurations |
Unified YAML configuration system |
| No in-game editing capabilities |
Full in-game GUI editor for items & menus |
| Difficult to customize |
Every feature is toggleable and configurable |
| Complex setup process |
Works out of the box with sensible defaults |
✨ Complete Feature List
?️ World Protection System
Protect your lobby world from griefing and unwanted modifications with 30+ configurable protection rules:
| Feature |
Description |
| Block Protection |
Prevent block breaking and placing |
| Fall Damage |
Disable fall damage completely |
| Void Protection |
Teleport players to spawn when falling into void |
| Weather Lock |
Keep weather always clear |
| Hunger Disable |
Players never lose hunger |
| Mob Spawning |
Prevent hostile/all mob spawning |
| Fire Spread |
Stop fire from spreading |
| Leaf Decay |
Prevent leaves from decaying |
| PvP Toggle |
Enable or disable player combat |
| Item Drop/Pickup |
Control item interactions |
| Interaction Block |
Prevent chest/door/container access |
| Explosion Protection |
Block TNT and creeper damage |
| Crop Trampling |
Protect farmland |
| Anti-WDL |
Detect World Downloader mod users |
Key Benefit: Each rule can be individually toggled, and players with bypass permissions can override protection.
? Join Experience
Create memorable first impressions with customizable join actions:
Welcome Message (MOTD)
Multi-line welcome message with placeholders
- "&6&l★ &eWelcome to &6&lYOUR SERVER&e! &6&l★"
- "&7Online: %server_online% | Rank: %vault_prefix%"
Title Display
- Customizable title and subtitle
- Configurable fade-in, stay, and fade-out timings
- PlaceholderAPI support
Join Sound
- Any Minecraft sound effect
- Adjustable volume and pitch
Firework Effect
- Customizable colors and effects
- Multiple firework types (Ball, Star, Burst, etc.)
- Trail and flicker options
First-Time Join
- Special welcome message for new players
- Automatic firework celebration
- Execute commands on first join (give items, etc.)
? Lobby Items System
Give players interactive hotbar items with the revolutionary In-Game Editor:
Default Items
| Slot |
Item |
Function |
| 0 |
Compass |
Server Selector |
| 1 |
Chest |
Gadgets Menu |
| 2 |
Player Head |
Profile Menu |
| 4 |
Dye |
Player Hider Toggle |
| 7 |
Comparator |
Settings Menu |
| 8 |
Book |
Server Info |
In-Game Item Editor
/ul setjoinitems
- Arrange items in your inventory
- Run the command
- Items are automatically saved with materials, names, lore, and enchantments!
Supported Actions
[menu] server-selector Open a custom menu
[server] survival Connect to server (proxy)
[world] lifesteal Connect to a world
[command] fly Player runs command
[console] give %player% Console runs command
[message] &aHello! Send message
[sound] UI_BUTTON_CLICK Play sound
[player-hider] Toggle visibility
[spawn] Teleport to spawn
[url] https://... Send clickable link
? Custom Menu System
Create unlimited custom GUIs with the powerful In-Game Menu Editor:
Create Menus
/ul createmenu <name> <rows>
/ul createmenu shop 6
Edit Menus In-Game
/ul editmenu <name>
- Opens the menu in edit mode
- Drag and drop items freely
- Close to auto-save!
Set Item Actions
/ul setaction <menu> <slot> <action>
/ul setaction shop 0 [server] survival
Menu Features
- 1-6 row support (9-54 slots)
- PlaceholderAPI in names/lore
- Open sounds
- Permission requirements
- Pagination support
- Confirmation dialogs
Pre-Built Menus
- Server Selector - Connect to game servers
- Gadgets Menu - Fun cosmetic effects
- Profile Menu - Player statistics
- Settings Menu - Toggle preferences
- Language Menu - Multi-language support
? Scoreboard System
Professional, flicker-free scoreboards with animations:
Features
- Flicker-Free Updates - Uses team-based rendering
- Animated Titles - Cycle through multiple titles
- PlaceholderAPI Support - Display any placeholder
- Per-Player Content - Unique data for each player
- Toggle Command - Players can hide/show
Example Configuration
scoreboard:
enabled: true
update-interval: 20
title: "&6&lYOUR SERVER"
lines:
- "&7&m "
- "&fPlayer: &e%player_name%"
- "&fRank: &e%vault_prefix%"
- ""
- "&fOnline: &a%server_online%"
- "&7&m "
? Tablist System
Customizable player list with rank sorting:
Features
- Custom Header/Footer - Multi-line support
- Rank Sorting - Higher ranks appear first
- PlaceholderAPI - Dynamic content
- Animated Content - Rotating messages
- Prefix/Suffix Display - From Vault
Rank Weight System
rank-weights:
owner: 100 Appears first
admin: 90
moderator: 80
vip: 50
default: 10 Appears last
? Chat Management System
Complete chat control with moderation tools:
Chat Formatting
format: "%vault_prefix%&f%player_name%%vault_suffix%&7: &f%message%"
Anti-Swear Filter
- Configurable word list
- Leetspeak detection (a→@, e→3, etc.)
- Custom replacement text
- Staff notifications
- Player warnings
Chat Lock
/ul chatlock [reason]
- Instantly lock/unlock chat
- Custom lock message
- Bypass permission for staff
Slow Mode
/ul slowmode <seconds>
- Set cooldown between messages
- Bypass for VIP/Staff
Clear Chat
/ul clearchat
- Clear chat for all players
- Staff can see through clear
Command Blocker
Block commands like /pl, /plugins, /ver:
blocked-commands:
- "/pl"
- "/plugins"
- "/version"
- "/?"
? Vanish System
Full-featured staff vanish mode:
Features
| Feature |
Description |
| Complete Invisibility |
Hidden from all players |
| Tablist Hiding |
Removed from player list |
| Silent Join/Quit |
Fake leave/join messages |
| Flight Enable |
Auto-enable flight when vanished |
| Night Vision |
See in the dark |
| No Mob Target |
Mobs ignore you |
| No Pickup |
Don't pick up items |
| No Damage |
Invincible while vanished |
| Action Bar |
Constant vanish reminder |
Commands
/vanish Toggle vanish
/vanish on Enable vanish
/vanish off Disable vanish
/vanish list List vanished players
/vanish <player> Toggle for another player
? Movement System
Fun movement features for lobby:
Double Jump
- Activate by pressing space while in air
- Configurable power and height
- Cooldown system
- Particle effects
- Custom sounds
Launchpads
- Pressure plate + base block detection
- Configurable launch power
- Custom directions per launchpad
- Particle effects on launch
Speed Boost Pads
- Walk over special blocks for speed boost
- Configurable duration and level
?️ Player Hider System
Let players control visibility of other players:
Three Visibility States
| State |
Icon |
Description |
| All Visible |
Lime Dye |
See all players |
| All Hidden |
Gray Dye |
See no players |
| VIP Only |
Yellow Dye |
See only VIP players |
Features
- Cycles through states on click
- Remembers preference (optional)
- Hotbar item updates dynamically
- Particle indicators (optional)
? Proxy/Network Support
Connect your lobby to your network:
BungeeCord/Velocity Support
- Send players to other servers
- Retrieve server player counts
- Server status detection
Server Groups (Load Balancing)
server-groups:
survival:
- "survival-1"
- "survival-2"
Automatically sends to least populated server
Queue System
- Join queue for full servers
- Position notifications
- Auto-connect when space available
? Gadgets System
Fun cosmetic gadgets for players:
| Gadget |
Effect |
Cooldown |
| Firework |
Launch colorful firework |
10s |
| Jump Boost |
Temporary high jump |
30s |
| Smoke Bomb |
Cloud of smoke particles |
15s |
| Rainbow Trail |
Colorful trail behind you |
60s |
| TNT Jump |
Explosion launch |
5s |
| Freeze Ray |
Freeze in place with ice effect |
20s |
| Speed Boost |
Temporary speed increase |
30s |
| Particle Effects |
Various particle auras |
40s |
Features
- Per-gadget cooldowns
- Permission-based access
- VIP-exclusive gadgets
- Visual cooldown indicators
? Hologram System
Create floating text displays:
Commands
/ul hologram create <id> <text>
/ul hologram delete <id>
/ul hologram list
/ul hologram addline <id> <text>
/ul hologram setline <id> <line> <text>
/ul hologram tp <id>
Features
- Multi-line support
- PlaceholderAPI support
- Auto-updating content
- Persistent storage
- Text Display entities (1.19.4+)
Here are the Commands Reference and Permissions Reference sections updated to match your provided plugin.yml.
? Commands Reference
?️ Lobby Setup & Admin Commands
| Command |
Aliases |
Description |
Permission |
/ultimatelobby |
/ul, /lobbymanager |
Main admin command for sub-features (menus, holograms, reloading). |
ultimatelobby.admin |
/setlobby |
/setuplobby, /createlobby |
Set the Lobby spawn point and adds world to lobby list. |
ultimatelobby.setlobby |
/sethub |
/setuphub, /createhub |
Set the Hub spawn point and adds world to lobby list. |
ultimatelobby.setlobby |
/addlobbyworld |
/addlobby |
Manually add a world to the lobby worlds list. |
ultimatelobby.admin |
/removelobbyworld |
/dellobbyworld |
Remove a world from the lobby worlds list. |
ultimatelobby.admin |
/listlobbyworlds |
/lobbyworlds |
List all configured lobby worlds. |
ultimatelobby.admin |
?️ Sub-Commands (via /ul)
These function as arguments under the main /ul command.
| Sub-Command |
Description |
Permission |
reload |
Reload all configurations. |
ultimatelobby.reload |
setjoinitems |
Save current inventory as default join items. |
ultimatelobby.setjoinitems |
createmenu <name> |
Create a new GUI menu. |
ultimatelobby.menu.admin |
editmenu <name> |
Open the in-game menu editor. |
ultimatelobby.menu.admin |
hologram <...> |
Manage holograms (create/delete/edit). |
ultimatelobby.hologram.admin |
chatlock |
Toggle global chat lock. |
ultimatelobby.chat.admin |
clearchat |
Clear global chat history. |
ultimatelobby.chat.admin |
slowmode <sec> |
Set chat cooldown. |
ultimatelobby.chat.admin |
? Player Commands
| Command |
Aliases |
Description |
Permission |
/fly |
- |
Toggle flight mode. |
ultimatelobby.fly |
/gm <mode> |
/gamemode |
Change game mode (Survival, Creative, etc.). |
ultimatelobby.gamemode |
/vanish |
/v, /invisible |
Toggle staff vanish mode. |
ultimatelobby.vanish |
/spawn |
- |
Teleport to the spawn point. |
ultimatelobby.spawn |
/lobby |
/hub, /l, /leave |
Teleport to lobby/hub spawn. |
ultimatelobby.spawn |
/openmenu |
/menu, /gui |
Open a specific custom menu by name. |
ultimatelobby.menu |
? Permissions Reference
? Admin Permissions
| Permission |
Description |
ultimatelobby.admin |
Wildcard: Full access to all plugin features. |
ultimatelobby.reload |
Allow reloading configuration. |
ultimatelobby.setspawn |
Allow setting spawn points. |
ultimatelobby.setlobby |
Allow using setup commands (/setlobby, /sethub). |
ultimatelobby.setjoinitems |
Allow saving join items inventory. |
ultimatelobby.protection.bypass |
Bypass all world protection (break/place/interact). |
ultimatelobby.staff.notify |
Receive alerts (anti-swear, updates, warnings). |
ultimatelobby.hologram.admin |
Create and manage holograms. |
? Gamemode Permissions
| Permission |
Description |
ultimatelobby.gamemode |
Base permission for /gm. |
ultimatelobby.gamemode.survival |
Allow switching to Survival. |
ultimatelobby.gamemode.creative |
Allow switching to Creative. |
ultimatelobby.gamemode.adventure |
Allow switching to Adventure. |
ultimatelobby.gamemode.spectator |
Allow switching to Spectator. |
ultimatelobby.gamemode.others |
Change other players' gamemodes. |
? Vanish Permissions
| Permission |
Description |
ultimatelobby.vanish |
Toggle vanish for self. |
ultimatelobby.vanish.others |
Toggle vanish for others. |
ultimatelobby.vanish.see |
See other vanished players. |
ultimatelobby.vanish.list |
List vanished players via command. |
ultimatelobby.vanish.auto |
Automatically join the server vanished. |
? Chat Management Permissions
| Permission |
Description |
ultimatelobby.chat.admin |
Use lock, clear, and slowmode commands. |
ultimatelobby.chat.color |
Use color codes in chat messages. |
ultimatelobby.chat.bypass |
Wildcard: Bypass all chat restrictions. |
ultimatelobby.chat.bypass.lock |
Chat while global chat is locked. |
ultimatelobby.chat.bypass.cooldown |
Ignore slowmode cooldowns. |
ultimatelobby.chat.bypass.swear |
Ignore anti-swear filter. |
ultimatelobby.chat.bypass.spam |
Ignore anti-spam filter. |
ultimatelobby.chat.bypass.clear |
See chat history after it is cleared. |
ultimatelobby.command-blocker.bypass |
Use blocked commands (e.g., /pl). |
? Menu Permissions
| Permission |
Description |
ultimatelobby.menu.admin |
Create, edit, and delete menus. |
ultimatelobby.menu.* |
Access to open ALL custom menus. |
ultimatelobby.menu.server-selector |
Access to Server Selector. |
ultimatelobby.menu.gadgets |
Access to Gadgets Menu. |
ultimatelobby.menu.settings |
Access to Settings Menu. |
ultimatelobby.menu.profile |
Access to Profile Menu. |
ultimatelobby.openmenu.others |
Force open menus for other players. |
? Gadget & Feature Permissions
| Permission |
Description |
ultimatelobby.fly |
Use flight command. |
ultimatelobby.fly.others |
Toggle flight for others. |
ultimatelobby.spawn.bypass-delay |
Teleport immediately without warmup. |
ultimatelobby.doublejump |
Use double jump in lobby worlds. |
ultimatelobby.vip |
VIP status (used for "VIP Only" player visibility). |
ultimatelobby.gadget.* |
Access to all cosmetic gadgets. |
ultimatelobby.gadget.firework |
Use Firework gadget. |
ultimatelobby.gadget.jumpboost |
Use Jump Boost gadget. |
ultimatelobby.gadget.smokebomb |
Use Smoke Bomb gadget. |
ultimatelobby.gadget.rainbowtrail |
Use Rainbow Trail gadget. |
ultimatelobby.gadget.tntjump |
Use TNT Jump gadget. |
? PlaceholderAPI Placeholders
UltimateLobby registers 30+ custom placeholders:
Vanish Placeholders
| Placeholder |
Returns |
%ultimatelobby_vanished% |
true/false |
%ultimatelobby_vanished_status% |
&cVanished / &aVisible |
%ultimatelobby_vanished_count% |
Number of vanished players |
%ultimatelobby_real_online% |
Online count excluding vanished |
Player Hider Placeholders
| Placeholder |
Returns |
%ultimatelobby_hider_state% |
all/none/vip |
%ultimatelobby_hider_status% |
Formatted status text |
%ultimatelobby_visible_players% |
Count of visible players |
%ultimatelobby_hidden_players% |
Count of hidden players |
Chat Placeholders
| Placeholder |
Returns |
%ultimatelobby_chat_locked% |
true/false |
%ultimatelobby_chat_status% |
&cLocked / &aOpen |
%ultimatelobby_slowmode% |
Slowmode seconds |
Server Placeholders
| Placeholder |
Returns |
%ultimatelobby_in_lobby% |
true/false |
%ultimatelobby_network_online% |
Total network players |
%ultimatelobby_server_<name>_online% |
Server player count |
%ultimatelobby_server_<name>_status% |
Online/Offline/Full |
Queue Placeholders
| Placeholder |
Returns |
%ultimatelobby_queue_position% |
Queue position or N/A |
%ultimatelobby_queue_server% |
Queued server or None |
Player Placeholders
| Placeholder |
Returns |
%ultimatelobby_flying% |
true/false |
%ultimatelobby_fly_status% |
&aFlying / &7Walking |
%ultimatelobby_gamemode% |
survival/creative/etc |
%ultimatelobby_scoreboard_visible% |
true/false |
? Dependencies
Required
- PaperMC 1.21.1 - 1.21.11 (or compatible fork)
- Java 21
Optional (Soft Dependencies)
| Plugin |
Purpose |
| PlaceholderAPI |
Placeholder support in all text |
| Vault |
Economy, permissions, chat prefixes |
| ProtocolLib |
Tab-complete blocking, packet features |
? Configuration Files
| File |
Purpose |
config.yml |
Main plugin configuration (850+ lines) |
messages.yml |
All customizable messages |
menus.yml |
Custom menu definitions |
items.yml |
Lobby item configurations |
scoreboards.yml |
Scoreboard templates (optional) |
? Installation Guide
Step 1: Download
Download UltimateLobby-1.0.0.jar from the releases page.
Step 2: Install
Place the JAR file in your server's plugins folder.
Step 3: Start Server
Start or restart your server. Default configuration files will be generated.
Step 4: Configure
- Edit
config.yml to set your lobby worlds
- Use
/ul setspawn to set spawn location
- Arrange items and use
/ul setjoinitems
- Create menus with
/ul createmenu
Step 5: Permissions
Set up permissions using your permission plugin (LuckPerms recommended).
? Developer API
Other plugins can hook into UltimateLobby:
// Check if API is available
if (UltimateLobbyAPI.isInitialized()) {
// Vanish API
boolean vanished = UltimateLobbyAPI.isVanished(player);
UltimateLobbyAPI.vanish(player);
UltimateLobbyAPI.unvanish(player);
// Menu API
UltimateLobbyAPI.openMenu(player, "server-selector");
UltimateLobbyAPI.createMenu("custom", 3);
// Proxy API
UltimateLobbyAPI.sendToServer(player, "survival");
UltimateLobbyAPI.addToQueue(player, "pvp");
// Chat API
UltimateLobbyAPI.lockChat("Maintenance");
UltimateLobbyAPI.clearChat();
// Scoreboard API
UltimateLobbyAPI.createScoreboard(player);
UltimateLobbyAPI.removeScoreboard(player);
}
Maven Dependency
<dependency>
<groupId>com.ultimatelobby</groupId>
<artifactId>UltimateLobby</artifactId>
<version>1.0.0</version>
<scope>provided</scope>
</dependency>
❓ Frequently Asked Questions
Q: Does this work with Spigot?
A: UltimateLobby is designed for PaperMC and uses Paper-specific APIs. Spigot is not supported.
Q: Can I use this on a single-server setup?
A: Yes! Simply disable the proxy features in config.yml. All lobby features work standalone.
Q: How do I create custom menus?
A: Use /ul createmenu <name> <rows> then /ul editmenu <name> to open the in-game editor. Place items and close to save!
Q: Why aren't placeholders working?
A: Make sure PlaceholderAPI is installed. UltimateLobby soft-depends on it for placeholder support.
Q: How do I set up launchpads?
A: Place a pressure plate on top of a redstone block. Players stepping on it will be launched!
Q: Can players bypass protection?
A: Yes, give them ultimatelobby.protection.bypass or switch to Creative mode.
Q: How do I disable a specific feature?
A: Every feature has an enabled: true/false toggle in config.yml. Set it to false to disable.
Q: Does vanish persist after rejoin?
A: By default no, but you can enable vanish.persist-on-rejoin: true in config.yml.
Q: How do I add more blocked words?
A: Edit the chat.anti-swear.words list in config.yml and run /ul reload.
Q: Can I have different items for different ranks?
A: Yes! Enable rank-items in items.yml and configure per-rank item overrides.
? Performance
UltimateLobby is optimized for performance:
- Async Operations - Scoreboards and tablists update asynchronously
- Caching - Configuration values and server info are cached
- Conditional Loading - Disabled features don't load at all
- Efficient Events - Early returns for non-lobby worlds
- Minimal Memory - Clean data structures
Resource Usage
- Memory: ~5-15 MB depending on features enabled
- CPU: Minimal impact, mostly event-driven
- Storage: ~100 KB for configuration files
?️ Troubleshooting
Plugin Not Loading
- Check console for errors
- Verify Java 21 is installed
- Ensure PaperMC 1.21.1+
Items Not Given
- Check
items.enabled: true
- Verify world is in
lobby-worlds list
- Check player has no conflicting plugins
Menus Not Opening
- Verify menu exists:
/ul listmenus
- Check permission:
ultimatelobby.menu.<name>
- Look for errors in console
Scoreboard Not Showing
- Enable:
scoreboard.enabled: true
- Check world is in lobby worlds
- Verify no conflicting scoreboard plugins
Thank you for choosing UltimateLobby! ?**
评论 0
登录后参与评分
还没有评论,来抢沙发吧