Bookshelves You Can Use

Description

Bookshelves You Can Use is a Minecraft plugin that turns bookshelf blocks into usable storage containers. Right-click any bookshelf block to open a 9-slot inventory where you can store and retrieve items.

Supported Minecraft Versions

This plugin is supported on the Minecraft versions listed in minecraft-versions.json: currently 1.19.4, 1.21.11, 26.2 and 26.3 (Spigot and its forks). Every stable release is booted on a real server of each of these versions before it is published, and every build checks that the plugin only uses Bukkit API that exists on all of them. Other versions from 1.19.4 onwards are expected to work but are not tested. To support another version, add it to the file: both checks pick it up.

Installation

First Time Installation

1. Download the plugin JAR.
2. Place the JAR in the plugins folder of your Spigot server.
3. Restart your server.

Usage

Documentation

• User Guide – Getting started and common scenarios
• Commands Reference – Complete list of all commands
• Configuration Guide – Detailed configuration options

Support

You can find the support Discord server here.

Experiencing a bug?

Please fill out a bug report here.

• Known Bugs

Usage reporting

Usage reporting is on by default: when the plugin is enabled, and each time a player runs one of its commands, it sends its name, its version and the command's name to the author's trace server at https://trace.danielstephenson.dev, so it is known which plugins are actually in use. Nothing about players, worlds or IP addresses is sent, and nothing typed after a command. The plugin prints one line on every startup saying whether reporting is on and, if not, why.

Each event also carries a random server ID (the server-id line in plugins/trace/config.yml) so servers can be counted rather than events. It identifies no person, account or IP address; delete the line to get a new one.

Repeated uses of the same command within a minute are counted rather than sent one by one: the first is sent at once, and the rest follow as a single event carrying the count (tag coalesced) when the minute ends or the plugin is disabled. startup is always sent at once.

To turn it off:

• for this plugin only: usage-reporting.enabled: false in plugins/BookshelvesYouCanUse/config.yml
• for every plugin on the server that reports to trace: enabled: false in plugins/trace/config.yml (created on first start; plugins never turn it back on)
• for the whole server process: the environment variable TRACE_USAGE_REPORTING=off or DO_NOT_TRACK=1

Details: https://github.com/Stephenson-Software/trace#usage-reporting

Contributing

• CONTRIBUTING.md

Testing

Build

Linux / macOS:

mvn clean package

Windows:

mvn clean package

This also runs the unit tests under src/test/java/. If you see BUILD SUCCESS, the build and the tests have passed.

Development

Local Testing

1. Build the plugin: mvn clean package
2. Copy the JAR from target/ into your test server's plugins/ folder.
3. Start the server.

Authors and Acknowledgement

Developers

Name	Main Contributions
Daniel McCoy Stephenson	Creator and primary developer

License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0).

You are free to use, modify, and distribute this software, provided that:

• Source code is made available under the same license when distributed.
• Changes are documented and attributed.
• No additional restrictions are applied.

See the LICENSE file for the full text of the GPL-3.0 license.

Project Status

This project is in maintenance mode.

Changelog

See CHANGELOG.md for a release-by-release summary of changes.