Configuration Help

Configuration Files

config.yml

Expand for information

##########################
#    TradeShop Config    #
##########################
config-version: 1.2


# |    System Options    |
# ^^^^^^^^^^^^^^^^^^^^^^^^
system-options:
  # How would you like your servers data stored? (FLATFILE)
  data-storage-type: FLATFILE
  # What debug code should be run. This will add significant amounts of spam to the console/log, generally not used unless requested by Devs
  enable-debug: 0
  # Should we check for updates when the server starts
  check-updates: true
  # Allow us to connect anonymous metrics so we can see how our plugin is being used to better develop it
  allow-metrics: true
  # We do not recommend enabling this setting since any editing an admin should need to do can be done without this.
  # Should players with Admin permission be able to use any commands on any shops?
  unlimited-admin: false
  # Should our internal permission system be used? (Only enable if you aren't using a permission plugin)
  use-internal-permissions: false


# |    Language Options    |
# ^^^^^^^^^^^^^^^^^^^^^^^^^^
language-options:
  # The prefix the displays before all plugin messages
  message-prefix: '&a[&eTradeShop&a] '


  # Header Colours, if the codes are showing in the header, set to ""
  # Color for successfully created and stocked signs
  shop-good-colour: '&2'
  # Color for shops that are missing data to make trades
  shop-incomplete-colour: '&7'
  # Color for shops that were not successfully created
  shop-bad-colour: '&4'


  # Status Text, What will be shown in the bottom line of shop sign for each status
  # Open
  shop-open-status: '&a<Open>'
  # Closed
  shop-closed-status: '&c<Closed>'
  # Incomplete
  shop-incomplete-status: '&c<Incomplete>'
  # Out of Stock
  shop-outofstock-status: '&c<Out Of Stock>'


# |    Global Options    |
# ^^^^^^^^^^^^^^^^^^^^^^^^
global-options:
  # Directions an allowed shop can be from a sign. Allowed directions are:
  # Up, Down, North, East, South, West
  allowed-directions: [ DOWN, WEST, SOUTH, EAST, NORTH, UP ]
  # Inventories to allow for shops. Allowed blocks are:
  # Chest, Trapped_Chest, Dropper, Hopper, Dispenser, Shulker, ...
  allowed-shops: [ CHEST, TRAPPED_CHEST, SHULKER ]
  # Max distance a player can be from a shop to edit it
  max-edit-distance: 4
  # Can players toggle view of involved shops?
  allow-toggle-status: true
  # Should we allow anyone to destroy a shops sign?
  allow-sign-break: false
  # Should we allow anyone to destroy a shops storage?
  allow-chest-break: false


  multi-trade:
    # Should we allow multi trades with shift + click (true/false)
    enable: true
    # Default multiplier for trades using shift + click
    default-multi: 2
    # Maximum amount a player can set their multiplier to. Not recommended to set any higher than 6 as this can cause bugs with iTrade Shops
    max-multi: 6


# |    Shop Options    |
# ^^^^^^^^^^^^^^^^^^^^^^
shop-options:
  # Maximum users(Managers/Members) a shop can have
  max-shop-users: 5
  # Maximum shops that can exist in a single chunk
  max-shops-per-chunk: 128
  # Maximum amount of item stacks per side of trade
  max-items-per-trade-side: 6
  # Can players purchase from a shop in which they are a user of (true/false)
  allow-user-purchasing: false
  # Text that shows on trade signs that contain more than 1 item
  # Available variables are: %AMOUNT%
  multiple-items-on-sign: Use '/ts what'


# |    Trade Shop Options    |
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
trade-shop-options:
  # The header that appears at the top of the shop signs, this is also what the player types to create the sign
  header: Trade
  # Can explosions damage the shop sign/storage (true/false)
  allow-explode: false
  # Can hoppers pull items from the shop storage (true/false)
  allow-hopper-export: false
  # Can hoppers push items into the shop storage (true/false)
  allow-hopper-import: false


# |    ITrade Shop Options    |
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
itrade-shop-options:
  # Name to put on the bottom of iTrade signs
  owner: Server Shop
  # The header that appears at the top of the shop signs, this is also what the player types to create the sign
  header: iTrade
  # Can explosions damage the shop sign (true/false)
  allow-explode: false
  # What text should be used for successful trades when no cost is present
  no-cost-text: nothing


# |    BiTrade Shop Options    |
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
bitrade-shop-options:
  # The header that appears at the top of the shop signs, this is also what the player types to create the sign
  header: BiTrade
  # Can explosions damage the shop sign/storage (true/false)
  allow-explode: false
  # Can hoppers pull items from the shop storage (true/false)
  allow-hopper-export: false
  # Can hoppers push items into the shop storage (true/false)
  allow-hopper-import: false


# |    Illegal Item Options    |
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
illegal-item-options:
  # Valid Types: DISABLED, BLACKLIST, WHITELIST

  # List for illegal items for both Cost and Product
  global-illegal-items:
    type: BLACKLIST
    list: [ Bedrock, Command_Block, Barrier ]
  # List for illegal items for only Cost items
  cost-illegal-items:
    type: DISABLED
    list: [ ]
  # List for illegal items for only Product items
  product-illegal-items:
    type: DISABLED
    list: [ ]

messages.yml

Expand for information

############################
#    TradeShop Messages    #
############################
# Version of the current config file.
# Do not change!
message-version: 1.2
# This currently does not change anything in the message files, but is used in metrics so that we can see what languages we should try to provide built in support for in the future.
# Please use codes as listed at: https://www.andiamo.co.uk/resources/iso-language-codes/
language: en-us


change-closed: '&cThe shop is now &l&bCLOSED&r&a.'
change-open: '&aThe shop is now &l&bOPEN&r&a.'
# Text to display when a player places a TradeSign above an empty chest:
empty-ts-on-setup: '&cTradeShop empty, please remember to fill it!'
existing-shop: '&cThis storage or sign is already linked to a shop.'
feature-disabled: '&cThis feature has been disabled on this server!'
# Text to display when the player is not holding anything
held-empty: '&eYou are currently holding nothing.'
# Text to display when a shop failed creation due to an illegal item
illegal-item: '&cYou cannot use one or more of those items in shops.'
# Text to display when a shop failed creation due to using a shulker box as cost when the shop uses it for storage:
no-shulker-cost: '&cYou cannot add a Shulker Box as a cost when the shop uses it for storage.'
# Text to display when the player does not have enough items:
insufficient-items: '&cYou do not have &e%AMOUNT% %ITEM%&c!'
# Text to display when the shop does not have enough items:
shop-insufficient-items: '&cThis shop does not have enough &e%AMOUNT% %ITEM%&c to trade!'
# Text to display when invalid arguments are submitted through the "/tradeshop" command:
invalid-arguments: '&eTry &6/tradeshop help &eto display help!'
item-added: '&aItem successfully added to shop.'
item-not-removed: '&cItem could not be removed from shop.'
item-removed: '&aItem successfully removed to shop.'
missing-chest: '&cYour shop is missing a chest.'
# Text to display when a shop sign failed creation due to missing an item
missing-item: '&cYour sign is missing an item for trade.'
multi-amount: '&aYour trade multiplier is %AMOUNT%.'
multi-update: '&aTrade multiplier has been updated to %AMOUNT%.'
# Text to display when a player attempts to place a sign without placing the chest first:
no-chest: '&cYou need to put a chest under the sign!'
# Text to display when a player attempts to run administrator commands:
no-command-permission: '&cYou do not have permission to execute this command'
no-shop-permission: '&cYou do not have permission to edit that shop.'
# Text to display when a player attempts to trade while having the `Prevent Trade` permission:
no-trade-permission: '&cYou do not have permission to trade with TradeShops'
# Text to display when a player is too far from a shop
no-sighted-shop: '&cNo shop in range!'
# Text to display when a player attempts to setup a shoptype they are not allowed to create:
no-ts-create-permission: '&cYou don''t have permission to create TradeShops!'
# Text to display when a player attempts to destroy a shop they do not own:
no-ts-destroy: '&cYou may not destroy that TradeShop'
# Text to display when a player attempts to destroy a block with a shop sign attached to it:
destroy-shop-sign-first: '&cYou must destroy the shops sign first.'
# Text to display when a player attempts to open a shop they do not own nor have been granted access to:
no-ts-open: '&cThat TradeShop does not belong to you'
# Text to display upon a successful trade:
on-trade: '&aYou have traded your &e%AMOUNT2% %ITEM2% &afor &e%AMOUNT1% %ITEM1% &awith %SELLER%'
# Text to display when the players inventory is too full to recieve the trade:
player-full: '&cYour inventory is full, please make room before trading items!'
player-not-found: '&cThat player could not be found.'
# Text to display when console tries to use a player only command
player-only-command: '&eThis command is only available to players.'
plugin-behind: '&cThe server is running an old version of TradeShop, please update the plugin.'
# Text to display when a player tries to buy form a shop in which they are a user
self-owned: '&cYou cannot buy from a shop in which you are a user.'
# Text to display on "/tradeshop setup":
setup-help: "\n&2Setting up a TradeShop is easy! Just make sure to follow these steps:\n \nStep\
  \ 1: &ePlace down a chest.\n&2Step 2: &ePlace a sign on top of or around the chest.\n\
  &2Step 3: &eWrite the following on the sign\n&6 [%HEADER%]\n&6&o-- Leave Blank --\n\
  &6&o-- Leave Blank --\n&6&o-- Leave Blank --\n&2Step 4: &eUse the addCost and addProduct\
  \ commands to add items to your shop"
shop-closed: '&cThis shop is currently closed.'
# Text to display when the shop does not have enough stock:
shop-empty: '&cThis TradeShop is currently missing items to complete the trade!'
# Text to display when the shop storage is full:
shop-full: '&cThis TradeShop is full, please contact the owner to get it emptied!'
shop-item-list: |-
  &aThe shops %TYPE%:
  %LIST%
# Text to display when a player uses '/ts toggle'
# Available variables are: %TYPE% %NEWTYPE%
shop-type-switched: '&aShop type has been switched to %NEWTYPE%.'
# Text to display when a player successfully creates a TradeShop:
successful-setup: '&aYou have successfully setup a TradeShop!'
too-many-chests: '&cThere are too many shops in this chunk, you can not add another one.'
too-many-items: '&cThis shop cannot take any more %SIDE% items!'
# Text to display when shop users could not be updated
unsuccessful-shop-members: '&aThat player is either already on the shop, or you have reached the maximum number
  of users!'
# Text to display when shop users have been updated successfully
updated-shop-members: '&aShop owners and members have been updated!'
# Text to display when players use the who command
who-message: |-
  &6Shop users are:
  &2Owner: &e%OWNER%
  &2Managers: &e%MANAGERS%
  &2Members: &e%MEMBERS%
# Text to display when viewing a players level with /ts PlayerLevel
view-player-level: '&e%PLAYER% has a level of %LEVEL%.'
# Text to display after setting a players level
set-player-level: '&aYou have set the level of %PLAYER% to %LEVEL%!'
# Text to display when a message uses an Item Type and the Type varies
various-item-type: Various
toggled-status: 'Toggled status: &c%STATUS%'
# Text to display when a player is too far from a sign
no-sign-found: '&cNo sign in range!'
# Text to display when an admin toggles or views their Admin abilities.
# "%STATE%" will be replaced by the state that the player is in after the command.
admin-toggled: '&aYour Admin mode is currently &e%STATE%&a.'