Bunny Doors
1 Bunny Doors
This plugin lets you lock specific doors and chests on your server with a particular key. Only players with that key can open the door.
- Quick Start : https://github.com/jonnay/BunnyDoors/wiki/Quickstart
- Documentation : https://github.com/jonnay/BunnyDoors/wiki/
- Source Code : https://github.com/jonnay/BunnyDoors/
There are plenty of plugins that give you specific custom permissions for doors but this plugin is different. The point of this plugin is to emulate old-school JRPG doors (Think Dragon Quest). It aims to be easy for you to create doors that require keys. I've been wanting doors-with-permissions for a long time now, and decided to roll my own.
Make Citizens NPCs give your players special keys for completing quests! Give your theif Hero class the ability to pick locks! Give VIPs special access! So many possibilities!
1.1 Features
- Create an unlimited number of doors, and an unlimited number of keys to unlock them!
- Use with any permissions system.
- Simple Spout integration, with more coming!
- Keys are implemented as permissions, so you can use it with a variety of other plugins to enhance your experience.
- With Vault installed, you can put keys inside of chests!
2 Requirements
Bunny Doors will work, as is, out of the box, without any other plugin. It is HIGHLY recommended that you have a region protection plugin like Worldguard. (If you know of any other region protection plugins, then I'd like to hear about them, so I can update this document)
The only requirements around a protection plugin, is they must block a user from placing or removing blocks in the area where your door is.
Beyond the protection plugin of your choice, if you have Spout or Vault installed, then BunnyDoors will give you extra functionality. It's called progressive enhancement baby, and it rules.
2.1 Protection Plugins
2.2 Vault: http://dev.bukkit.org/server-mods/vault/
- Gives you access to the
/bunnykey give
command - Allows keys to be put inside of chests
2.3 Spout: http://dev.bukkit.org/server-mods/spout/
- Allows keys to be put inside of chests
- Sends "Achievement Get!" style notifications when the user opens their inventory, or gets a key from a chest.
3 Open source!
I am leaning plugin development by looking at other peoples source, and basically standing upon the shoulders of bukkit giants. So NOT making this plugin open source would be insane, and kinda lame.
Source code: https://github.com/jonnay/BunnyDoors
Instead of large grand plans, I have a set of very small discreet releases planned. If anyone wants to help, they are more then welcome to fork the repo, and I will pull the changes (assuming they work). Please feel free down download an contribute.
finally, there is a better then even chance that at some point, I will stop developing this plugin (due to time constraints, hatred of writing java, or a case of hey-look-at-that-shiny-thing-over-there). When that inevitability happens, I want to make sure that you, as a server admin, can update the plugin for whatever new version of Bukkit comes out. It also means
4 Changelog
- 0.1
- First version
- 0.2
-
- Added Serialization scheme
- added config file, with ability to customize keys
- added /bunnydoor lock command
- added /bunnydoor unlock command
- added /bunnydoor reload command
- 0.3
-
- added /bunnykey command (with list, listall and add subcommands)
- locked doors close after 10 seconds.
- debugging is turned off (Sorry about the spam)
- 0.4
-
- fixed /bunnykey permissions issue
- implemented /bunnykey give command
- added ability to turn off devilstats in the config. (this should have been in there earlier. Sorry)
- Fixed a door bug where the bottom half of the door gets copied into the top
- Door info now displays more info about doors (i.e. who locked it) It's prettier too.
- 0.5
-
- Added very basic spout support through the notification interface. Note that this is only a "soft dependency". You don't need spout to make it go!
- 0.6
-
- Chests are now lockable too.
- Added API Call for other plugins
- A key can be put inside of chests with
/bunnykey put <key>
and taken out with/bunnykey take
- 0.7
-
- Fixed a problem with the keys being listed in the inventory for non-spoutcraft clients
- Trap Doors are lockable!
- Item Keys!
- Config option to set when the door auto-closes (closeDoorAfter)
- Config option on to control when the key notification text is sent to vanilla clients (notifyVanillaClientsOn) use 0 to disable it completely
Date: 2012-02-18 14:46:01 MST
Author: Jonathan Arkell
Org version 7.7 with Emacs version 24
Getting this error, when I am running this on my 1.6.4 Server =(
So I installed vault... and it says this when I type the command "/bunnykey give konny1357 House":
"[SEVERE] No Vault support! Can't give player konny1357 the BunnyKey House"
what should i do?
Is it going to update? or is it inactive forever?
This is actually working just fine with the latest version of Bukkit. :) Great plugin.
@jonnay23
Hey,can i have the permission to update and take the plugin? thanks
I would love to see something like this updated.
Do you know if it works in the latest Bukkit build Jonnay?
Proved to be 100% awesome! I think it's a lot better than most locking plugins. P.S. Awesome Totoro Avatar. :D
@LoulouteFlore
Yeh, I have to recreate after server restart too.
Also,I have Vault installed, but it says I need to tell the server admin to install Vault??
@jonnay23
Just to say.... AWESOME!!!
that is exactly what I was looking for, it is working just fine with the last bukkit version!
Thank you a lot, combined with some others plugins, it makes the whole thing awesome :D
I have just something to ask: is this normal that I have to recreate each key and lock every doors again after a server restart?
thank you :)
PS: sorry for my english, I am trying to do my best :D
Been Exceedingly Busy, and it likely won't stop. No new improvements.
If anyone is willing to take over the project, then they are more then welcome. Fire me an email.
That said, everything should still WORK.
By the way, BunnyDoors works with 1.2x, just so long as you turn off the devilStats by putting
devilstats: false
in your config.yml
@GeoCraft
Ohhh, I see. I think. I am not sure how that would work with what is already established with Bunny Doors. Let me ask a few more quesitons:
How is the item that you get when you right click determined? Is it random? set up in a config somewhere?
I am a little worried, because this would conflict with the existing item keys in place.
I am still quite slammed at work, but I hope to do the key granting soon, which will be about 1/3rd of what you're after. ;)
@jonnay23
Well, what I meant was having it so you could use items such as gravel or feathers to open locked doors. For example, if I right-clicked a door, lets say door1, that door would have a lock placed on it and I would receive an item, lets say a feather. The only way to open door1 would be to have the feather, making the feather a unique key to door1. To open door1, I would need to have the feather in my hand.
@GeoCraft
Hey, sorry, can you be a little more specific? You want locks to be craftable?
It's a bit above and beyond the feature-set I was planning. So I'll put that in the todo list, but I don't think i'll get to that immediately.
I would love love love love love you if you could incorporate something like this with item keys and not just blocks: http://dev.bukkit.org/server-mods/lwckeys/
Finally i found this plugin !! I was searching many days for a plugin that locks doors ... Then this came !
As it turns out, I am on my way to Germany (!) for a business trip. I won't be back till early march.
As usual, code is in Git. Feel free to fork the code if need be!
@TLotaku
I'll Work on the quick start guide so that it is easier to work with.
Do you know which permissions system you are using? Which config file are you using?
Could someone tell me how to give someone permission to use
bunnydoors.keycmd.use
bunnydoors.keycmd.list
I thought I understood, but even when I added it and put users in there to give access to commands on my server, it still.. well, didn't give them permission. So say if I have userA and userB and want to let them use keys and see the list of keys they have, can someone tell me what I put in the config file to allow them to do so? Do I have to give myself admin first?
For someone kind of new to stuff like this, it's kind of confusing looking at the "quick startup" and seeing you have to add in these things yourself and thinking you've done it only to have it not work anyway.