EasySign: Difference between revisions

From MC Public Wiki
Jump to navigation Jump to search
No edit summary
Line 16: Line 16:
An example would be: <code>/easy-sign warp 1 2 3</code>
An example would be: <code>/easy-sign warp 1 2 3</code>


== announce ==
Command: /easy-sign announce <id> <message>


Sets up an announcement sign. The message is broadcast (only once) when a player clicks the sign. The message supports colors with the same notation as <code>/signtext</code> and %s is replaced with the player's name. The id sets the "key" for the sign group, players can only announce once per group, but as many signs as you like can be in the group.
{| class="wikitable"
|+ Configuration Commands
! scope="col" text-align="center"| Name
! scope="col" text-align="center"| Command
! scope="col" text-align="center"| Usage
|-
| Delete || /easy-sign-delete || deletes the entire sign
|-
| Info || /easy-sign-info || Displays the info on a sign
|-
| Remove || /easy-sign-remove <action> || Removes the action # from the list of cmds on the sign
|-
| Reorder || /easy-sign-reorder <from> <to> || reorder the items
|-
|}


== cart ==
Command: /easy-sign cart [<world>] x y z


Spawns a minecart at the specified location.
{| class="wikitable"
 
|+ Sign Commands
== ci ==
! scope="col" | Name
Command: /easy-sign ci
! scope="col" style="width: 250px;"| Command
 
! scope="col" text-align="center"| Usage
Clears the player's inventory
|-  
 
| style="white-space: nowrap;" | Announce || /easy-sign announce <id> <message> || Announces in-game - the message is broadcast only once when the player clicks the sign. Supports /signtext colors and %s is replaced with the players name. The ID sets the 'key' for the sign gropup, players can only announce once per group
==check empty inventory==
|-
Command: /easy-sign check-empty-inventory [<message>]
| style="white-space: nowrap;" | Bed (Set) || /easy-sign setbed [<world>] x y z || Sets the players bed location at the specified position
 
|-
If the player's inventory is not empty, do not execute any subsequent sign actions and show <message>, if specified, or a default message.
| style="white-space: nowrap;" | Bed (Teleport) || /easy-sign tpbed || Teleports the player back to their bed
Default message: Your inventory must be completely empty to use this.
|-
 
| style="white-space: nowrap;" | Cart || /easy-sign cart [<world>] x y z || Spawns a minecart at the specified location
== clearpotions ==
|-
Command: /easy-sign clearpotions
| style="white-space: nowrap;" | Command || /easy-sign cmd <command> || runs the command as the user
 
|-
Clears all potion effects.
| style="white-space: nowrap;" | Give || /easy-sign give <item> <qty> [<slot>] || gives the player an item
 
|-
== cmd ==
| style="white-space: nowrap;" | Give Held || /easy-sign giveheld [<slot>] || gives the player a duplicate of your currently held item
Command: /easy-sign cmd <command>
|-
 
| style="white-space: nowrap;" | Give Max || /easy-sign givemax <id> <item> <qty> <max gives> [<slot>] || gives the player max # of an item
runs the command as the user
|-
 
| style="white-space: nowrap;" | Heal || /easy-sign heal [<gap>] || refills a players health. If ia gap is provided then the player gets half a heart every gap seconds. default is 0 = instant
== dropinventory ==
|-
Command: /easy-sign dropinventory [scatter] [<world>] <x> <y> <z>
| style="white-space: nowrap;" | Hunger || /easy-sign hunger || refills a players hunger bar
 
|-
Drops a copy of your current inventory at the specified coordinates. Specify 'scatter' as the first argument to give the dropped items random velocities.
| style="white-space: nowrap;" | Inventory (Check for Empty) || /easy-sign check-empty-inventory [<message>] || If the player's inventory is not empty, do not execute any subsequent sign actions and show <message>, if specified, or a default message. Default message: Your inventory must be completely empty to use this.
 
|-
== give ==
| style="white-space: nowrap;" | Inventory (Clear) || /easy-sign ci || clears the players inventory
Command: /easy-sign give <item> <qty> [<slot>]
|-
 
| style="white-space: nowrap;" | Inventory (Drop) || /easy-sign dropinventory [scatter] [<world>] x y z || Drops a copy of your current inventory at the specified coordinates. Specify 'scatter' as the first argument to give the dropped items random velocities
Gives the player a certain qty of an item. If slot is present, it is given directly to that slot number, which is useful for armor. Other items are simply added to the user's inventory directly. 100 is feet, 101 is legs, 102 is chest, and 103 is helmet. Item may use the item id, (like 1 for stone) or item id:value (like 35:11 for blue wool).
|-
 
| style="white-space: nowrap;" | Inventory (Give) || /easy-sign giveinventory || Gives the player the items in your inventory, filling the empty space
== giveheld ==
|-
Command: /easy-sign giveheld [<slot>]
| style="white-space: nowrap;" | Inventory (Replace) || /easy-sign inventory || Clears the players inventory and gives them an exact copy of your current inventory
 
|-
Gives the player a duplicate of your currently held item.
| style="white-space: nowrap;" | Launch || /easy-sign launch x y z || Launches the player with the specified velocity vector.
 
|-
== giveinventory ==
| style="white-space: nowrap;" | Leather || /easy-sign leather <red> <green> <blue> <item1> ... <itemN> || gives the player leather armor with the specificed red, green, and blue color components (0-255). <item1> to <itemN> are a list of items to give and can only be: helmet, chestplte, leggings, or boots
Command: /easy-sign giveinventory
|-
 
| style="white-space: nowrap;" | Lore || <nowiki>/easy-sign lore <item> <qty> <lore>||<itemmsg>||<qtymsg></nowiki> || Takes a specified qty of an item from a player if it has the required lore. Colors are ignored and lines are concatenated without spaces. The item must be in the players hand. If the wrong item is held <itemmsg> is shown. If it is the right item but insufficient qty <qtymsg> is shown. The <itemmsg> and <qtymsg> can be multiple words and color codes are allowed. The double bar seq <nowiki> || </nowiki> is used to separate those arguments. If the item is not taken for whatever reason, subsuquent sign actions are not processed. Caution: multiple consecutive spaces in any of these strings will be replaced with single spaces
Gives the player the items in your inventory, filling the empty space
|-
 
| style="white-space: nowrap;" | Max (uses) || /easy-sign max <id> <uses> || Allows the sign to be used <uses> items and no more. No other commands will run when limit is reached
== givemax ==
|-
Command: /easy-sign givemax <id> <item> <qty> <max gives> [<slot>]
| style="white-space: nowrap;" | Message || /easy-sign msg <message> || Sends the player a message. Color codes with & are supported
 
|-
Gives the player max # of an item
| style="white-space: nowrap;" | Potion || /easy-sign potion <id> <strength> <seconds> || applies a potion effect to the player. <ID> must be 1-23 <strenght> has a minimum level of 1 [http://minecraft.gamepedia.com/Status_effect These potion effects] can be used.
 
|-
== heal ==
| style="white-space: nowrap;" | Potion (clear) || /easy-sign clearpotions || Clears all potion effects
Command: /easy-sign heal [<gap>]
|-
 
| style="white-space: nowrap;" | Random Location || /easy-sign randloc <max_distance> || Randomly spawns the player max_distance away from 0,0
Refills a player's health. If gap is provided (it defaults to 0) then the player gets a half a heart every gap seconds. 0 means it fills up instantly.
|-
 
| style="white-space: nowrap;" | Sleep || /easy-sign sleep || resets spawn at the point of the sign
== hunger ==
|-
Command: /easy-sign hunger
| style="white-space: nowrap;" | Take || /easy-sign take <item> <qty> <failmsg> || takes an item from the player. If they dont have enough a failmsg is shown and no other commands are run
 
|-
Refills a players hunger bar
| style="white-space: nowrap;" | Warp || /easy-sign warp [<world>] x y z || sends player to coordinates listed, <world> is optional
 
|-
== inventory ==
|}
Command: /easy-sign inventory
 
Clears the player's inventory and gives them an exact copy of your current inventory.
 
== launch ==
Command: /easy-sign launch x y z
 
Launches a player with the specified velocity vector. The magnitude of the vector cannot exceed 10 (that is, sqrt(@x ** 2 + @y ** 2 + @z ** 2) must be < 10)
Example:
/easy-sign launch 0 10 0        -> will launch a player 10 blocks upwards.
/easy-sign launch 10 0 0    -> will launch you forward 10 blocks on the x axis
 
== leather ==
Command: /easy-sign leather <red> <green> <blue> <item1> .. <itemN>  
 
Gives the player leather armor with the specified red, green and blue color components (0 - 255). <item1> to <itemN> are a list of items to give and can only be: helmet, chestplate, leggings or boots.  There can be at most 4 of these item names.
 
== lore ==
Command: /easy-sign lore <item> <qty> <lore>||<itemmsg>||<qtymsg>
 
Takes a specified quantity of an item from a player if it has the required lore. Colors in the lore are ignored and multiple lines are concatenated without spaces.
 
The item must be in the player's hand. If the wrong item is held, <itemmsg> is shown. If it is the right item but insufficient in quantity, <qtymsg> is shown. The <itemmsg> and <qtymsg> can be multiple words and color codes are allowed. The double-bar sequence, '||', is used to separate those arguments.
 
If the item is not taken for whatever reason, subsequent sign actions are not processed. Caution: multiple consecutive spaces in any of these strings will be replaced with single spaces.
 
== max ==
Command: /easy-sign max <id> <uses>
 
Allows the sign to be used <uses> number of times and no more. No other commands will be run with the limit is reached.
 
== msg ==
Command: /easy-sign msg <message>
 
Sends the player a message. Color codes with & are supported.
 
== potion ==
Command: /easy-sign potion <id> <strength> <seconds>  
 
Applies a potion effect to the player. <ID> must be 1-23 <strength> has a minimum level of 1
 
== randloc ==
Command: /easy-sign randloc <max distance>
 
Randomly spawns the player <max distance> away from 0,0
 
== setbed ==
Command: /easy-sign setbed [<world>] x y z
 
Sets the players bed at the specified coordinates
 
== sleep ==
Command: /easy-sign sleep
 
A sleep sign sets the players bed at their current location.
 
== take ==
Command: /easy-sign take <item> <qty> <fail message>
 
Takes the given item from the player (at the specified quantity) and continues through the rest of the actions on the sign. If the player doesn't have the specified quantity of the item, none of the remaining actions will happen, and the fail message will be displayed, which supports color codes.
 
== tpbed ==
Command: /easy-sign tpbed
 
Teleports the player back to their bed
 
== warp ==
Command /easy-sign warp [<world>] x y z
 
A warp sign warps the user to the given x y z location in the current world, or another world if specified.  Default world names are world, world_nether and world_the_end.  Coordinates can include decimal points.

Revision as of 19:11, 1 January 2017

Easy Signs is a sign configuration plugin. All sign types follow the same rules:

  • Signs are "special" based on their location, not the text on the sign
  • If a sign is broken, it will be removed as an easy sign within a few minutes
  • Only admins can configure a sign
  • All players can activate the sign
  • To configure a sign, look at it, and run /easy-sign <type> [<args>] (the options are listed below)
  • Multiple actions can be added. They are run in the order they are added to the sign during configuration.
  • To activate a sign, left or right click it
  • To remove a sign, simply break it, or look at it and run /easy-sign-delete
  • To list all the actions on the sign, use /easy-sign-info. Each action will have a number in this list.
  • To remove an action from a sign, use /easy-sign-remove <number>
  • To move an action from one position to another in the order, use /easy-sign-reorder <from> <to>

Each "module" or sign type is configured differently, and the documentation is listed below. For the quick version of this guide, just run /easy-sign in game. An example would be: /easy-sign warp 1 2 3


Configuration Commands
Name Command Usage
Delete /easy-sign-delete deletes the entire sign
Info /easy-sign-info Displays the info on a sign
Remove /easy-sign-remove <action> Removes the action # from the list of cmds on the sign
Reorder /easy-sign-reorder <from> <to> reorder the items


Sign Commands
Name Command Usage
Announce /easy-sign announce <id> <message> Announces in-game - the message is broadcast only once when the player clicks the sign. Supports /signtext colors and %s is replaced with the players name. The ID sets the 'key' for the sign gropup, players can only announce once per group
Bed (Set) /easy-sign setbed [<world>] x y z Sets the players bed location at the specified position
Bed (Teleport) /easy-sign tpbed Teleports the player back to their bed
Cart /easy-sign cart [<world>] x y z Spawns a minecart at the specified location
Command /easy-sign cmd <command> runs the command as the user
Give /easy-sign give <item> <qty> [<slot>] gives the player an item
Give Held /easy-sign giveheld [<slot>] gives the player a duplicate of your currently held item
Give Max /easy-sign givemax <id> <item> <qty> <max gives> [<slot>] gives the player max # of an item
Heal /easy-sign heal [<gap>] refills a players health. If ia gap is provided then the player gets half a heart every gap seconds. default is 0 = instant
Hunger /easy-sign hunger refills a players hunger bar
Inventory (Check for Empty) /easy-sign check-empty-inventory [<message>] If the player's inventory is not empty, do not execute any subsequent sign actions and show <message>, if specified, or a default message. Default message: Your inventory must be completely empty to use this.
Inventory (Clear) /easy-sign ci clears the players inventory
Inventory (Drop) /easy-sign dropinventory [scatter] [<world>] x y z Drops a copy of your current inventory at the specified coordinates. Specify 'scatter' as the first argument to give the dropped items random velocities
Inventory (Give) /easy-sign giveinventory Gives the player the items in your inventory, filling the empty space
Inventory (Replace) /easy-sign inventory Clears the players inventory and gives them an exact copy of your current inventory
Launch /easy-sign launch x y z Launches the player with the specified velocity vector.
Leather /easy-sign leather <red> <green> <blue> <item1> ... <itemN> gives the player leather armor with the specificed red, green, and blue color components (0-255). <item1> to <itemN> are a list of items to give and can only be: helmet, chestplte, leggings, or boots
Lore /easy-sign lore <item> <qty> <lore>||<itemmsg>||<qtymsg> Takes a specified qty of an item from a player if it has the required lore. Colors are ignored and lines are concatenated without spaces. The item must be in the players hand. If the wrong item is held <itemmsg> is shown. If it is the right item but insufficient qty <qtymsg> is shown. The <itemmsg> and <qtymsg> can be multiple words and color codes are allowed. The double bar seq || is used to separate those arguments. If the item is not taken for whatever reason, subsuquent sign actions are not processed. Caution: multiple consecutive spaces in any of these strings will be replaced with single spaces
Max (uses) /easy-sign max <id> <uses> Allows the sign to be used <uses> items and no more. No other commands will run when limit is reached
Message /easy-sign msg <message> Sends the player a message. Color codes with & are supported
Potion /easy-sign potion <id> <strength> <seconds> applies a potion effect to the player. <ID> must be 1-23 <strenght> has a minimum level of 1 These potion effects can be used.
Potion (clear) /easy-sign clearpotions Clears all potion effects
Random Location /easy-sign randloc <max_distance> Randomly spawns the player max_distance away from 0,0
Sleep /easy-sign sleep resets spawn at the point of the sign
Take /easy-sign take <item> <qty> <failmsg> takes an item from the player. If they dont have enough a failmsg is shown and no other commands are run
Warp /easy-sign warp [<world>] x y z sends player to coordinates listed, <world> is optional