From 9646bd0318220d9fc8051faeb6843b8f38b8fec5 Mon Sep 17 00:00:00 2001 From: Eric Date: Mon, 3 Jun 2019 16:28:58 +0200 Subject: [PATCH] Update config descriptions --- src/main/resources/config.yml | 169 +++++++++++----------------------- 1 file changed, 55 insertions(+), 114 deletions(-) diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml index 1de2a03..ffa2d7a 100644 --- a/src/main/resources/config.yml +++ b/src/main/resources/config.yml @@ -3,36 +3,32 @@ # =============================================== # # Lines starting with '#' are comments and are ignored by the server. +# +# You can find item names in the 'item_names.txt' file. -# Set the main command you have to enter to manage the shops +# Set the main command you have to enter to manage the shops. # (default: "/shop ...") main-command-name: "shop" -# Set the language of the item-, enchantment-, potion- and arrow-effect names +# Set the language file for all translatable messages or names. # The value must equal to the name of one of a file in the 'lang' folder -# (without the '.lang' extension) +# (without the '.lang' extension). language-file: "en_US" # Set the item with which a player can click a shop to retrieve information. -# You can set this to an empty string to disable this feature. +# You can set this to an empty string ("") to disable this feature. shop-info-item: "STICK" # Set whether buys or sells need to be confirmed by the player -# in order to prevent accidental purchases or sells. +# in order to prevent accidens. confirm-shopping: false # Set whether players should be able to select the shop item from the # creative inventory if they don't hold an item in their hand. creative-select-item: true -# Set whether the shop creation price should be refunded -# when the shop is removed. -# This only applies when the creator of the shop removes it himself -# by command or by breaking it. -# No refund will be given for automatic shop removals or when -# the shop is removed by another player. -# If enabled, the currently set creation price will be refunded, -# not the one that was paid at creation. +# Set whether the (current) shop creation price should be refunded +# when the shop is removed by its creator. refund-shop-creation: false # Set whether the plugin will check for updates on server start @@ -44,56 +40,32 @@ enable-update-checker: true # Set whether buys and sells should be logged in the database. enable-economy-log: false -# Sets the time limit for cleaning up the economy log in days. +# Set the maximum age for economy log entries in days. # All log entries older than this will be deleted on server start. -# Set this to 0 in order to disable this feature. +# Set this to 0 to disable this feature. cleanup-economy-log-days: 30 # Set whether a debug log file should be created. -# The file may get large! Please enable this setting when reporting bugs. +# The file may get large! Please enable this setting when reporting issues. enable-debug-log: false -# Set whether WorldGuard integration should be enabled -# Of course, this only works if WorldGuard is installed +# Set whether various protection plugins should be hooked into (if installed) +# in order to allow or deny shop creation in certain locations. enable-worldguard-integration: true - -# Set whether Towny integration should be enabled -# Of course, this only works if Towny is installed enable-towny-integration: true - -# Set whether AuthMe integration should be enabled -# Of course, this only works if AuthMe is installed enable-authme-integration: true - -# Set whether PlotSquared integration should be enabled -# Of course, this only works if PlotSquared is installed enable-plotsquared-integration: true - -# Set whether uSkyBlock integration should be enabled -# Of course, this only works if uSkyBlock is installed enable-uskyblock-integration: true - -# Set whether ASkyBlock integration should be enabled -# Of course, this only works if ASkyBlock is installed enable-askyblock-integration: true - -# Set whether IslandWorld integration should be enabled -# Of course, this only works if IslandWorld is installed enable-islandworld-integration: true - -# Set whether GriefPrevention integration should be enabled -# Of course, this only works if GriefPrevention is installed enable-griefprevention-integration: true - -# Set whether AreaShop integration should be enabled -# Of course, this only works if AreaShop and WorldGuard is installed enable-areashop-integration: true -# Set whether the vendor of a shop should get messages when players -# buy or sell something from/to his shop or if his shop is out of stock +# Set whether the vendor of a shop should get messages when players buy +# or sell something from/to his shop or when his shop is out of stock. enable-vendor-messages: true -# Set whether only the shops a player has in sight should be shown to him. +# Set whether only the shop a player is pointing at should be shown. # If set to false, every shop near the player (with the specified # distance) will be shown to him. only-show-shops-in-sight: true @@ -108,38 +80,28 @@ hologram-fixed-bottom: true # height of one line. hologram-lift: 0 -# Set whether players should be allowed to sell their items, even if the -# amount they have, is lower than the amount, the shop owner has set for the -# given price, or if the inventory of the chest doesn't have enough space -# for all the items, but only for a few, or if the player only has enough -# money for a few items, but not for the amount, the shop owner has set. -# When set to true, players may also buy items from a shop, even if the -# amount of items in the chest is lower than the amount, the shop owner has -# set for the given price, or if they don't have enough space in the -# inventory for all of the items, but only for a few, or if the shop owner -# doesn't have enough money to buy all of the items, the player wants to -# sell. The price will be calculated correspondingly. -# (If it's not clear enough, please let me know) +# Set whether players should be allowed to buy or sell less items +# than the vendor has specified, in case the player does not have enough +# money or items, or if the chest does not have enough items or space, +# or if the vendor does not have enough money. +# The price will be calculated correspondingly. auto-calculate-item-amount: false -# Set whether prices may contain decimals (prices of existing shops will stay) +# Set whether prices may contain decimals (prices of existing shops will stay). allow-decimals-in-price: true -# Set whether players should be allowed to sell/buy broken items +# Set whether players should be allowed to sell/buy broken items. allow-broken-items: false # Set whether the level of a potion or tipped arrow (if upgraded) should be # appended to the item name. If set to true, the level ("II") will be -# displayed after the item name, but only if the item does NOT have a -# custom name. If set to false, it will only be shown in the -# shop info message. +# displayed after the item name, but only if the item does not have a +# custom name. append-potion-level-to-item-name: false # Set whether shops should automatically be removed from the database if -# an error occurred while loading e.g. when no chest is found at a -# shop's location. -# This might be useful if you're removing shop chests with WorldEdit, -# resetting plots, or similar +# an error occurred while loading. +# (e.g. no chest, no space above chest, or unknown world) remove-shop-on-error: false # Set whether the mouse buttons should be inverted. @@ -156,9 +118,22 @@ maximal-distance: 2 # player can see the floating shop item. maximal-item-distance: 40 +# Set whether the buy price must be greater than or equal to the sell price. +buy-greater-or-equal-sell: true + +# Set the minimum and maximum prices for each individual item. +minimum-prices: +# "DIAMOND": 0.5 + +maximum-prices: +# "STONE": 2 + +# Set the items of which a player can't create a shop. +blacklist: +# - "DIORITE" + # Set the price a player has to pay in order to create... # You can set this to 0 to disable costs. -# Value MUST be a number (e.g. 1, 1.5, 2.75, ...) shop-creation-price: # ...a normal shop @@ -167,35 +142,19 @@ shop-creation-price: # ...an admin shop admin: 0 -# Set whether the buy price must be greater than or equal sell price. -buy-greater-or-equal-sell: true +# Shop limits are handled with permissions. +# A player with permission "shopchest.limit.X" has a limit of X shops, +# a player with permission "shopchest.limit.*" does not have a shop limit. +# Admin shops are excluded from the shop limit. +shop-limits: -# Set the minimum prices for each individual Item. Not per Stack, per single Item! -# To add an item, follow the format below. -# Important: You must have exactly 2 leading spaces in each line -# You can find the item names in the 'item_names.txt' file. -minimum-prices: -# "STONE:1": 0.5 -# "DIAMOND_SWORD": 100 - -# Set the maximum prices for each individual Item. Not per Stack, per single Item! -# To add an item, follow the format below. -# Important: You must have exactly 2 leading spaces in each line -# You can find the item names in the 'item_names.txt' file. -maximum-prices: -# "STONE:1": 19.9 -# "DIAMOND_SWORD": 1000 - -# Set the items of which a player can't create a shop. -# To add an item, follow the format below. -# Important: You must have exactly 2 leading spaces in each line -# You can find the item names in the 'item_names.txt' file. -blacklist: -# - "STONE:1" -# - "DIAMOND_BLOCK" + # Set the amount of shops that anyone who doesn't have a + # specific permission may have. + # If you don't want the players to have a limit by default + # set the value to -1. + default: 5 # Set the events of AreaShop when shops on that region should be removed. -# Important: You must have exactly 2 leading spaces in each line # Valid values are: DELETE, UNRENT, RESELL, SELL areashop-remove-shops: - "DELETE" @@ -203,18 +162,14 @@ areashop-remove-shops: - "RESELL" - "SELL" -# Set whether the custom WorldGuard flags should be allowed by default -# (true = Allowed by default, false = Denied by default) -# This can, of course, be overridden in specific regions and is only -# enabled if WorldGuard is installed and WorldGuard integration is enabled +# Set whether the custom WorldGuard flags should be allowed by default. worldguard-default-flag-values: create-shop: false use-shop: false use-admin-shop: false -# Set the types of Towny plots where shop creation should be allowed for... -# Important: You must have exactly 4 leading spaces in each line +# Set the types of Towny plots where shop creation should be allowed. # Valid values are: # RESIDENTIAL, COMMERCIAL, ARENA, EMBASSY, WILDS, SPLEEF, INN, JAIL, FARM towny-shop-plots: @@ -241,7 +196,6 @@ database: table-prefix: "shopchest_" # If the specified type is 'MySQL', here you configure the... - # (You can leave this empty if you're using SQLite) mysql: # ...interval in seconds, when the database should be pinged, @@ -262,17 +216,4 @@ database: username: "" # ...password you are going to login with - # Be careful, as anyone who can read this file, can read the password! - password: "" - -# Shop limits are handled with permissions. -# A player with permission "shopchest.limit.X" has a limit of X shops, -# a player with permission "shopchest.limit.*" does not have a shop limit. -# Admin shops are excluded from the shop limit. -shop-limits: - - # Set the amount of shops that anyone who doesn't have a - # specific permission may have. - # If you don't want the players to have a limit by default - # set the value to -1. - default: 5 \ No newline at end of file + password: "" \ No newline at end of file