MiniBookMiniBook

Getting Started 📖

1️⃣ Installation

To get started with MiniBook, you first need to install the plugin on your Minecraft server. Follow these steps for proper installation:

  • Requirements: You will need Paper or Purpur, as MiniBook is not compatible with vanilla CraftBukkit.
  • Optional Dependencies: PlaceholderAPI is optional but recommended to enable dynamic content in book pages.

Once downloaded, place the plugin in your server's plugins folder and restart or reload the server. For the latest releases and updates, visit the GitHub Repository.

2️⃣ Create and Manage Books

Now that you have MiniBook installed, let's learn how to create and manage books on your server.

✨ Create a Book

To create a new book, use the following command:

/mk create <book_id> "<title>" "<author>"

Replace the placeholders accordingly:

  • <book_id> — The internal codename for the book.
  • <title> — The display title of the book.
  • <author> — The book's author (can be your server or plugin name).

Example: /mk create tutorial "MiniBook Tutorial" "Admin"

🛠️ Managing Books

  • Open a Book for a Player
/mk open <book_id>

Example: /mk open tutorial

  • Delete a Book
/mk delete <book_id>

Example: /mk delete tutorial

  • List All Books
/mk list

Shows all books available on the server.

  • Reload Books
/mk reload

Reloads all books from disk, updating any changes.

3️⃣ More Resources

For more information on commands, placeholders, and API usage, check out the following sections:

Now you're ready to start creating and managing books in MiniBook. Explore the API and commands to fully customize your server's experience. 🚀

Previous
Setup
MiniBook
Next
Commands
Plugin