configuring-flo-auction-version-3/language.yml Configuration
Configuring floAuction version 3
language.yml Configuration
The language.yml file contains every textual output floAuction will send, organized by a key system and you can edit pretty much every aspect of it's output. Other auction plugins have stated that they have fully customizable language support, but none I've seen even compare. But with much customizability, comes a bit of, "it can be complicated." I've tried to make every key easily identify what conditions prompts it's output, and hopefully if that isn't clear enough, the default text should be, so I'm not going to include a list of the actual entries in the language.yml.
However, there are a number of keys inside the messages to display specific parameters or data which varies, like the player name, item name and so on. Each of these is represented in the language.yml as a 3 character sequence beginning with %. Additionally, the & character can be used to specify colors in the same way many other plugins implement this.
The key for information about the current running auction (will display "-" if used outside that scope):
Auction Data
- %A1 - The username of the auction owner or of the auction confiscator if being confiscated.
- %A2 - The "display" or "nick" name of the auction owner or of the auction confiscator if being confiscated.
- %A3 - The quantity of the lot which is being auctioned.
- %A4 - The starting bid of the auction.
- %A5 - The minimum bid increment of the auction.
- %A6 - BuyNow amount.
- %A7 - The amount of time remaining on the auction.
- %A8 - Starting auction tax
- %A9 - Ending auction tax, only available at end of auction
Bid Data
- %B1 - The name of the current high bidder.
- %B2 - The display name of the high bidder.
- %B3 - The monetary amount of the current high bid.
- %B4 - The hidden (by default anyways) maximum bid amount the current high bidder specified.
Lot Data
- %L1 - The actual type of the item being auctioned whether or not a display name is set.
- %L2 - The name of the item being auctioned as returned by WhatIsIt. If it has a "display name" set by an anvil, it will display that but in italics, just like the client does.
- %L3 - The power level of the item (only relevant if it's a firework rocket). (2.8.0+)
- %L4 - Book author
- %L5 - Book title
- %L6 - The durability remaining on the item being auctioned as a percent.
- %L7 - A list of enchantments separated by the value in auction-info-enchantment-separator.
Player Prep Data
- %P1 - Player default quantity (formatted)
- %P2 - Player default quantity
- %P3 - Player default price (formatted)
- %P4 - Player default price
- %P5 - Player default increment (formatted)
- %P6 - Player default increment
- %P7 - Player default auction length (formated)
- %P8 - Player default auction length (secs)
- %P9 - Player default BuyNow amount (formated)
- %P0 - Player default BuyNow amount
Scope Data
- %S1 - The player's position in the queue.
- %S2 - The number of auctions queued.
- %S3 - Scope name
- %S4 - Scope id
Time
- %m - minutes
- %s - seconds
Repeating Data
This data will cause the line in which the key is detected to be repeated once per item in the list, replacing the key with each value respectively, or it will suppress the line if no data exists for that key.
- %R1 - The name of the enchantment on the item as returned by WhatIsIt. Will cause the line to be repeated once per enchantment.
- %R2 - A list of each aspect (color, shape, etc.) of the current payload separated by "auction-info-payload-separator". Will cause the line to be repeated once per payload (i.e. each firework star).
- %R3 - The lore on an item. Will repeat the line once per line in the lore with the relevant lore line replacing %R3.
Toggles
Toggles will cause information to be hidden based on the condition of the toggle. For instance, if the message has a value of "%C4This item is enchanted!" the message will only show if the item is enchanted. Each toggle has a corresponding negative using "%N" instead of "%C". Toggles can also be used inside messages used in pairs to crop out parts of a message. For instance, if the message has a value of "This item is %N4not %N4enchanted!" will display "This item is enchanted." if it is, and "This item is not enchanted." if it is not.
- %C1/%N1 - If the player has "auction.admin" permission. Always false on broadcasted messages.
- %C2/%N2 - If the player has "auction.start" permission. Always false on broadcasted messages.
- %C3/%N3 - If the player has "auction.bid" permission. Always false on broadcasted messages.
- %C4/%N4 - If the auctioned item has an enchantment. False if no item or auction.
- %C5/%N5 - If the auctioned item is renamed. False if no item or auction.
- %C6/%N6 - If the auction is sealed. False if no auction.
- %C7/%N7 - If the auction has any bids. False if sealed or no auction.
- %C8/%N8 - If the message is being broadcast to the server or auction scope. False if the message is being sent to a specific player.
- %C9/%N9 - If there is a book title on the auctioned item.
- %C0/%N0 - If there is a book author on the auctioned item.
- %CA/%NA - If there is lore on the auctioned item.
- %CB/%NB - If the auctioned item is damaged.
- %CC/%NC - If the auctioned item is a firework.
- %CD/%ND - If the auction can be bought with a BuyNow price.
- %CE/%NE - If the auctioned item has enchantments (i.e. is enchanted item or has stored enchantments like the Enchanted Book)
- %CF/%NF - If hidden max bids are allowed.
- %CG/%NG - If buynow is allowed.
- %CH/%NH - If autobid is allowed.
- %CI/%NI - If early end is allowed.
- %CJ/%NJ - If auction cancel is allowed (based on the cancel-prevention-percent equaling 100 or not).
- %CK/%NK - If regular auctions are allowed.
- %CL/%NL - If sealed auctions are allowed.
- %CM/%NM - If any kind of auctions are allowed (based on the above two values).
- %CN/%NN - If auctions are running in the scope.
- %CM/%NM - If auctions are queued in the scope.
This file is a .yml file, so if you do go editing it and have issues, check that it's valid yml code before coming to me with issues.
Scope Specific language.yml Files
When working with multiple auction scopes, you can customize the language files per scope. All you need to do is create a file named "language-scopeid.yml" where scopeid is the id of the scope as specified in the config.yml file. If you specified your auction house like in this example below, the id of that would be "auction_house".
auction-scopes: auction_house: name: Auction House type: house house-world: world house-min-x: 289 house-min-y: 75 house-min-z: 216 house-max-x: 297 house-max-y: 80 house-max-z: 226
Most of the language messages can be overridden, but obviously the messages which are outside scopes, for instance the loading and unloading messages, cannot be overridden.