BuildersWand

BuildersWand

Introducing BuildersWand! A free, open-source solution that gives you, and your players, the power to build quickly without breaking a sweat.

Relevant commands:

• /builderswand (Aliases: /bw) » Main command for the plugin, shows valid usage if run without arguments.
• /builderswand reload (Alias: /bw reload) » Reloads wands from the configuration file into memory.
• /builderswand list (Alias: /bw list) » Lists all wands currently configured in the plugin.
• /builderswand give <wand> <player> (Alias: /bw give) » Gives the specified player the specified wand.

Relevant permissions:

• builderswand.admin » Grants access to all admin commands and permissions.
• builderswand.use.<wand> » Allows the player to use the specified wand. Has wildcard support (e.g., builderswand.use.* to allow all wands).
• builderswand.give » Allows the player to give wands to other players.
• builderswand.reload » Allows the player to reload the plugin configuration.
• builderswand.list » Allows the player to list all configured wands.
• builderswand.notify.update » Allows the player to receive update notifications. This is a configurable permission node.

If you have any questions, feature requests, or issues, please contact me through my support Discord: https://discord.gg/j8xgCJQfGN

For anyone wondering, this is (moreorless) a spiritual successor to the abandoned BuildersWand Premium resource: https://www.spigotmc.org/resources/abandoned-builders-wand-premium-building-util-api-configurable-1-8-1-20-4.105953/.

Additionally, feel free to contribute through the GitHub repository (if possible, please ask me first so that we can hash out a good plan for your implementation first).

API

BuildersWand does feature an API, but currently there is no documentation nor hosted API jar that can be depended on. **If you are a plugin author and looking for an implementable API, please contact me via my support Discord above and let me know that there is some level of interest.**

Default Configuration

# BuildersWand Configuration File

# this is the prefix for all messages sent by the plugin.
# this is an optional setting, if you remove it the default prefix will be used
# supports minimessage formatting (along with the display name and lore of wands)
prefix: "&7[&bBuildersWand&7] &r"

# this isn't required for the build wand to work, but it does reduce the amount of fired events when placing blocks through the wand
# set to false if you want to handle block place event cancellations yourself and don't want extra events fired
# set to true if you want to allow other plugins to handle block place event cancellations (like WorldGuard or SuperiorSkyblock)
fireWandBlockPlaceEvent: true

# this isn't required for the build wand to work, but it does reduce the amount of fired events when using the wand
# set to false if you don't want to add extra logic to wand usage, ideal for servers with a lot of players
fireWandPreviewEvent: true

# This can be disabled if you want blocks to be placed instantly.
# If you notice a performance impact definitely enable this and adjust the maxBlocksPerTick value.
placementQueue:
  enabled: true
  maxBlocksPerTick: 20 # max blocks to place per tick

# Whether to automatically remove invalid wands from players' inventories
# An invalid wand is one that has been removed from the config or has otherwise become invalid
# this should be kept disabled until you are sure your wands are configured correctly
destroyInvalidWands:
  enabled: false
  message: "&4The wand you had was misconfigured and has been removed. Please contact an administrator immediately."

updater:
  enabled: true
  checkIntervalMinutes: 60
  notifyMessage: "&aAn update for BuildersWand is available! Check console for more info." # this message is sent in chat to those who have the permission node listed below
  notifyPermission: "builderswand.notify.update"
  notify:
    console: true
    ingame: true

# Only recommended when troubleshooting issues since it can generate a lot of log spam. defaults to false
debug: false