From ec5a42ae2a40e250854642ee86ea3cbcbcfe19f6 Mon Sep 17 00:00:00 2001 From: Flavius12 Date: Wed, 31 Dec 2014 16:07:37 +0100 Subject: [PATCH] Update README.md --- README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 63 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6f24577..ee47264 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,65 @@ -ChestLocker -=========== +# ChestLocker Chest Locker plugin for PocketMine-MP + +## Category + +PocketMine-MP plugins + +## Requirements + +PocketMine-MP Alpha_1.4 API 1.8.0 + +## Overview + +**ChestLocker** allows players to lock/unlock their chests. + +**EvolSoft Website:** http://www.evolsoft.tk + +***This Plugin uses the New API. You can't install it on old versions of PocketMine.*** + +Players can simply lock/unlock their chest using commands "/lockchest" and "/unlockchest". + +**Commands:** + +***/chestlocker*** *- ChestLocker commands* +***/lockchest*** *- Lock a Chest* +***/unlockchest*** *- Unlock a Chest* + +**To-Do:** + +
- Bug fix (if bugs will be found)
+
- Large Chest protection
+
- Possibly MySQL support
+ +## FAQ + +**How to lock/unlock a chest?** +
+Do "/lockchest" or "/unlockchest" then click the chest you want to lock/unlock + +## Documentation + +**Configuration (config.yml):** +```yaml +--- +#Protect locked chests from destroying (It can be bypassed with the permission: chestlocker.bypass) +protect-chests: true +... +``` + +**Commands:** + +***/chestlocker*** *- ChestLocker commands (aliases: [chlock, chl, chestlock, cl])*
+***/lockchest*** *- Lock a Chest*
+***/unlockchest*** *- Unlock a Chest*
+ +**Permissions:** + +-
chestlocker.* - ChestLocker permissions.
+-
chestlocker.bypass - Bypass chest lock.
+-
chestlocker.commands.* - ChestLocker commands permissions.
+-
chestlocker.commands.help - ChestLocker command Help permission.
+-
chestlocker.commands.info - ChestLocker command Info permission.
+-
chestlocker.commands.lockchest - ChestLocker command LockChest permission.
+-
chestlocker.commands.unlockchest - ChestLocker command UnlockChest permission.