KaribouWelcome
一款面向 Paper 服务器的轻量级、零依赖欢迎与规则插件,完全支持 MiniMessage。
为新玩家留下美好的第一印象,同时避免在你的插件列表中增加另一个沉重的依赖项。KaribouWelcome 在一个小巧且专注的插件中处理加入消息、首次加入欢迎和服务器规则——不多不少,恰到好处。
为什么选择 KaribouWelcome?
- 无功能臃肿。 仅包含欢迎消息、加入/离开消息和规则——并且做得很好。
- 无外部依赖。 使用已捆绑在 Paper 中的 Adventure API。
- 现代文本格式化。 完整的 MiniMessage 支持让你能够使用渐变、十六进制颜色和丰富文本样式,无需依赖传统的
& 颜色代码。
- 即时配置。 重载配置并实时预览消息——在调整消息时无需重启服务器。
- 设计简洁。 易于配置,易于理解。
功能
- 新玩家的自定义首次加入消息
- 回归玩家的自定义加入消息
- 自定义公开加入/离开广播
- 新玩家的私人欢迎消息
- 可配置的
/rules 命令
- 通过
/kbw reload 实现配置实时重载
- 针对每种消息类型的管理员测试/预览命令
- 基于权限的命令访问控制
- 所有命令的标签页补全
- 完整的 MiniMessage 支持(渐变、十六进制颜色、文本样式、自定义格式)
命令
/karibouwelcome 和 /kbw 的作用完全相同。
| 命令 |
描述 |
权限 |
/rules |
显示服务器规则 |
Player |
/karibouwelcome reload |
重载配置文件 |
Admin |
/karibouwelcome test <type> |
预览已配置的消息 |
Admin |
测试类型
join — 预览回归玩家的加入消息
quit — 预览离开消息
newplayer — 预览首次加入消息
welcome — 预览私人欢迎消息
rules — 预览已配置的规则
配置
所有内容均在 plugins/KaribouWelcome/config.yml 中进行配置。所有消息均支持 MiniMessage 格式化。
public:
login: "<green>%player% joined the server.</green>"
new-player: "<gold><bold>%player%</bold> joined the server for the first time!</gold>"
quit: "<yellow>%player% left the server.</yellow>"
private:
welcome:
- "<gold>Welcome to the server, <yellow>%player%</yellow>!"
- "<gray>We hope you enjoy your stay."
- "<gray>Use <yellow>/rules</yellow> to read the rules again."
rules:
- "<gold>========== Rules =========="
- "<white>1. Respect other players."
- "<white>2. No cheating."
- "<white>3. No griefing."
- "<white>4. Have fun!"
- "<gold>==========================="
%player% 占位符在所有消息中均可用。MiniMessage 标签如 <red>、<gold><bold>、<#55FF55> 和 <gradient:#ff0000:#ffff00> 可直接在配置中使用。
修改你的消息,运行 /kbw reload,然后通过测试命令预览它们——无需重启服务器。
兼容性
|
|
| 服务器软件 |
Paper |
| Minecraft |
26.1.2 |
| Java |
25 |
| 依赖项 |
除 Paper 捆绑的 Adventure API 外无其他依赖 |
计划支持更多 Paper 版本。
路线图
已完成
- 欢迎、加入、首次加入和离开消息
- 带有
/rules 的规则系统
- 配置重载
- 权限系统
- MiniMessage 支持
- 测试/预览命令
- 标签页补全
计划中
- 支持较旧版本的 Paper
- PlaceholderAPI 集成
- 按世界覆盖的消息设置
有功能请求或发现了 Bug?请在 GitHub 上提交 Issue。
Karibou Suite
KaribouWelcome 是专为 Paper 服务器打造的一系列轻量级、零依赖实用插件中的第一款插件。其目标很简单:小型插件、专注的功能、现代化的 API,以及不必要的依赖。
更多 Karibou 插件即将推出。
许可证
MIT License
KaribouWelcome
A lightweight, zero-dependency welcome & rules plugin for Paper servers, with full MiniMessage support.
Give new players a great first impression without adding another heavy dependency to your plugin list. KaribouWelcome handles join messages, first-join welcomes, and server rules in one small, focused plugin — nothing more, nothing less.
Why KaribouWelcome?
- No feature bloat. Just welcome messages, join/quit messages, and rules — done well.
- No external dependencies. Uses the Adventure API already bundled with Paper.
- Modern text formatting. Full MiniMessage support gives you gradients, hex colors, and rich text styling without relying on legacy
& color codes.
- Instant configuration. Reload your config and preview messages live — no server restart needed while tuning your messages.
- Simple by design. Easy to configure, easy to understand.
Features
- Custom first-join messages for new players
- Custom returning-player join messages
- Custom public join/quit broadcasts
- Private welcome message for new players
- Configurable
/rules command
- Live configuration reload with
/kbw reload
- Admin test/preview commands for every message type
- Permission-based command access
- Tab completion for all commands
- Full MiniMessage support (gradients, hex colors, text styles, custom formatting)
Commands
Both /karibouwelcome and /kbw work identically.
| Command |
Description |
Permission |
/rules |
Displays the server rules |
Player |
/karibouwelcome reload |
Reloads the configuration |
Admin |
/karibouwelcome test <type> |
Previews a configured message |
Admin |
Test types
join — Preview the returning-player join message
quit — Preview the quit message
newplayer — Preview the first-join message
welcome — Preview the private welcome message
rules — Preview the configured rules
Configuration
Everything is configured in plugins/KaribouWelcome/config.yml. All messages support MiniMessage formatting.
public:
login: "<green>%player% joined the server.</green>"
new-player: "<gold><bold>%player%</bold> joined the server for the first time!</gold>"
quit: "<yellow>%player% left the server.</yellow>"
private:
welcome:
- "<gold>Welcome to the server, <yellow>%player%</yellow>!"
- "<gray>We hope you enjoy your stay."
- "<gray>Use <yellow>/rules</yellow> to read the rules again."
rules:
- "<gold>========== Rules =========="
- "<white>1. Respect other players."
- "<white>2. No cheating."
- "<white>3. No griefing."
- "<white>4. Have fun!"
- "<gold>==========================="
The %player% placeholder is available in every message. MiniMessage tags such as <red>, <gold><bold>, <#55FF55>, and <gradient:#ff0000:#ffff00> can be used directly in your configuration.
Change your messages, run /kbw reload, then preview them with the test commands — no server restart required.
Compatibility
|
|
| Server software |
Paper |
| Minecraft |
26.1.2 |
| Java |
25 |
| Dependencies |
None beyond the Adventure API bundled with Paper |
Support for additional Paper versions is planned.
Roadmap
Completed
- Welcome, join, first-join, and quit messages
- Rules system with
/rules
- Configuration reload
- Permissions
- MiniMessage support
- Test/preview commands
- Tab completion
Planned
- Support for older Paper versions
- PlaceholderAPI integration
- Per-world message overrides
Have a feature request or found a bug? Open an issue on GitHub.
The Karibou Suite
KaribouWelcome is the first plugin in a growing suite of lightweight, zero-dependency utility plugins for Paper servers. The goal is simple: small plugins, focused features, modern APIs, and no unnecessary dependencies.
More Karibou plugins are coming soon.
License
MIT License
评论 0
登录后参与评分
还没有评论,来抢沙发吧