Bukkit

ToolBelt

About

This plugin provides a way to replace specific tools with special functionality. The idea originated from the VoxelDoop2 plugin, but has been re-written entirely for better code quality and to include permissions and yml configuration. The framework has been rewritten a second time now so that additional tools can be added more easily.

Setup

The process for setting up this mod is to drop it in your CraftBukkit plugins/ folder. Run (or /reload) bukkit, and it will create a ToolBelt/ folder with the config.yml file inside. Modify the file as wished (it is documented inside the file) and then run /tb reload to tell ToolBelt to reconfigure itself from modified config file.

Tools

• Block Duplicator (defaults to Stone Axe) Right click with this tool in your hand to get a stack of 64 of the selected block.
• Data Scrolling (defaults to Bone) Right or Left click with this tool to change the data value for the selected block. This lets you change a half-step from wood to stone to brick and so on.
• Paint Brush (defaults to Slime Ball) Left click to load a block type and data into the paintbrush, and Right click to paint the loaded data onto the selected block
• Leap (defaults to Feather) Right click to make large leaps through the air. This is similar to VoxelAir, only instead of hovering, left click can enter creative mode flight.
• Pickhax (defaults to Diamond Pickaxe) Left click to insta-delete a block. Right click to insta-delete without applying minecraft physics. Crouch to remove blocks at range (if have phax.range)
• Ruler (defaults to Paper) Left click in one spot, Right click in another, and get the width in x,y,z, total distance between points, and the enclosed volume.
• Watch (defaults to Watch) Left click to set personal time to day, right click for night. Crouch and click to re-sync with server time. If synced with server and have watch.server permission, left/right crouch click to set server time to day/night.
• Sledge (defaults to Gold Pickaxe) Left click to push a block forward into air, right click to pull it towards you. Crouch to push/pull into non-air blocks.
• Pliers (defaults to Glowstone Dust) Same as Sledge, except you copy the block instead of move it.
• Shovel (defaults to Gold Spade) Left click to remove (by default) a 3x3x3 cube of earth. Right click to remove a disk (by default) of radius 2.5, and crouch right click to remove a sphere (by default) of radius 2.5. By default, the shovel removes stone, dirt, grass, sand and gravel.
• Chainsaw (defaults to Gold Axe) Left click to remove (by default) a 3x3x3 cube of trees. Right click to remove a sphere (by default) of radius 2.5. By default, the chainsaw removes logs, leaves and vines.
• Tree (defaults to Gold Hoe) Right click to place a full tree where you click, Left click to change the type of tree to place. This uses the built-in tree generation code, and so will only place in locations where there is room for the full tree, and the appropriate ground below. The tool is disabled by default in config.yml .

Permissions

This help is now available in help/Permissions.txt. That file will be updated with every new release and will always list what is available.

• toolbelt.reload Give permission to reload the settings from the configuration file on the fly
• toolbelt.tool.* Give permission for all tool related settings
• toolbelt.tool.dupe Give permission to use the duplication tool
• toolbelt.tool.scroll Give permission to use the data scrolling tool
• toolbelt.tool.paint Give permission to use the paint tool.
• toolbelt.tool.paint.range Give permission to use the paint tool at a distance.
• toolbelt.tool.leap Give permission to make huge leaps with the leap tool.
• toolbelt.tool.leap.fly Give permission to enter creative mode flying by left clicking.
• toolbelt.tool.leap.tel Give permission to teleport by crouching while leaping.
• toolbelt.tool.phax Give permission to use the PickHax tool.
• toolbelt.tool.phax.range Give permission to use the PickHax tool at a distance.
• toolbelt.tool.ruler Give permission to measure distances easily with the ruler.
• toolbelt.tool.watch Give permission to set the time to day or night for themselves with the watch tool.
• toolbelt.tool.watch.server Give permission to set the server time.
• toolbelt.tool.sledge Give permission to push or pull blocks.
• toolbelt.tool.pliers Give permission to copy and push or pull blocks.
• toolbelt.tool.shovel Give permission to clear large amounts of (by default) stone, dirt, grass, sand and gravel.
• toolbelt.tool.saw Give permission to clear large amounts of (by default) logs, leaves and vines.
• toolbelt.tool.tree Give permission to rapidly place fully grown trees.

The warning/help messages can be configured per-user by the following permissions. Please only give any user one of these permissions at a time.

• toolbelt.print.debug Print all messages including ones that give debugging information.
• toolbelt.print.hint Print all quieter messages + hints for using tools.
• toolbelt.print.info Print all quieter messages + informational notices for tools.
• toolbelt.print.warning Print all quieter messages + warnings on wrong tool use.
• toolbelt.print.important Print important messages, such as loaded paint material and such.

There is an always up-to-date list of permissions in help/Permissions.txt inside the ToolBelt folder.

Commands

This help is now available in help/Commands.txt. That file will be updated with every new release and will always list what is available.

• /toolbelt or /tb
• /tb reload Reload the settings from the configuration file. (if you have the permission above)
• /tb tools See a list of all the tools you can use. (takes into account what tools are enabled and what you have permission to use)
• /tb off Allows a player to use the ToolBelt tools as they normally are, with ToolBelt not active. This is just for the person who ran the command.
• /tb on Allows a player to re-enable the use of ToolBelt tools.

Configuration

• config.yml The configuration file is heavily documented in the top comment. Please let me know if I'm not clear enough on any option and if I'm missing any configuration options that you wish for.
• help/<tool>.txt These files will give further information on the configuration settings for a given tool.

Additional links

The code for the plugin is available at github.