KnarCraft/PermissionSigns
KnarCraft/PermissionSigns
1
0
Fork 0
Code Issues 4 Pull Requests Projects Releases 2 Wiki Activity

Updates plugin information in the README

Browse Source
This commit is contained in:
Kristian Knarvik 2022-01-22 20:59:07 +01:00
parent ee4f4355f5
commit 0fab9e26f4
1 changed files with 42 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@ -14,32 +14,54 @@ permanently by another cause, when they expire.
## Commands
- /ps about - Displays information about the plugin
- /ps create <name> <permission,permission> <cost> <duration> - Creates a new permission sign. The name is used to
describe what the permission sign does. The permission,permission is the list of comma-separated permissions the
permission sign will grant to the using player. The cost is the cost to use the permission sign. The duration is the
number of seconds the player should keep the permission for. Use 0 for permanent.
- /ps cancel - Used to manually cancel the creation of a permission sign (it will also time out after 60 seconds)
- /ps reload - Used to reload all data and config settings from disk
| Command | Permission | Description |
| -------- | -------- | -------- |
| /ps about | None | Displays information about the plugin |
| /ps create | permissionsigns.admin.create | Used for creating a new permission sign |
| /ps cancel | permissionsigns.admin.create | Used for manually cancelling a permission sign creation request |
| /ps reload | permissionsigns.admin.reload | Used for reloading data and config values from disk |
### The create command
/ps create <name> <permission,permission> <cost> <duration> - Creates a new permission sign. The name is used to
describe what the permission sign does. The permission,permission is the list of comma-separated permissions the
permission sign will grant to the using player. The cost is the cost to use the permission sign. The duration is the
number of seconds the player should keep the permission for. Use 0 for permanent.
#### The create command permission list
The simplest way of using the permission field is to just specify one permission such as `essentials.gamemode.creative`,
but you can put any number of comma-separated permissions in the field such
as: `essentials.gamemode.creatice,essentials.gamemode.survival,essentials.gamemode.spectator`.
This plugin also supports per-world permissions. By default, permissions are set for all worlds. You can change a
setting in the config to only grant the permission for the world the clicked sign belongs to. In addition to this, you
can override the default behavior by specifying the world before each permission node. *Any* specifies that a permission
should be given regardless of world, and *World_Name* specifies that a permission should only be set for the given
world. *World_Name* can also be specified as a different world that the one the permission sign belongs to.
The syntax for specifying the world is: `world:permission`, so for a list of permissions, it would be like
this: `world:essentials.gamemode.creatice,any:essentials.gamemode.survival,world_nether:essentials.gamemode.spectator`
## Permissions
- permissionsigns.* - Grants all PermissionSigns permissions
- permissionsigns.use - Allows players to use the permission signs
- permissionsigns.admin - Allows all administrative tasks such as creating permission signs and reloading
- permissionsigns.admin.reload - Allows the usage of the /reload command
- permissionsigns.admin.create - Allows players to create/destroy permissionsigns
| Node | Description |
| -------- | -------- |
| permissionsigns.* | Grants all permissions |
| --permissionsigns.use | Allows the usage of permission signs |
| --permissionsigns.admin | Allows the creation of permission signs and access to the /reload command |
| ----permissionsigns.admin.reload | Allows the usage of the /reload command |
| ----permissionsigns.admin.create | Allows the creation of permission signs |
## Configuration options
- language - The language used for the plugin (en, nb-no)
- perWorldPermissions - Sets permissions for the current world instead of setting them globally
- removePermissionSignIfMissing - If enabled, permission signs that have lost their physical sign will be removed during
startup. This prevents permission signs from staying in a broken state until the sign is replaced.
- enableIndirectSignProtection - Protects permission signs against indirect sources such as pistons and explosions. Only
disable this if your permission signs are protected by another plugin.
- enableExtensiveSignProtection - Whether to protect signs on "unstable" blocks such as sand or anvils. Does not protect
signs on "lag pyramids" or similar, but protects signs on top of, or attached to a pillar of sand.
| Node | Description |
| -------- | -------- |
| language | The language used for the plugin (en, nb-no) |
| perWorldPermissions | Sets permissions for the current world instead of setting them globally |
| removePermissionSignIfMissing | If enabled, permission signs that have lost their physical sign will be removed during startup. This prevents permission signs from staying in a broken state until the sign is replaced. |
| enableIndirectSignProtection | Protects permission signs against indirect sources such as pistons and explosions. Only disable this if your permission signs are protected by another plugin. |
| enableExtensiveSignProtection | Whether to protect signs on "unstable" blocks such as sand or anvils. Does not protect signs on "lag pyramids" or similar, but protects signs on top of, or attached to a pillar of sand. |
## Language customization