[ci-skip] Document permission nodes

This commit is contained in:
William Blake Galbreath
2019-05-19 08:50:46 -05:00
parent a241be765f
commit e3358589d8
2 changed files with 33 additions and 0 deletions

View File

@@ -17,4 +17,5 @@ changes to suit our server that are deemed too wild to be included directly upst
:titlesonly:
configuration
permissions
contact

View File

@@ -0,0 +1,32 @@
==========
Permissions
==========
.. contents::
:depth: 2
:local:
Permissions
=======
Purpur adds a few new permission nodes for some of it's added features.
By default **all** of these permissions are for OP users only. Any other users will
need to be granted the permissions you want them to have using a permissions plugin.
* **allow.ride.<mob_id>**
- **description**: This permission gives the ability to ride a certain mob by shift
right clicking it. Once mounted you can use WASD to move around, and spacebar to jump
or fly. Just replace "<mob_id>" with the mob's Entity ID.
- **examples**:
- `allow.ride.cow`
- `allow.ride.zombie_pigman`
- `allow.ride.snow_golem`
* **purpur.drop.spawners**
- **description**: Players with this permission can use a diamond pickaxe with silk
touch enchantment to mine up any spawner cage instead of disappearing.
* **purpur.place.spawners**
- **description**: Players with this permission can place down a spawner cage and
have the mob type restored to what it was when it was mined using silk touch.