|
|
| (3 intermediate revisions by the same user not shown) |
| Line 6: |
Line 6: |
| | rootcommand = shop | | | rootcommand = shop |
| | custom = Yes (Fork) | | | custom = Yes (Fork) |
| | subcommands = 21 | | | subcommands = 17 |
| | article1 = Survival/Spawn/Shopping_District | | | article1 = Survival/Spawn/Shopping_District |
| }} | | }} |
| Line 55: |
Line 55: |
|
| |
|
| == Commands == | | == Commands == |
| | {{Hatnote|{{Icon|notice}}<nowiki>[Square brackets]</nowiki> indicate optional parameters, while <nowiki><angle brackets></nowiki> indicate required parameters.}} |
| | |
| <tabber> | | <tabber> |
| |-| Shop management = | | |-| Shop management = |
| {{Hatnote|{{Icon|notice}}<nowiki>[Square brackets]</nowiki> indicate optional parameters, while <nowiki><angle brackets></nowiki> indicate required parameters.}}
| |
|
| |
| {{Navplate | | {{Navplate |
| |title = Create shop | | | title = Create shop |
| |label1 = /shop create <price> | | | label1 = /shop create <price> |
| |list1 = Create a shop at the block you're looking at. You must be holding the item you wish to sell in your hand (including the quantity of items to sell per transaction. Price must be an integer between 1 and 25,000. Shops must be [[Plugin:Bolt|locked]] to prevent players from stealing inventory. | | | list1 = Create a shop at the block you're looking at. You must be holding the item you wish to sell in your hand (including the quantity of items to sell per transaction. Price must be an integer between 1 and 25,000. Shops must be [[Plugin:Bolt|locked]] to prevent players from stealing inventory. |
| |label2 = Valid blocks | | | label2 = Valid blocks |
| |list2 = | | | list2 = {{Component |
| {{Component | |
| |port = {{Item|barrel}} | | |port = {{Item|barrel}} |
| |title = '''Barrel''' | | |title = '''Barrel''' |
| Line 79: |
Line 78: |
| |title = '''Shulker Boxes''' | | |title = '''Shulker Boxes''' |
| |subtitle = Any Shulker Box color. | | |subtitle = Any Shulker Box color. |
| }}
| |
| {{Navplate
| |
| |title = Remove shop
| |
| |label1 = /shop remove
| |
| |list1 = Remove the shop you're looking at.
| |
| }} | | }} |
| }} | | }} |
| {{Navplate | | {{Navplate |
| |title = Manage beneficiaries | | | title = Remove shop |
| |label1 = /shop benefit <nowiki><add|remove|query></nowiki> <player> <percentage> | | | label1 = /shop remove |
| |list1 = Add a player to a shop as a beneficiary and split a percentage of your earnings with them. | | | list1 = Remove the shop you're looking at. |
| }} | | }} |
| {{Navplate | | {{Navplate |
| |title = Change mode | | | title = Change mode |
| |label1 = /shop <nowiki><buy|sell></nowiki> | | | label1 = /shop <nowiki><buy|sell></nowiki> |
| |list1 = Change a shop to either sell items to players or buy items from players. | | | list1 = Change a shop to either sell items to players or buy items from players. |
| |label2 = Modes | | | label2 = Modes |
| |list2 = | | | list2 = {{Component |
| {{Component | |
| |port = {{Item|lantern}} | | |port = {{Item|lantern}} |
| |title = '''Sell''' | | |title = '''Sell''' |
| Line 109: |
Line 102: |
| }} | | }} |
| {{Navplate | | {{Navplate |
| |title = View notifications | | | title = Item quantity |
| |label1 = /shop fetchmessage | | | label1 = /shop size [name] |
| |list1 = View unread shop transaction notifications. | | | list1 = Change how many items are sold in bulk per transaction. Not to be confused with {{CMD|shop amount}}, which is used to purchase a specified number of items from a shop. |
| | }} |
| | {{Navplate |
| | | title = Change item |
| | | label1 = /shop item |
| | | list1 = Change the item being traded at a shop to the item in your hand. All other shop parameters will remain the same. |
| }} | | }} |
| {{Navplate | | {{Navplate |
| |title = Toggle searchable | | | title = Modify price |
| |label1 = {{#inline-tooltip:/shop finditem <nowiki><hideshop|revealshop></nowiki> <item name>|/finditem or /searchshop}} | | | label1 = /shop price <price> |
| |list1 = Hide or show your shop in the global search. All active shops are included in the search by default. | | | list1 = Change the price at which items are traded for the shop you're looking at. |
| }} | | }} |
| {{Navplate | | {{Navplate |
| |title = Change item | | | title = Suggest price |
| |label1 = /shop item | | | label1 = /shop suggestprice |
| |list1 = Change the item being traded at a shop to the item in your hand. All other shop parameters will remain the same. | | | list1 = Allow the plugin to determine a recommended price for your shop by calculating a median and average of all other shops selling similar items. This command will not change the price of your shop: it will only recommend a price. Use {{CMD|shop price <price>}} to change the shop price. |
| }} | | }} |
| {{Navplate | | {{Navplate |
| |title = Set permissions | | | title = Set permissions |
| |label1 = /shop permission user <nowiki><set|unset></nowiki> <player> <permission> | | | label1 = /shop permission user <nowiki><set|unset></nowiki> <player> <permission> |
| |list1 = Change permissions for a player at the shop you're looking at. Note that access to the physical shop inventory is managed by [[Plugin:Bolt|Bolt]] and [[Plugin:GriefDefender|Claims]]. | | | list1 = Change permissions for a player at the shop you're looking at. Note that access to the physical shop inventory is managed by [[Plugin:Bolt|Bolt]] and [[Plugin:GriefDefender|Claims]]. |
| |label2 = Permissions | | | label2 = Permissions |
| |list2 = | | | list2 = {{Component |
| {{Component | |
| |port = {{Item|red_candle}} | | |port = {{Item|red_candle}} |
| |title = '''Administrator''' | | |title = '''Administrator''' |
| Line 137: |
Line 134: |
| |port = {{Item|yellow_candle}} | | |port = {{Item|yellow_candle}} |
| |title = '''Staff''' | | |title = '''Staff''' |
| |subtitle = Players with {{Copy|quickshop-hikari.staff}} will be able to control most aspects of a shop (such as shop price, item quantities, and sell mode), but will be unable to modify permissions for others. | | |subtitle = Players with {{Copy|quickshop-hikari.staff}} will be able to control most aspects of a shop (such as shop price, item quantities, and sell mode), but will be unable to modify permissions for others. Same as running {{CMD|shop staff add <name>}} and related commands. |
| }} | | }} |
| {{Component | | {{Component |
| |port = {{Item|cyan_candle}} | | |port = {{Item|lime_candle}} |
| |title = '''Everyone''' | | |title = '''Everyone''' |
| |subtitle = Players with {{Copy|quickshop-hikari.everyone}} will be able to trade with the shop, but do nothing else. This is the default access level for all players at your shop; It is unnecessary to set this permission for users. | | |subtitle = Players with {{Copy|quickshop-hikari.everyone}} will be able to trade with the shop, but do nothing else. This is the default access level for all players at your shop; It is unnecessary to set this permission for users. |
| Line 151: |
Line 148: |
| }} | | }} |
| {{Navplate | | {{Navplate |
| |title = Modify price | | | title = Manage beneficiaries |
| |label1 = /shop price <price> | | | label1 = /shop benefit <nowiki><add|remove|query></nowiki> <player> <percentage> |
| |list1 = Change the price at which items are traded for the shop you're looking at. | | | list1 = Add a player to a shop as a beneficiary and split a percentage of your earnings with them. |
| }} | | }} |
| {{Navplate | | {{Navplate |
| |title = Change sign | | | title = Transfer shop(s) |
| |label1 = /shop sign <material> | | | label1 = /shop transferownership <name> |
| |list1 = Change the wood-type used by the sign for the shop you're looking at. Defaults to spruce sign. | | | list1 = Transfer ownership of the shop you're looking at to the specified player. The other player must run {{CMD|shop transferownership accept}} to complete the transfer. Once complete, you will no longer have authority over the shop. '''This action cannot be undone.''' |
| | | label2 = /shop transferall <name> |
| | | list2 = Transfer ownership of ''all'' your shops specified player. The other player must run {{CMD|shop transferall accept}} to complete the transfer. Once complete, you will no longer have authority over any of your shops. '''This action cannot be undone.''' |
| }} | | }} |
| {{Navplate | | {{Navplate |
| |title = Shop name | | | title = Change sign |
| |label1 = /shop name [name] | | | label1 = /shop sign <material> |
| |list1 = Change the name of a shop you are looking at. This name is not shown to players and is instead only useful for self-organization. When a named shop runs out of inventory, you will be informed specifically of which shop has run out. Leave the name parameter blank to unset a name. | | | list1 = Change the wood-type used by the sign for the shop you're looking at. Defaults to spruce sign. |
| | }} |
| | {{Navplate |
| | | title = Toggle display |
| | | label1 = /shop toggledisplay |
| | | list1 = Toggle on or off the floating item above shops. By default, this display is shown. If you wish to stack your shops vertically, setting this to off is recommended to improve performance. |
| | }} |
| | {{Navplate |
| | | title = Toggle searchable |
| | | label1 = {{#inline-tooltip:/shop finditem <nowiki><hideshop|revealshop></nowiki> <item name>|/finditem or /searchshop}} |
| | | list1 = Hide or show your shop in the global search. All active shops are included in the search by default. |
| | }} |
| | {{Navplate |
| | | title = View notifications |
| | | label1 = /shop fetchmessage |
| | | list1 = View unread shop transaction notifications. |
| | }} |
| | {{Navplate |
| | | title = Shop name |
| | | label1 = /shop name [name] |
| | | list1 = Change the name of a shop you are looking at. This name is not shown to players and is instead only useful for self-organization. When a named shop runs out of inventory, you will be informed specifically of which shop has run out. Leave the name parameter blank to unset a name. |
| }} | | }} |
|
| |
| |-| Player interaction = | | |-| Player interaction = |
| {{Navplate | | {{Navplate |
| |title = Search shops | | | title = Search shops |
| |label1 = {{#inline-tooltip:/shop finditem <nowiki><buy|sell></nowiki> <item name>|/finditem or /searchshop}} | | | label1 = {{#inline-tooltip:/shop finditem <nowiki><buy|sell></nowiki> <item name>|/finditem or /searchshop}} |
| |list1 = Search all active shops on the server trading the specified item. Buy and sell in this context refer to the action you as the shopper will be performing at a given shop. Shops are automatically sorted by price. Clicking on a shop will teleport you to that shop. | | | list1 = Search all active shops on the server trading the specified item. Buy and sell in this context refer to the action you as the shopper will be performing at a given shop. Shops are automatically sorted by price. Clicking on a shop will teleport you to that shop. |
| }} | | }} |
| {{Navplate | | {{Navplate |
| |title = Trade amount | | | title = Trade amount |
| |label1 = /shop amount <number> | | | label1 = /shop amount <number> |
| |list1 = The number of items you wish to trade at a specific shop. This is to be used when you initiate a trade with a shop as an alternative to typing the number into chat. This command is ''not'' used to set the number of items to be traded per transaction as a shop owner. | | | list1 = The number of items you wish to trade at a specific shop. This is to be used when you initiate a trade with a shop as an alternative to typing the number into chat. This command is ''not'' used to set the number of items to be traded per transaction as a shop owner. ({{CMD|shop size}}) |
| }} | | }} |
|
| |
| </tabber> | | </tabber> |
| {{Hatnote|{{Icon|code}} Some commands shown in the in-game help menu are disabled on {{SITENAME}} and thus are not included on this page.}} | | {{Hatnote|{{Icon|code}} Some commands shown in the in-game help menu are disabled on {{SITENAME}} and thus are not included on this page.}} |
|
| |
|
| == Examples ==
| | == Notes== |
| | | *Be mindful of the text shown on shop signs. The text on the sign indicates the action ''the player'' is performing by interacting with the shop. |
| | | **This behavior is opposite to shop administrative commands that are from the perspective of the shop itself. For instance, a shop in "sell" mode (selling items to the player) would display "buy" on the shop sign since that is the action players are performing at that shop. |
| == Notes == | | *Shops are not protected by the plugin. Instead, players must use [[Plugin:Bolt|Bolt]] or [[Plugin:GriefDefender|Claims]] to lock their shop containers from theft. |
| * Be mindful of the text shown on shop signs. The text on the sign indicates the action ''the player'' is performing by interacting with the shop. | | **This is true even for shops created in the [[Survival/Spawn/Shopping_District|Shopping District]]. |
| ** This behavior is opposite to shop administrative commands that are from the perspective of the shop itself. For instance, a shop in "sell" mode (selling items to the player) would display "buy" on the shop sign since that is the action players are performing at that shop. | | *A single shop cannot both sell and buy items. However, a double-chest can host two shops that both sell and purchase items from players in order to accomplish this. |
| * Shops are not protected by the plugin. Instead, players must use [[Plugin:Bolt|Bolt]] or [[Plugin:GriefDefender|Claims]] to lock their shop containers from theft. | | *Players can create shops out of barrels, chests, trapped chests, or any shulker box variant. |
| ** Shops created in the [[Survival/Spawn/Shopping_District|Shopping District]] are automatically protected. | | **Barrels are preferred. |
| * A single shop cannot both sell and buy items. However, a double-chest can host two shops that both sell and purchase items from players in order to accomplish this. | |
| * Players can create shops out of barrels, chests, trapped chests, or any shulker box variant. | |
| ** Barrels are preferred. | |
|
| |
|
| == Gallery == | | ==Gallery== |
| <gallery mode="packed-hover" widths="130" heights="130"> | | <gallery mode="packed-hover" widths="130" heights="130"> |
| File:Doublechestshop.png|An example of a shop that sells and buys items | | File:Doublechestshop.png|An example of a shop that sells and buys items |
