lMartin3 / BetterShulkerBoxesRewritten

BetterShulkerBoxes rewritten to improve code quality and mantainability
GNU Affero General Public License v3.0
7 stars 16 forks source link

Codacy Badge

Better Shulker Boxes Rewritten

Better Shulker Boxes is a Spigot plugin for Minecraft that allows players to open shulker boxes more easily, by right-clicking while holding them or just right-clicking them in the inventory.

The plugin is 100% customizable, you can change or disable the shulker open/close sounds and messages.

This project currently supports Spigot and PaperSpigot versions 1.13 and above, only the latest builds are supported. The plugin will most probably work on custom forks, but it is not guaranteed.

For more information, please visit the Spigot resource page.

Installation

1- Download or compile the JAR
2- Drop the JAR in your server's plugin folder
3- Restart your server

Configuration

Tweak the plugin's settings in the config.yml file, it will be generated once the plugin runs for the first time, and it should be located in /plugins/BetterShulkerBoxes.
Go to this link to see the default configuration settings, every option has an explanation of what it does.

Translations

To see all the available translations, please go to the translations folder.
Available translations:

Commands

Command Description
/bsb reload Reload the configuration
/bsb check Check for updates

Using hex colors, gradients, rainbows and more

BetterShulkerBoxes supports regular color encodings (& + letter) as well as hex colors. These can be used with xml tags,

Pattern Tag Example
Fixed hex color <#COLOR> <#FF0000>This is red
Color gradient (2 hex values)
(Currently broken)
<g#STARTCOLOR:#ENDCOLOR> <g#FF0000:#00FF00> this goes from red to green
Rainbow \<r> \<r>This is a rainbow
Stop pattern \<r> or \<g> <#FFFFFF>This is white\<r> and this is not

Contact info

Discord: link to server
SpigotMC Forums: Rektb
GitHub: Issues page

FAQ

How do I disable the shulker box messages?

Set the open and close messages to empty quotes, like this:

open_message: ''
close_message: ''

I found a bug, what should I do?

If find a bug, please open an issue on GitHub or reach out to me via Discord or Spigot DM.

I have a feature suggestion

Please open a GitHub issue or reach out to me.

Can I submit a translation?

Of course! Please open a pull request or contact me

Where can I download the plugin from?

Download it from the Spigot resource page, this repository or compile it yourself. For security reasons, please avoid downloading the plugin from any other site.

Can I fork/modify your plugin?

Yes, you can, as long as you comply with the license (AGPLv3)