Build-in-a-Box

Build-in-a-Box

THE CURRENT RELEASE IS BROKEN. USE THE DEVELOPMENT BUILDS

This plugin is being abandoned in favor of a 'lite' version which will not support storing container contents, Locking/Unlocking or block break protection. It was written as a proof of concept, and has served it's purpose, however, due to limitations of the bukkit api, it does not scale over long-term extensive use on a single server, it will accumulate stale data over time. There is no solution except to not store this data. Please do not post or message me asking for support. If you need a working version, download the latest development build. If you're considering using this plugin for a new server, please don't, unless you intend to keep it updated yourself (source code is on github)

Build-in-a-box adds special EnderChests which, when placed, will allow players to instantly and automatically construct a building. buildings can be locked, unlocked, picked up and placed again. In it's default configuration, Build-in-a-Box works almost exactly like the buildings from The Shotbow Network's Wasted, but it doesn't stop there. Almost every aspect of the plugin can be configured, you can easily disable the locking, unlocking and pickup features to provide simple pre-fab buildings for donator perks, or whatever you'd like to do with them.

Features

• [0.2.0] No longer uses WorldEdit for region selection, use a gold hoe instead (configurable)
• Fireworks!
• per-building-plan permissions for give, place, pickup, lock and unlock.
• Anti-cheat and NCP Support
• Automatic update notifications
• Configurable build speed and animations.
• Compatibility with logging/rollback plugins.
• Compatibility with land-protection plugins (WorldGuard, GriefPrevention, Towny, Factions etc)
• Buildings can be given in kits, sold in shops, etc.
• Economy support, add costs for build, pickup, lock and unlock actions.
• Fully translatable.
• Optional potion effect while carrying a building
• Container contents persist when carrying a building
• Building plans support individual lore descriptions
• Optional block-protection for all buildings.
• Configurable lock/unlock times

Commands

• /biab give [player] <buildingPlan> - give a player a Build-in-a-Box of the specified building.
• /biab save <buildingPlan> - save the current WorldEdit clipboard as a new building plan.
• /biab list [<page>] - list available building plans.
• /biab delete <buildingPlan> - Delete a building schematic.
• /biab setdescription <buildingPlan> <description line 1> | <description line 2> ...
• /biab setdisplayname <buildingPlan> <Display Name>
• /biab permanent - enter the command then punch an enderchest to convert the building to a permanent stucture.

Permissions

These have been overhauled in 0.1.6. you may need to make changes to your permissions.

• biab.save - allows a player to save building plans.
• biab.delete - allows a player to delete a building plan.
• biab.admin - combination of biab.give and biab.save
• biab.permanent - allows a player to use /biab permanent
• biab.unlock.others - allows a player to unlock another players BIAB Chest.

• biab.give.* - allows a player to give out any BIAB chest.
• biab.place.* - allows a player to place any BIAB chest.
• biab.pickup.* - allows a player to pick up any BIAB chest.
• biab.lock.* - allows a player to lock any BIAB chest.
• biab.unlock.* - allows a player to unlock any BIAB chest that is locked by them.

The .* permissions above apply to all available 'Building Plans', in addition to these, you may use the individual permission nodes for each building plan.

Tutorial

Defining new Buildings

BIAB doesn't come with any buildings, you'll have to create some.

• Build something... a house or tower, complete with the enderchest somewhere outside
• Use the worldedit wand (Wooden axe by default) to mark the corners of the area.
• use "/biab save mynewbuild" to save it.

The new building is now available to give to players using "/biab give <player> mynewbuild"

Configuration

BIAB can be configured to suit many situations. a fully documented config.yml can be found here

Translating

to translate BIAB into your own language:

• copy the default english.yml from plugins/BuildInABox/lang/ to a new name. (eg. esperanto.yml)
• translate the strings in the file.
• set the language config variable to your language name (eg. language: esperanto )
• restart the server.

note: a (possibly outdated) version of the default english.yml is available here

TODO

• save mode which takes the current building and enderchest with it.
• Allow schematics to use a 'padding block' (sponge?) to define blocks that should be left out underground.
• add an option to make locking actually lock the doors and containers to the buildings owner.

Source Code & Development Builds

Source code is available on Github

Development builds of this project can be acquired at the provided continuous integration server. These builds have not been approved by the BukkitDev staff. Use them at your own risk.

BuildInABox Development Builds

Other Plugins

• Scribe - Transfer enchantments from items to books using an anvil
• JukeLoop - Makes jukesboxes loop, rotate through nearby chests, activated by redstone and much more,
• EnhancedFishing - Adds tons of fishing enhancements including complete control over the bite chance.
• PotatoBombs - Allows players to craft poisonous potatoes into devastating and hillarious magical landmines.
• Saddlebags - Adds an inventory to saddled pigs.
• SalvageSmelter - Allows furnaces to smelt down tools and armor.
• Compressors - Turn hoppers into 'block compressors'.
• Autocrafter - Turn droppers into redstone-powered crafting tables.