config.yml 📝

📄 Introduction

The config.yml file is the main configuration file for the MiniBook plugin. It allows you to control general plugin behavior, debugging options, and which book (if any) should be automatically opened when a player joins the server.

This file is designed to be simple and flexible, making it easy to adapt MiniBook to your server’s needs.

💡 Breakdown of the config.yml file

settings:
  debug: false
  welcome_book: welcome

• settings: General plugin settings.

  • debug: This is used for plugin testing in development environments.
    Options: true, false

  • welcome_book: Defines the ID of the book that will automatically open when a player joins the server.

    • Set a valid book ID (e.g. welcome) to open that book on join.
    • Set to none to disable the welcome book feature entirely.

📜 Notes & Tips

• Changes to config.yml usually require a plugin reload using /minibook reload.
• If welcome_book is set to a book ID that does not exist, no book will be opened.
• The debug option is intended for developers or advanced users and may produce extra console output.

With this configuration, you can easily control how MiniBook behaves on your server and customize the player experience from the moment they join 📘