Upstream/Essentials
1
0
Fork 0
mirror of https://github.com/EssentialsX/Essentials.git synced 2024-11-24 03:25:34 +01:00
Code Issues Projects Releases Wiki Activity

Add color permissions documentation

md678685 2019-06-28 09:49:59 +01:00
parent c0408ff64f
commit f7f452669b
2 changed files with 65 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
Color-Permissions.md Normal file

@ -0,0 +1,52 @@
# Color Permissions
<!-- alternative title: Colo_u_r Permissions -->
EssentialsX includes permissions that let you control the individual formatting codes players can use in some commands.
This works for the following:
* Sending a PM with `/msg`: `essentials.msg.<suffix>`
* Sending mails with `/mail`: `essentials.mail.<suffix>`
* Setting your own nickname with `/nick`: `essentials.nick.<suffix>`
* Sending chat messages **(requires EssentialsX Chat)**: `essentials.chat.<suffix>`
* Colors on signs **(requires color signs to be enabled)**: `essentials.signs.<suffix>`
Below is a list of valid permissions suffixes. Note that some codes are only available on EssentialsX 2.16.1.169 and
above:
| Suffix | Color codes | EssentialsX version |
|------------------|---------------------------------------------------|---------------------|
| `color` (group) | `&0 &1 &2 &3 &4 &5 &6 &7 &8 &9 &a &b &c &d &e &f` | All versions |
| `format` (group) | `&l &m &n &o &r` | All versions |
| `magic` (group) | `&k` | All versions |
| `black` | `&0` | 2.16.1.169+ |
| `dark_blue` | `&1` | 2.16.1.169+ |
| `dark_green` | `&2` | 2.16.1.169+ |
| `dark_aqua` | `&3` | 2.16.1.169+ |
| `dark_red` | `&4` | 2.16.1.169+ |
| `dark_purple` | `&5` | 2.16.1.169+ |
| `gold` | `&6` | 2.16.1.169+ |
| `gray` | `&7` | 2.16.1.169+ |
| `dark_gray` | `&8` | 2.16.1.169+ |
| `blue` | `&9` | 2.16.1.169+ |
| `green` | `&a` | 2.16.1.169+ |
| `aqua` | `&b` | 2.16.1.169+ |
| `red` | `&c` | 2.16.1.169+ |
| `light_purple` | `&d` | 2.16.1.169+ |
| `yellow` | `&e` | 2.16.1.169+ |
| `white` | `&f` | 2.16.1.169+ |
| `bold` | `&l` | 2.16.1.169+ |
| `strikethrough` | `&m` | 2.16.1.169+ |
| `underline` | `&n` | 2.16.1.169+ |
| `italic` | `&o` | 2.16.1.169+ |
| `reset` | `&r` | 2.16.1.169+ |
The individual permissions take priority over the "group" permissions. For example, if you set `essentials.nick.color`
to `true` then set `essentials.nick.black` to `false`, players will be able to set their nicknames to any color
except black.
## Nicknames
If you want players to be able to change the color of their nickname but not the text itself, set the permission
`essentials.nick.changecolors` to `true`. This will let them use color codes in their nickname, but the text will still
have to match their own username.

25
Home.md

@ -2,7 +2,7 @@
EssentialsX is a fork of the original [Essentials](https://github.com/essentials/Essentials). Most commands and permissions work the same way. Old Essentials files are compatible with EssentialsX and will be updated when you first run EssentialsX
**Commands list:** https://essinfo.xeya.me/commands.php
**Commands list:** https://essinfo.xeya.me/commands.php
**Permissions list:** https://essinfo.xeya.me/permissions.php
**Note:** When updating EssentialsX, you need to update *all* the modules to the same version to prevent version mismatch errors. In addition, you may want to update your config file - the latest config file can always be found [here](https://github.com/EssentialsX/Essentials/blob/2.x/Essentials/src/config.yml).
@ -10,6 +10,7 @@ EssentialsX is a fork of the original [Essentials](https://github.com/essentials
## Pages
* [Banner Metadata](BannerMeta)
* [Command Cooldowns](Command-Cooldowns)
* [Color Permissions](Color-Permissions)
## Improvements over Essentials and Spigot Essentials
* Actively maintained and updated for the latest Spigot and Minecraft versions at all times, retaining support going back to 1.8.
@ -38,7 +39,7 @@ Permissions have been added for each gamemode with the EssentialsX `/gamemode` c
* `essentials.gamemode.adventure`
* `essentials.gamemode.spectator`
* `essentials.gamemode.all`
**Note**: `essentials.gamemode` is still required to execute the /gamemode (and its aliases) command.
### Kits changes
@ -57,16 +58,16 @@ kits:
You can also include `{player}`, which will be substituted for the player's name.
#### `/showkit`
Command: `/showkit <kitname>`
Permission: `essentials.showkit`
Shows a list of kit contents straight from config file.
Command: `/showkit <kitname>`
Permission: `essentials.showkit`
Shows a list of kit contents straight from config file.
![showkit](https://i.imgur.com/d4Ff8vN.png)
#### `/createkit`
Command: `/createkit <kitname> <delay>`
Permission: `essentials.createkit`
If `pastebin-createkit` is set to false, creates a kit from your inventory and puts it in the `kits.yml` file.
If `pastebin-createkit` is set to true, creates a kit based on your inventory and returns a link to the file to add to your `kits.yml`.
Command: `/createkit <kitname> <delay>`
Permission: `essentials.createkit`
If `pastebin-createkit` is set to false, creates a kit from your inventory and puts it in the `kits.yml` file.
If `pastebin-createkit` is set to true, creates a kit based on your inventory and returns a link to the file to add to your `kits.yml`.
![createkit](https://i.imgur.com/nXMlNGP.png)
### Forcefully disable teleportation safety
@ -120,7 +121,7 @@ Typing `/seen SupaHam` and `/seen 5552e21d-de79-40bc-89da-62ee63244fb2` are now
**Note**: As of [build 262](https://ci.ender.zone/job/EssentialsX) (c6d2746), this feature can now be enabled by setting the `world-time-permissions` config property to `true`. `world-time-permissions` is set to false by default.
Prior to this build, players with the permissions `essentials.time` and `essentials.time.set` were able to set the time in any world, despite world-permissions provided via permission plugins. This build provides the feature of per world permissions for setting the time of a world.
Prior to this build, players with the permissions `essentials.time` and `essentials.time.set` were able to set the time in any world, despite world-permissions provided via permission plugins. This build provides the feature of per world permissions for setting the time of a world.
#### Permissions
| Permission | Description |
@ -150,7 +151,7 @@ PR #198 introduced the ability to limit /nick to only allow color changes, ensur
However, this feature also introduced the `essentials.nick.changecolors.bypass` permission node. Where if a player has the preceeding permission they are allowed to bypass the check and thus be able to change the characters of their name. This was originally created to ensure convenience for Server Operators without breaking functionality when they updated EssentialsX.
**Note**: This permission requires the `essentials.nick.color` permission in order to use colors in the nickname to begin with.
**Note**: This permission requires the `essentials.nick.color` permission in order to use colors in the nickname to begin with.
### Teleport to spawn when joining
@ -225,4 +226,4 @@ The following table defines the permissions introduced in this feature.
### Helmet slot hat
**This was introduced in [7958cd0](https://github.com/EssentialsX/Essentials/commit/7958cd0b880205edaeaf34420bafde8d5cc1f7ed) - the first release to include this feature was 2.15.0.**
If `allow-direct-hat` is enabled in the `config.yml`, then players with the permission `essentials.hat` can click on their helmet slot to place any block on their head, not just helmets.
If `allow-direct-hat` is enabled in the `config.yml`, then players with the permission `essentials.hat` can click on their helmet slot to place any block on their head, not just helmets.