A module for Foundry VTT which adds outlined aura rings to a token.
This Foundry VTT module allows you to add and customise aura rings emanated from a token, ideal for cleanly representing the range of aura type effects without obscuring the map.
Aura rings are calculated as an emanation, based on the Pathfinder 2nd Edition rules. This means that the range of the aura ring is calculated from the edge of the token, instead of the centre.
Creatures larger than 1 tile will have flattened sides to correctly represent their aura range.
Visibility of aura rings can be obscured by fog-of-war, and hidden entirely when the viewing player is unable to see the token from which the aura rings are being emitted.
Hidden tokens will only show their aura rings to the game master.
Dynamic Token Rings, which is a Foundry VTT v12 feature, adds a ring directly around the edge of a token to represent resources, such as health or mana.
Token Aura Ring draws an arbitrary ring at any range from the token's edge.
Either search for and install this module within Foundry VTT, or copy this address into the Manifest URL bar:
https://raw.githubusercontent.com/AnthonyEdmonds/token-aura-ring/main/module.json
Once enabled, you can add and configure aura rings from the "Confgiure Token Aura Rings" button on the "Identity" tab of any token settings page (to avoid any confusion with dynamic token rings).
Settings are fully previewed, and are not stored until you press "Save Changes" and "Update Token".
- Press "Add Aura Ring" to create a new blank Aura Ring
- Press "Open Directory..." to view your stored Aura Rings
- Press "Paste Aura Ring" on any Token to paste from the clipboard
- Press "Save Changes" to save your Aura Rings
- Press "Duplicate Aura Ring" to duplicate the current Aura Ring on the same Token
- Press "Save to Directory" to store the current Aura Ring in the Directory
- Press "Copy Aura Ring" to copy the current Aura Ring to the clipboard
- Press "Delete Aura Ring" to delete the current Aura Ring
Aura rings may be drawn as an outline, a solid fill, or both.
The colour, opacity, and weight can be individually controlled, and strokes have the option of being "closed" if a complete outline is desired.
You can add up to 100 aura rings to a single token by pressing the "Add Aura Ring" button.
Press the "Duplicate Aura Ring" button to create an exact copy of the currently selected aura ring.
Press the "Delete Aura Ring" button to remove the currently selected aura ring.
You can control which user roles can see an aura ring using the "Visible to" setting.
You can also quickly show and hide an Aura Ring by pressing the "Eye" button or checking the "Hire Aura Ring?" option.
Enabling the "Only show on hover?" option will cause the Aura Ring to only show when the token is hovered.
Enabling the "Only show to owner?" option will cause the Aura Ring to only show for the token owner and observer, which includes the Game Master.
Disabling "Respect fog of war?" will cause the Aura Ring to be visible even when the player cannot see the eminating token.
You can adjust the "Direction" and "Angle" settings to create arcs instead of circles.
The "Angle" setting determines how much of the arc to draw.
The "Direction" setting rotates the arc around the token.
Arcs are drawn relative to the top of the token, where a direction of "0" is considered facing forward.
The arc is centralised around its direction, where an angle of "90" would have 45 degrees on either side.
When you rotate the token the arc will rotate with it.
Setting the "Angle" to "360" will draw a complete circle.
This feature is experimental and under development
Checking the "Use grid-based shapes" option will turn the aura ring from euclidean to grid-based, if the current scene has a grid enabled.
Tokens must be of a uniform size (1x1, 2x2, 3x3, etc) for this to work.
Hex grids are not currently supported.
You may set the radius of an aura ring to a negative value to draw within the token's bounds.
This will only work with tokens which feature transparency, and is limited by the overall size of the token.
For example, a standard medium creature (1 square = 5 foot) can have a minimum radius of -2.49 feet.
A global Aura Ring Directory is provided to allow for defining Aura Rings for use across many tokens.
A button to open the Aura Ring Directory is provided in the main "Configure Settings" and on Aura Ring Configuration screens.
You can also open the Directory using a macro, which is provided in the API section.
You can pick which token to add Aura Rings to from the dropdown, which lists all tokens in the current scene.
If the Directory was opened from an Aura Ring Configuration screen, the current token preview will be automatically selected.
Pressing the "Add" button will copy the Aura Ring from the directory onto the selected token.
You can also rename and remove any Aura Rings from the directory.
To overwrite an existing Aura Ring, save an Aura Ring with the same name.
You will be prompted to change the name, in case you did not intend to overwrite an existing Aura Ring.
Pressing the "Remove" button will immediately delete that Aura Ring from the Directory.
Module developers can control Aura Rings using the AuraRingApi class.
Macro developers can control Aura Rings using the TokenAuraRing global variable.
| Function | Parameters | Returns | Description |
|---|---|---|---|
| all | TokenDocument | Array[AuraRing] | Retrieve all Aura Rings |
| blank | AuraRing | Get an unsaved empty Aura Ring without an ID | |
| delete | TokenDocument, id | Remove an Aura Ring | |
| deleteAll | TokenDocument | Remove all Aura Rings | |
| directory | TokenDocument | null | |
| get | TokenDocument, term, field = 'id' | AuraRing|false | Retrieve a specific Aura Ring by a field, ID by default |
| index | TokenDocument | Object{id: name} | Retrieve a list of Aura Ring names keyed by their ID |
| new | TokenDocument | AuraRing | Create a new Aura Ring from the default settings |
| set | TokenDocument, AuraRing | Add or overwrite an Aura Ring | |
| setAll | TokenDocument, Array[AuraRing] | Overwrite all Aura Rings with a new set | |
| setValue | TokenDocument, id, key, value | Update a specific Aura Ring value directly |
All changes will trigger flag updates on the SimpleTokenDocument, and can be edited in the normal UI.
It is left up to the module developer to ensure that any set Aura Rings are valid.
This macro will list all of the Aura Rings on the selected token:
- Create a new
scriptmacro - Paste the following:
console.log( TokenAuraRing.all(token.document), );
- Select a token and run the macro to see a list of the Aura Rings on that token in the console
This macro will toggle an Aura Ring on and off:
const auraRing = TokenAuraRing.get(token.document, 'My Aura', 'name');
TokenAuraRing.setValue(token.document, auraRing.id, 'hide', !auraRing.hide)Replace 'My Aura' with the name of the Aura Ring you want to toggle.
This macro will open the Aura Ring Directory:
TokenAuraRing.directory();This module may not work with game systems or addons which already implement their own token auras.
If you encounter any problems, raise a ticket on Github and I'll take a look.
