diff --git a/Create-command.md b/Create-command.md new file mode 100644 index 0000000..12290aa --- /dev/null +++ b/Create-command.md @@ -0,0 +1,18 @@ +The create command is the main command of this plugin. It's the only command that's necessary for creating permission signs. + +Syntax: `/ps create [cost] [duration]` +Fields: +* Name: The name to be displayed on the sign. It should describe what players expect to receive when interacting with the sign. +* Permission: One permission node or a comma-separated list of permission nodes. See the permission section for more details +* Cost: The amount of currency a player has to pay to use the permission sign. 0 = free. +* Duration: The amount of seconds the player should keep the permission for. 0 = permanently, which is default. + +#### Permission + +As the permission field has some special behavior, this section goes more in-depth. + +The simplest way of using the permision 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` \ No newline at end of file