Loading...
Forum Rules:
You may only create a new thread here if you have created a guide on how to do something with ElvUI. Do not create a thread here if you just want to ask how to do something.

[Guide] ElvUI Custom Tag Guide

1
ElvUI and oUF Custom Unit Frame Tags
Credits Dandruff

What are tags?
Sometimes you will want certain information on your Unit Frames. Some people would like to see what group they are in, how much health they have left as a percent or an abbreviated value. Tags will allow you to add this information and more to your Unit Frames.

Elv has gone to great lengths to make sure you are covered when it comes to customizing your Unit Frames to be extactly how you want them. This comes with somewhat of a price tag (pun intented). This guide provides an outline that should get you where you want to go.

Table of Contents
Creating your first tag:
Please keep in mind that we are here to help you. If you have an in-depth question or even a simple question that Discord doesn't know the answer to, make a post here! :)
Image
ElvUI Config Overview

There are three important places in the ElvUI Config that you should be aware about:
  1. Text Format - This is where we will place our tags.
  2. Custom Texts - This will allow you to create new element to add custom text to your frame.
  3. Element Selection - You can use this tabs to select different elements to edit.
Last edited by Merathilis on Tue Jul 18, 2017 1:21 pm, edited 31 times in total.

Step 1 - Choosing a Unit Frame

2
Step 1 - Choosing a Unit Frame (back to top)


All of ElvUI Unit Frames support custom tags. Here is a compiled list of the frames ElvUI has:
  • Player Frame
  • Target Frame (TargetTarget Frame, TargetTargetTarget Frame)
  • Focus Frame (FocusTarget Frame)
  • Pet Frame(PetTarget Frame)
  • Arena Frames
  • Boss Frames
  • Assist Frames (Tank Frames)
  • Party Frames (Raid, Raid-40, and Raid Pet Frames)
Last edited by Merathilis on Tue Jul 18, 2017 9:58 am, edited 8 times in total.

Step 2 - Creating a New Element

3
Step 2 - Creating a New Element (back to top)


Image
Creating a new element with a unique and descriptive name.


Before you create a custom tag, you might want to create an element to house it. An element is like a group of tags. It can have multiple tags in it, but when you move group, all the tags move together. In the example above, we wrote a unique and descriptive name in the Custom Text box which will help keep track of tags. There is no strict limitation on how many elements each unit frame can have.

Don't worry about messing anything up, Elv has a reset button just incase!
Last edited by Merathilis on Tue Jul 18, 2017 9:58 am, edited 6 times in total.

Step 3 - Adding a Tag to an Element

4
Step 3 - Adding a Tag to an Element (back to top)


Image
We can either add a tag to our new element or...
Image
... we can change an element that is already in there!

After creating or selecting an element, you can then adjust the tag using the Text Format box. This text will get parsed by ElvUI and then added to the Unit Frame. Here is an example of what you can do with an element:

Text Format (Before the Parser):

Code: Select all

[name] - ([level]) | HP: [health:current]
Unit Frame (After the Parser):

Code: Select all

Dandruff - (90) | HP: 768.4K
Notice how only the square brackets are removed by the parser. This means that you can format your text however you like, with the exception of using square brackets. At the time of writing this guide, there are no ways to use square brackets in your text.

Most of the tags which will be described below, are simple to use as they can be in any order. Color related tags require another tag to modify. In the example below, I use "namecolor" which will color the following text the color of the unit's class (a shaman). Notice how you can use ANY color tag with any other tag.

Text Format (Before the Parser):

Code: Select all

[namecolor][name] - HP: [namecolor][health:current]
Unit Frame (After the Parser):

Code: Select all

Dandruff - HP: 768.4K
After you have finished adding the tags to the element, you can then adjust the position and other settings. In most cases, creating your own element and hiding the original will allow you to customize the custom text even further. For example, the Name element doesn't let you change the Font Outline. You can hide the original element by simply erasing the Text Format box.


Thanks for reading this guide and I hope that it helped you out! A special thank you to Repooc, Elv, and Edoc for their immense contribution to this guide.
Last edited by Merathilis on Tue Jul 18, 2017 9:58 am, edited 1 time in total.

Unit Names

5
Unit Names (back to top)

Options:

Code: Select all

namecolor           ## Changes the Name's color to the Class color
name                ## Shows the unit's name
name:veryshort      ## Shows the unit's name (limited to 5 letters)
name:short          ## Shows the unit's name (limited to 10 letters)
name:medium         ## Shows the unit's name (limited to 15 letters)
name:long           ## Shows the unit's name (limited to 20 letters)

name:veryshort:translit   ## Shows the unit's name (limited to 5 letters) with transliteration
name:short:translit       ## Shows the unit's name (limited to 10 letters) with transliteration
name:medium:translit      ## Shows the unit's name (limited to 15 letters) with transliteration
name:long:translit        ## Shows the unit's name (limited to 20 letters)  with transliteration

Examples:

Code: Select all

[namecolor][name:medium]

Because I am showing a priest, the text is already white, but if it were a shaman, it would be blue.
Image

Examples transliteration:
Without Transliteration:
Image

Code: Select all

[namecolor][name:medium:translit]
Image

Unit Health

6
Unit Health (back to top)


Options:

Code: Select all

healthcolor                  ## Changes color of health, depending on the unit's current health
health:current               ## Shows the unit's current health
health:current-percent       ## Always shows the unit's, and shows the percent when the unit is not full health
health:current-max           ## Shows the unit's current health, and maximum health, separated by a dash
health:current-max-percent   ## Shows the unit's current health, and maximum health, separated by a dash and shows
                                the percent when the unit is not full health
health:max                   ## Shows the unit's maximum health
health:percent               ## Always shows the unit's current health as a percent
health:deficit               ## Shows the health as a deficit (Total Health - Current Health = -Deficit)
deficit:name                 ## Shows the health as a deficit, and the name at full health

## The following variations are the same as above, but without status (e.g. 'DEAD' or 'OFFLINE')
health:current-nostatus
health:deficit-nostatus
health:current-percent-nostatus
health:current-max-nostatus
health:current-max-percent-nostatus
health:percent-nostatus

Examples:

Code: Select all

[healthcolor][health:current]
Image

Code: Select all

[healthcolor][health:current-percent]
Image

Code: Select all

[healthcolor][health:current-max]
Image

Code: Select all

[healthcolor][health:current-max-percent]
Image

Code: Select all

[healthcolor][health:percent]
Image

Code: Select all

[healthcolor][health:deficit]
Image

Unit Power

7
Unit Power (back to top)

Mana, Focus, Rage, etc.

Options:

Code: Select all

powercolor                  ## Changes the color of the unit's power based upon its type
power:current               ## Shows the current amount of power a unit has
power:current-max           ## Shows the current power and max power, separated by a dash
power:current-percent       ## Shows the current power and power as a percent, separated by a dash
power:current-max-percent   ## Shows the current power and max power, separated by a dash and shows
                               the power as a percent when not full power
power:max                   ## Shows the unit's maximum power
power:percent               ## Shows the current power as a percent
power:deficit               ## Shows the power as a deficit (Total Power - Current Power = -Deficit)

## The following variations are the same as above, except they ONLY show a value if the unit has a power resource that is mana 
manacolor                 ## Changes the color of the unit's mana to light blue
mana:current
mana:current-max
mana:current-percent
mana:current-max-percent
mana:percent
mana:deficit
mana:max

Examples:

Code: Select all

[powercolor][power:current]
Image

Code: Select all

[powercolor][power:current-max]
Image

Code: Select all

[powercolor][power:current-percent]
Image

Code: Select all

[powercolor][power:current-max-percent]
Image

Code: Select all

[powercolor][power:percent]
Image

Code: Select all

[powercolor][power:deficit]
Image

Unit Class Power

8
Unit Class Power (back to top)

Holy Power, Astralpower etc.

Options:

Code: Select all

classpowercolor                   ## Changes the color of the special power based upon its type
classpower:current                ## Shows the current amount of the special power a unit has
classpower:current-max            ## Shows the current special power and max special power,
                                     separated by a dash
classpower:current-percent        ## Shows the current amount of special power and current
                                     special power as a percent, separated by a dash
classpower:current-max-percent    ## Shows the current amount of special power and max special
                                     power, separated by a dash and shows the special power as
                                     a percent
classpower:percent                ## Shows the current amount of special power as a percent
classpower:deficit                ## Shows the special power as a deficit (Total Class Power -
                                     Current Class Power = -Deficit)

Examples:

Code: Select all

[classpowercolor][classpower:current]
Image

Code: Select all

[classpowercolor][classpower:current-max]
Image

Code: Select all

[classpowercolor][classpower:current-percent]
Image

Code: Select all

[classpowercolor][classpower:current-max-percent]
Image

Code: Select all

[classpowercolor][classpower:percent]
Image

Code: Select all

[classpowercolor][classpower:deficit]
Image

Unit Alternative Power

9
Unit Alternative Power (back to top)

Introduced with Cataclysm, the alternate power bar is significantly important on raid fights that incorporate it.
Image


Options:

Code: Select all

altpowercolor                   ## Changes text to the current alternative power color (Blizzard defined)
altpower:current                ## Returns altpower text on a unit in current format
altpower:percent                ## Returns altpower text on a unit in percent format
altpower:deficit                ## Returns altpower text on a unit in deficit format
altpower:current-percent         ## Returns altpower text on a unit in current-percent format
altpower:current-max            ## Returns altpower text on a unit in current-max format
altpower:current-max-percent    ## Returns altpower text on a unit in current-max-percent format
Examples:
Coming soon...

Unit Threat

10
Unit Threat (back to top)

This is working as intended. Some targets just don't have a threat table.

Options:

Code: Select all

threatcolor                 ## Changes color of threat, depending on how much you are pulling
threat:current              ## Shows the current threat as a value
threat:percent              ## Shows the current threat as a percent

Examples:

Code: Select all

[threatcolor][threat:current]
IMAGE MISSING

Code: Select all

[threatcolor][threat:percent]
Image