Originally a simple addon to filter the different badges on the Aetherius Trade guild roster it has now evolved a bit and is usable for any guild that has an interest in using badges.
The addon will add a new button on the guild roster right of the "Filter By" label, which toggles the badge filter window. It is possible to select multiple badges in the filter list by pressing and holding shift when clicking on an entry.
The slash command "/abf" allows to toggle the window.
It also accepts an additional parameter to access different functions:
- /abf toggle/show/hide - controls whether the filter window should be shown
- /abf lock/unlock - allows to (un)lock the position and dimension of the window
- /abf reset - resets the position and dimension to the default values
- /abf mode - switches between showing defined and scanned badges
- /abf help - shows a short summary of available commands
What are badges?
Badges are simply labels with a color format placed in the notes of a guild member. For example |cFF0000My Badge|r is a badge. It is important that it has a "|c", 6 hexadecimal values for the color and the "|r" after the label.
Unlike ranks, badges are a lot more transient and versatile as they are not limited in their number*. They also do not require you to set up any permissions and thanks to the description property you can confer more information about a badge than you can add about a rank. With a good set of badges you can add a lot of value to your guild.
Some examples:
- Crafting badges allow to easily discern which types of items a member can craft
- Werewolf and Vampire badges let members know who they can ask when they need a bite
- An officer badge lets members filter for the upper echelons of the guild
- Activity based badges can be used to keep track of members that participate in the guild
*Only the number you can award to a single member is limited by the character count of the note
Dependencies:
Make sure to install the following required libraries in order to use Aetherius Badge Filter.
Creating badges for your guild
There are two ways to activate the filter for your guild.
1) You can simply add the name of the addon - Aetherius Badge Filter - with or without spaces to the MotD or About Us section in your guild.
The addon will then activate itself upon detection and show all badges that are found in the roster.
To deactivate it again, you just need to remove the text and it will simply disappear on the next UI reload.
This mode is convenient if you don't want to create a data file, but due to the way it all works you won't be able to define a description for a badge and groups will also be unavailable.
2) You can create a data file that registers your guild name for a server. The filter then automatically scans for these badges and lists them in alphabetic order when the "Show scanned badges" mode is active.
Lua Code:
AetheriusBadgeFilter:RegisterGuild(AetheriusBadgeFilter.SERVER_NA, "Your Guild Name")
In addition you can also define a list of badges with custom order, groups and descriptions in said file, which allows for a more elaborate badge setup in the "Show defined badges" mode.
Lua Code:
AetheriusBadgeFilter:RegisterGuild(AetheriusBadgeFilter.SERVER_EU, "Your Guild Name", {
{
badges = {
{
name = "MyBadge", -- mandatory field, this name must match what is used in the badge list
description = "My Description", -- optional, shows a tooltip when hovering the mouse over the entry in the filter list
color = "FF0000", -- optional, if not specified it will use the first color found in the notes, or a grey color if the badge is not in use
relations = {"MyOtherBadge"}, -- optional, allows to show other badges simultaneously when this badge is selected
limit = 1, -- optional, sets an upper limit for the member badge editor when incrementing badges. Defaults to 1 and can be turned off by setting it to false
turnsInto = "MyOtherBadge", -- optional, tells the member badge editor that the badge should turn into a different badge when the limit is reached
},
{
name = "MyOtherBadge",
limit = false,
},
}
},
{
name = "MyGroup", -- optional, groups without a name do not have a header. This is only really useful for the first group in the list.
description = "My Group Description", -- optional, shows a tooltip when hovering the mouse over the entry in the filter list
badges = {
{
name = "MyGroupBadge",
},
}
},
})
In this mode the order of badges and groups entirely depends on the order you use in the data file.
The example can also be found in
_Example.lua in the data folder.
In order to test a newly created data file for yourself, you need to add the path to the end of AetheriusBadgeFilter.txt in the addon folder. Otherwise the game won't load the new file in the data folder. Afterwards you need to reload the UI with the /reloadui slash command. Once you finished testing, upload it somewhere and send me a link. I will then proceed to upload a new version of the addon which contains the data file for your guild.
Member Badge Editor
When editing a note on the guild roster of a guild with Aetherius Badges, the editor dialog will be extended with new elements.
On the left side of the textarea, the list of available badges will appear, on the right side you can see a preview of the note and below the note you see how many characters you have left.
When you click a badge in the list on the left side, it will automatically be added if it is not present in the note.
You can also left click the badges in the preview on the right to increment them, or decrement them while holding shift if applicable. Right clicking will open a menu which offers several options based on how the badge is defined:
- Increment - This entry shows up for badges with a limit (>1 or false). When the limit is reached and turnsInto is defined, the other badge will automatically get added or incremented.
- Decrement - Same as the Increment entry, this will only show up for badges with a limit. It will never decrement the count below 0.
- Update Color - This will show up for badges with a defined color when the entry in the note uses a different color.
- Remove - Is always available and will delete the line with the badge.
The editor only recognizes one badge per line, so make sure that you do not have more than one. When the badge count is changed, it will try to parse the part after the badge and update any number it finds.
The following things will work:
Code:
|cffffffMyBadge|r x1\n
|cffffffMyBadge|rx 1 \n
|cffffffMyBadge|r times 2\n
This won't work:
Code:
2x |cffffffMyBadge|r\n
|cffffffMyBadge|r x2 |cffffffMyOtherBadge|r\n
|cffffffMyBadge|r x one\n
It also won't recognize more than one of the same badge in one note and might do unexpected things in that case.
Before pressing save, check the generated note text for any errors. You can always just press cancel and start again when something went wrong.
Supported guilds
EU Megaserver- Aetherius Eight
- Aetherius Guard
- Aetherius Trade
- ALDMERI
- Ars Necandi
- Black Horse Courier
- Boethiah's Reapers
- Constellation
- Eternal Forest Merchantry
- Flipping Coins
- Hanedan
- Haus Winterfell
- Imperial Trading Company
- Inevitable
- Just Traders
- Nirn Traders
- Rolling Coins
- Shining Coins
- Siyah Atlı Kurye
- Tamriel Stock Exchange
- Tamriels Emporium
- TESAll
- The Noble Merchants
- Zenithar's Trading House
NA Megaserver- Black Horse Courier
- Hunger Force
- Nightingale's Utopia
- World Auction House
Translations:
Translations are managed with the help of Weblate. Click the graphic below if you want to learn more.