📖 JoinBook
JoinBook is a lightweight Minecraft server plugin that automatically gives first-time players a customizable guide book when they join your server.
Create a better first-time experience by welcoming new players, introducing your server, displaying rules, explaining commands, and providing useful information.
✨ Features
- 📖 Automatically give a guide book to first-time players
- 📝 Fully customizable book content
- 📕 Automatically open the book when it is given
- 💬 Custom welcome messages
- 🎁 Optional starter kit support
- 🌍 Multi-language support
- ⚙️ Simple YAML configuration
- 🚀 Lightweight and easy to use
📋 Requirements
🖥️ Server Software
- Paper 1.20+
- Compatible with Bukkit, Spigot, Paper, and Purpur
- ⭐ Paper is recommended
☕ Java
- Java 17 or higher
📥 Installation
- 📦 Download the latest version of JoinBook.
- 📁 Place the
JoinBook.jarfile into your server'spluginsfolder. - 🔄 Start or restart your server.
- ⚙️ Configure JoinBook in
plugins/JoinBook/config.yml. - 🔄 Restart the server to apply your configuration.
⚙️ Configuration
JoinBook can be customized through its config.yml.
You can configure:
- 📖 Guide book content
- 🏷️ Book title
- 💬 Welcome messages
- 🌍 Language
- 🎁 Starter kit settings
The configuration file contains comments explaining the available options.
💻 Commands
| Command | Description |
|---|---|
/jb reload |
🔄 Reload the JoinBook configuration |
/jb give <player> |
📖 Give the JoinBook guide book to a player |
🔐 Permissions
JoinBook does not require any permission groups.
🎁 Starter Kit
JoinBook can optionally work with EssentialsX to provide a starter kit for new players.
⚠️ EssentialsX is only required if you want to use the starter kit feature.
JoinBook itself does not require EssentialsX.
🌍 Languages
JoinBook currently supports:
- 🇨🇳
zh_CN— Simplified Chinese - 🇺🇸
en_US— English
You can select the language in the configuration file.
💡 Use Cases
JoinBook can be used for many types of Minecraft servers:
- 🌲 Survival servers
- 🏠 SMP servers
- ⚔️ RPG servers
- 🎮 Minigame servers
- 👥 Community servers
- 🌐 Network servers
You can use the guide book to introduce:
- 📜 Server rules
- 💻 Commands
- ⭐ Server features
- 📚 Gameplay instructions
- ℹ️ Important information
- 💬 Community information
- 🧭 Server guides
🐛 Support
Found a bug or have a suggestion?
Please use the project's issue tracker to report it.
If you enjoy JoinBook, consider following the project on Modrinth to stay updated with new releases and features.
📄 License
Please check the license section of this project for information about using and redistributing JoinBook.
