📖 Project Overview
BookShelfInfo is a Minecraft plugin that allows players to interact with and inspect Chiseled Bookshelves in a more detailed manner. With this plugin, players can easily see the contents of bookshelves, including book titles and authors, by simply interacting with them. Server administrators can toggle the plugin's functionality on or off using simple commands.
📋 Features
- View Bookshelf Contents: Players can inspect Chiseled Bookshelves to view the titles and authors of books stored inside.
- Book Metadata Display: The plugin displays detailed metadata, including whether a book is signed or unsigned.
- Admin Control: Administrators can enable or disable the plugin's functionality with simple commands.
- Custom Messages: When a player interacts with a bookshelf, the plugin sends a neatly formatted message displaying the contents of the shelf.
🛠️ Commands
The BookShelfInfo plugin provides simple commands to control its functionality:
Command | Description | Usage | Permission |
---|---|---|---|
/bookshelfinfo enable | Enables the plugin. | /bookshelfinfo enable |
bookshelfinfo.command |
/bookshelfinfo disable | Disables the plugin. | /bookshelfinfo disable |
bookshelfinfo.command |
🔑 Permissions
The plugin uses a straightforward permission system to manage access to its commands:
Permission | Description | Default |
---|---|---|
bookshelfinfo.command |
Allows use of the /bookshelfinfo commands. |
OP |
⚙️ Configuration File
The plugin generates a configuration file (config.yml
) that allows administrators to toggle the plugin's status.
Example configuration:
enabled: true
🚀 Quick Start Guide
- Install the Plugin: Download the
.jar
file and place it in your server'splugins
folder. - Start or Restart the Server: Start the server to enable the plugin.
- Enable or Disable: Use
/bookshelfinfo enable
or/bookshelfinfo disable
to control the plugin’s functionality.
Using the right mouse button, click on the chiseled bookshelf — the chat will display the titles and authors of the books on that shelf.