JoinBook
让你的 Minecraft 服务器前 60 秒变得令人难忘。
JoinBook 是一款轻量、美观且高度可配置的 Paper 服务器玩家入门插件。当玩家首次加入时,JoinBook 会用简短的欢迎语、可选的标题/音效以及一个精美的交互式菜单取代通常冗长的聊天文本,该菜单涵盖规则、入门指南、Discord 链接和实时服务器信息。
无需数据库、无需外部 Web 服务、无需 PlaceholderAPI 依赖——安装后使用默认配置即可立即运行。
功能特性
- 首次加入检测,支持自定义欢迎消息、音效和标题
- 干净的可配置 27 格(或更大)GUI,采用渐变 MiniMessage 样式
- 模块化页面:Welcome(欢迎)、Rules(规则)、Getting Started(入门)、Discord、Server Info(服务器信息)
- 完全可配置的按钮——材质、槽位、名称、描述、音效、启用状态
- 实时服务器信息(在线/最大玩家数、运行时间、世界、版本)按需计算,无需重复任务
- 可选的“回归玩家”欢迎回来消息
- 基于 UUID 的入门持久化存储(
data.yml),在数据损坏时能优雅降级
/joinbook reload 实现安全、零停机的配置重载
/joinbook reset <player> 供管理员/测试人员使用
- 内置占位符系统(
%player%、%server%、%online%、%max_players%、%version%、%uptime%)——无需 PlaceholderAPI
- 所有面向玩家的字符串均位于
messages.yml 中
要求
- Paper(或 Paper 分支)用于 Minecraft 1.21.x
- Java 21
安装
- 下载
JoinBook-1.0.0.jar
- 将其放入服务器的
plugins/ 文件夹。
- 重启服务器。
config.yml、messages.yml 和 data.yml 将自动生成在 plugins/JoinBook/ 目录中。
无需进一步设置——插件开箱即用。
配置
编辑 plugins/JoinBook/config.yml(格式通过 MiniMessage 进行排版):
first-join:
enabled: true
open-gui: true
delay-ticks: 20
gui:
title: "<gradient:#ff8acb:#b98cff><bold>JoinBook</bold></gradient>"
rows: 3
buttons:
rules:
enabled: true
slot: 10
material: BOOK
name: "<yellow><bold>Rules"
lore:
- "<gray>Read the server rules."
- ""
- "<green>Click to open"
编辑完成后,运行 /joinbook reload —— 无需重启。所有面向玩家的文本单独存储在 messages.yml 中。
命令
| 命令 |
别名 |
描述 |
/joinbook |
/jb |
打开你的 JoinBook(等同于 /joinbook open) |
/joinbook open |
|
打开 JoinBook 菜单 |
/joinbook reload |
|
重载 config.yml 和 messages.yml |
/joinbook help |
|
显示命令帮助 |
/joinbook version |
|
显示插件/服务器版本信息 |
/joinbook reset <player> |
|
重置某玩家的入门状态 |
权限
| 权限 |
默认值 |
描述 |
joinbook.use |
true |
打开并使用 JoinBook 菜单 |
joinbook.admin |
op |
授予以下所有管理权限 |
joinbook.reload |
op |
重载配置 |
joinbook.reset |
op |
重置玩家的入门状态 |
JoinBook
Make your Minecraft server's first 60 seconds unforgettable.
JoinBook is a lightweight, beautiful, highly configurable player-onboarding
plugin for Paper servers. When a player joins for the first time, JoinBook
replaces the usual wall of chat text with a short welcome, an optional
title/sound, and a polished interactive menu covering rules, getting-started
tips, Discord, and live server info.
No database, no external web service, no PlaceholderAPI dependency — it
works immediately after installation with sensible defaults.
Features
- First-join detection with a configurable welcome message, sound, and title
- A clean, configurable 27-slot (or larger) GUI with gradient MiniMessage styling
- Modular pages: Welcome, Rules, Getting Started, Discord, Server Info
- Fully configurable buttons — material, slot, name, lore, sound, enabled state
- Live server info (online/max players, uptime, world, version) computed on demand, no repeating tasks
- Optional "returning player" welcome-back message
- UUID-based onboarding persistence (
data.yml) that degrades gracefully if corrupted
/joinbook reload for safe, zero-downtime config reloads
/joinbook reset <player> for admins/testers
- Internal placeholder system (
%player%, %server%, %online%, %max_players%, %version%, %uptime%) — no PlaceholderAPI required
- Every player-facing string lives in
messages.yml
Requirements
- Paper (or a Paper fork) for Minecraft 1.21.x
- Java 21
Installation
- Download
JoinBook-1.0.0.jar
- Drop it into your server's
plugins/ folder.
- Restart the server.
config.yml, messages.yml, and data.yml are generated automatically in plugins/JoinBook/.
No further setup is required — the plugin works out of the box.
Configuration
Edit plugins/JoinBook/config.yml (formatting via MiniMessage):
first-join:
enabled: true
open-gui: true
delay-ticks: 20
gui:
title: "<gradient:#ff8acb:#b98cff><bold>JoinBook</bold></gradient>"
rows: 3
buttons:
rules:
enabled: true
slot: 10
material: BOOK
name: "<yellow><bold>Rules"
lore:
- "<gray>Read the server rules."
- ""
- "<green>Click to open"
After editing, run /joinbook reload — no restart needed. All player-facing
text lives separately in messages.yml.
Commands
| Command |
Aliases |
Description |
/joinbook |
/jb |
Opens your JoinBook (same as /joinbook open) |
/joinbook open |
|
Opens the JoinBook menu |
/joinbook reload |
|
Reloads config.yml and messages.yml |
/joinbook help |
|
Shows command help |
/joinbook version |
|
Shows plugin/server version info |
/joinbook reset <player> |
|
Resets a player's onboarding state |
Permissions
| Permission |
Default |
Description |
joinbook.use |
true |
Open and use the JoinBook menu |
joinbook.admin |
op |
Grants all administrative permissions below |
joinbook.reload |
op |
Reload configuration |
joinbook.reset |
op |
Reset a player's onboarding state |
评论 0
登录后参与评分
还没有评论,来抢沙发吧