Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Flavius12 committed Dec 31, 2014
1 parent 9473b40 commit ec5a42a
Showing 1 changed file with 63 additions and 2 deletions.
65 changes: 63 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:**

<dd><i>- Bug fix (if bugs will be found)</i></dd>
<dd><i>- Large Chest protection</i></dd>
<dd><i>- Possibly MySQL support</i></dd>

## FAQ

**How to lock/unlock a chest?**
<br>
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])*<br>
***/lockchest*** *- Lock a Chest*<br>
***/unlockchest*** *- Unlock a Chest*<br>

**Permissions:**

- <dd><i><b>chestlocker.*</b> - ChestLocker permissions.</i></dd>
- <dd><i><b>chestlocker.bypass</b> - Bypass chest lock.</i></dd>
- <dd><i><b>chestlocker.commands.*</b> - ChestLocker commands permissions.</i></dd>
- <dd><i><b>chestlocker.commands.help</b> - ChestLocker command Help permission.</i></dd>
- <dd><i><b>chestlocker.commands.info</b> - ChestLocker command Info permission.</i></dd>
- <dd><i><b>chestlocker.commands.lockchest</b> - ChestLocker command LockChest permission.</i></dd>
- <dd><i><b>chestlocker.commands.unlockchest</b> - ChestLocker command UnlockChest permission.</i></dd>

0 comments on commit ec5a42a

Please sign in to comment.