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.savebiab.permanent
- allows a player to use /biab permanentbiab.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
fromplugins/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.
@Wonkee
Sorry, The build server is still down, I've not had time to bring it back up. :( I will have it up by friday at the latest, promise.
Hello
@metalhedd
Did the link change or is it not fixed yet?
Guy on video sounds like Kip Kay.
hi - I cannot find a working link to dev builds , the one above does not work.
Could you recommend a good plugin for selling the build boxes?
dev build page no longer available?
First of, this plugin is amazing, so many possibilities.
I'm assuming redstone doesn't work because it changes blocks inside the build?
EDIT: It seems I'm wrong, redstone does work lol.
@levisn1
as long as your buildings are a reasonable size, there will be no additional lag. if your schematics are enormous there may be some lag during the initial placement of the building.
Simple question, can i give this to my donors? Or it probably makes the server lags?
@Den00
Sorry doing some reorganizing. it should be back this evening
Can't access your build server
Great plugin! Had it recommended by a user and now supporting it as an optional dependency in MyZ!
@yurikoma
It's partially implemented (but untested) in the development builds. I honestly don't know if/when I'll have time to come back to this plugin, it requires a pretty significant amount of work. I'll hoping to do it at some point during the 1.7 lifetime.
is •save mode which takes the current building and enderchest with it.
Completed yet in the Dev builds?
seems like it has been on the todo list a long time
When will you be adding support for 'Allow schematics to use a 'padding block' (sponge?) to define blocks that should be left out underground'
How about support to turn the box item invisible to other players except people with a permission and owners? such as biab.seeblock
I'm sure owners wont like having a box/item setting where everyone can see it except for them
@metalhedd
Which development build should I use?
@MCJackJ
Use the development builds :)
@think420
The current stable build is broken, and the current development build has a broken feature (some partial support for the enderchest being outside of the selection, stored as the schematic's anchor point) but it's not working correctly.
It's also built on top of a library I quickly threw together to manipulate schematic files, which need to be refactored to support multiple versions of craftbukkit, otherwise BIAB builds are very cumbersome to put together. It's been a tricky process and I haven't quite figured out how to do it right yet.
@metalhedd This plugin shows incredible promise! Do you need help testing specific things or just need bug catchers?
Sent a small donation your way, keep it up bud!