Config - ElaineQheart/Auction-House GitHub Wiki
Configuring the Auction House plugin is relatively simple. Every configuration of the plugin that you can configure is listed here with a short description of what it does. All files can be reset by simply deleting them and restarting the server.
Raw default config.yml file as of plugin version 1.4.4:
tax: 0.01 # 1% tax
auction-setup-time: 30 # the time it takes to put an item on auction
default-max-auctions: 10
sold-message: true # send a message to the player when one of their auctions is sold
auto-collect: false # automatically gives the money to the player when an auction is bought and removes it from the ah
partial-selling: false # allows players to select the amount of items they want to buy of an auction
admin-permission: "auctionhouse.moderator"
display-update: 20 # 20 ticks = 1 second, how frequently the item displays are updated; can be set to 1 for instant updates
auction-announcements: true # announce when someone puts an item on auction (players can toggle this with /ah announce)
bin-auctions: true # BIN = Buy It Now [/ah sell <amount>]
bin-auction-duration: 172800 # the time an auction lasts in seconds (60*60*48 = 172800)
min-bin: 1 # the minimum sell price
bid-auctions: true # enables actual auctions by typing [/ah bid <amount>]
bid-auction-duration: 7200 # the time a bidding auction lasts in seconds (60*60*2 = 7200)
min-bid: 1 # the minimum bid price
last-bid-extra-time: 60 # if the auction time is less than this when a bid is placed, it's set to this
bid-increase-percent: 25 # how much each bid has to increase at least
use-adventure-text-minimessages: true # I found that not using it is a little bit lag friendlier
The tax set is the amount of currency the player putting up the auction will not get when their auction is bought based on the price it is bought for. Example: If a player buys an item off the auction house for $1000 the player that put up the auction will get $990 if this value is set to 0.01. Set this to 0 if you want to disable tax. This value must be a number.
This value is the time it takes after putting up an auction with /ah until it actually appears on the auction house in seconds. Set this to 0 if you want auctions to appear instantly. This value must be a number.
This value is the default max auctions a player can have at a time if they do not have any permissions that gives them more. (See permissions.yml) This value must be a integer number.
Whether or not to send messages to the player that put up the auction when their auction are sold. This value must be true or false.
Whether or not players automatically get their money from sold auctions. If it is set to false they will have to claim it from the sold message or by viewing their auctions. This value must be true or false.
If set to true players will be able to choose to buy only a certain amount of an item from a bin auction. If set to false players can only buy the entire stack of the auction. This value must be true or false.
The permission name for admin commands. (See Commands & Permissions). This value must be a string.
The interval in ticks between item display updates. This value must be an integer. Set to 1 for instant updates, but this can affect server performance. Value of 20 recommended.
A message is sent to all players when an auction is posted. Players can toggle this with /ah announce if they don't want to see the message. If this setting is set to false, it is disabled completely and that command doesn't exist. This value must be true or false.
Set to true to enable bin auctions which can be made with /ah sell . Set to false to not allow bin auctions on your server. If bid and bin auctions are disabled players can not put items on the auction house. This value must be true or false.
The default duration in seconds of bin auctions if the player posting the auction has no other permission to increase this value. (See permissions.yml) This value must be an integer.
The minimum price a player can sell/bin an item on the auction house for. This value must be a number.
Set to true to enable bid auctions which can be made with /ah bid . Set to false to not allow bid auctions on your server. If bid and bin auctions are disabled players can not put items on the auction house. This value must be true or false.
The default duration in seconds of bid auctions if the player posting the auction has no other permission to increase this value. (See permissions.yml) This value must be an integer.
The minimum starting price a player can post a bid auction for an item on the auction house for. This value must be a number.
The time in seconds a bid auction is set to if a player bids on the auction when the remaining time is less than this value. Example: If a player bids on an auction with 30 seconds left and this value is set to 60, the remaining time of the auction will be set to 60 seconds. This value must be an integer.
How much the bid price increases each time a player bids. (Players cam always bid higher than this) Example: If the current bid of an action is $1000 and this value is set to 25, a player must bid at least $1250 for it to be a valid bid. This value must be an integer.
Whether or not to use the minimessage api for text. This value must be true or false.
Don't change this value.
Old value for config.yml files generated on versions before 1.3.8. Can now be edited in messages.yml
Raw default permissions.yml file as of plugin version 1.4.1:
auction-slots:
bin-auction-duration:
bid-auction-duration:
# auction-slots:
# vip: 12
# mvp: 15
# custom.example.permission: 50
# bin-auction-duration:
# vip: 259200 # 3 days = 259200 seconds
# mvp: 345600 # 4 days
# custom.example.permission: 432000 # 5 days
# bid-auction-duration:
# vip: 10800 # 3 hours
# mvp: 10800 # 3 hours
# custom.example.permission: 86400 # 24 hours
The sudo text(lines starting with #) is an example of a working permissions.yml file. The format for this file is as follows:
auction-slots:
yourPermission: #
yourPermission: #
yourPermission: #
bin-auction-duration:
yourPermission: #
yourPermission: #
yourPermission: #
bid-auction-duration:
yourPermission: #
yourPermission: #
yourPermission: #
The permission name is the permission that you use in your permissions plugin to give players. The permission is not "auctionhouse.yourPermission" unless that's what you set yourPermission too. The # must be a number for each value. If you include a "." in your permission, surround the permission with quotations so it looks like this: "yourPermission.yourPermission": #. You don't include the "" when putting the permission in your permission plugin.
- auction-slots: The # represents the max number of auctions a player with this permission can have up at a time.
- bin-auction-duration: The # represents the number of seconds a bin (buy it now) auction lasts for players with that permission.
- bid-auction-duration: The # represents the number of seconds a bid (with bidding) auction lasts for players with that permission.
If a player has none of these permissions, the default values from the config.yml are used.
A raw default messages.yml file can be found here.
At the top of the messages.yml file you will see the list of color codes and text format codes, but MiniMessages can also be used. (See https://docs.papermc.io/adventure/minimessage/) All It is not recommended to edit the messages.yml file unless you know what you are doing, because a single improper yaml formatting issue can cause the auction house plugin to be unusable. (A good bit of yaml file formatting guides can be found by simply searching online!) Console errors can help you understand what part of the messages.yml file is corrupted.
Tip: %price-trim% can be used instead of %price% if you want to format your numbers like 1.5k instead of 1500!
A raw default layout.yml file can be found here.
Just like for the messages.yml file, wrongly formatting this file can cause the auction house plugin to be unusable. The first section is formatted as follows:
ah-layout:
- '# # # # # # # # #'
- '# . . . . . . . #'
- '# . . . . . . . #'
- '# . . . . . . . #'
- '# # # # # # # # #'
- 's o # p r n # f m'
my-ah-layout:
- '# # # # # # # # #'
- '# . . . . . . . #'
- '# . . . . . . . #'
- '# . . . . . . . #'
- '# # # # # # # # #'
- 'b o # p r n # d i'
This first section of the layout.yml file allows you to move around the icons in the auction house gui layout and the my-auctions GUI layout. You can even delete a row to make the GUI smaller. There's a space character between every other character to make it seem arranged clearly.
The "." icon represents a slots where auction items are displayed. If you want a completely empty spot, replace it with a space character
Other item like "#" or "s" can be edited with the following format: (Example using the "s" item)
s:
==: org.bukkit.inventory.ItemStack
DataVersion: 4671
id: minecraft:oak_sign
count: 1
schema_version: 1
- Only change "==: org.bukkit.inventory.ItemStack" if you are using a custom plugin to add items like ItemsAdder.
- "DataVersion" is the Data Version of the item you want to use (it changes in every new minecraft version)
- "id:" is the item id of the item you want the item you want to use. This is the only thing you should change if you are just changing the item to another vanilla item.
But there's an easier way to customize items than doing it manually: just hold your custom item (even with a custom texture) in your main hand and type [/ah test saveitemtolayout.yml]. This will save your item in the correct format in this file under "test". Now you can just copy-paste it to wherever you want to.
Other items that are not in these two menus can also be customized and edited in this file. Sounds for the auction house interactions can be changed in the layout.yml file by editing these values found at the bottom of the file:
sounds:
click: "UI_STONECUTTER_SELECT_RECIPE"
open-enderchest: "BLOCK_ENDER_CHEST_OPEN"
close-enderchest: "BLOCK_ENDER_CHEST_CLOSE"
break-wood: "BLOCK_WOOD_BREAK"
experience: "ENTITY_EXPERIENCE_ORB_PICKUP"
villager-deny: "ENTITY_VILLAGER_NO"
open-shulker: "BLOCK_SHULKER_BOX_OPEN"
close-shulker: "BLOCK_SHULKER_BOX_CLOSE"
Simply replace the sound you wish to change with a new one. A list of valid sounds can be found here: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Sound.html