module

Token Factions

Endorsements
0
Installs
1.36%
Comments
0
Latest version0.5.1
Minimum Core11
Compatible Core11
Last updated3 months ago
Created3 years ago
Authors
Languages Deutsch
English
Systems All systems
Dependencies libWrapper
Project source Project URL
Report bugs Bug tracker URL
Read-me Readme URL
Changelog Changelog URL

Tokens Faction

This module will allow you to assign tokens to factions by using the token's disposition colors, the token actor's folder color, or defining your own custom replacement colors for token dispositions.

If you want to buy me a coffee alt-text

This module will allow you to assign tokens to factions by using the token's disposition colors, the token actor's folder color, or defining your own custom replacement colors for token dispositions.

alt text

Installation

It's always easiest to install modules from the in game add-on browser.

To install this module manually:

  1. Inside the Foundry "Configuration and Setup" screen, click "Add-on Modules"
  2. Click "Install Module"
  3. In the "Manifest URL" field, paste the following url: https://raw.githubusercontent.com/p4535992/foundryvtt-token-factions/master/src/module.json
  4. Click 'Install' and wait for installation to complete
  5. Don't forget to enable the module in game using the "Manage Module" button

libWrapper

This module uses the libWrapper library for wrapping core methods. It is a hard dependency and it is recommended for the best experience and compatibility with other modules.

Known issue

Configuration

alt text

Generate Token Faction Color From

  • A Token's Disposition
  • An Actor's Folder Color
  • A Custom Color Set For Token Disposition

Default: A Token's Disposition

This option uses the default Token Disposition color to render the token base and frame. Token Disposition can be seen on a token's Character tab. Tokens with actors controlled by players are colored in a fourth, distinct color.

alt text

An Actor's Folder Color

This option uses the color of the folder a token's actor belongs in. A color of #000000, or the default color of a new actor folder, is treated as if there is no folder that will prevent a base and frame from being rendered for contained actor tokens.

alt text

[ON DEVELOPING] A Custom Color Set For Token Disposition

This option reveals additional configuration options allowing you to customize colors associated with each token disposition.

alt text

Choose shape of your faction

Token frames (rings, square, hex) are layered above token graphics.

img1

img2

img3

img4

alt text

You can override this setting on a per-token basis on a token's Image tab if you use a mix of round and irregular tokens.

alt text

Frame Render Style

[FOR NOW IS THE ONLY AVAIABLE OPTION] Default: Flat

This option renders the frame in a flat color.

alt text

[ON DEVELOPING] Beveled

This option renders the frame in a beveled style typically seen surrounding round tokens.

alt text

Frame/Border Width (Percent of Grid Unit)

This allows you to change the thickness of the rendered frame. The percentage is based on the width of a single grid unit, not the token width, so larger and smaller tokens will have a consistent frame size.

alt text

Base Opacity

Setting this value to anything lower than 1 will allow the map background to be seen through the base. Setting this value to 0 will disable drawing the base entirely.

Frame Opacity

Setting this value to anything lower than 1 will allow the map background or token to be seen through the frame. Setting this value to 0 will disable drawing the frame entirely.

Enable/Disable the faction on the single token on the canvas

  • Left click: You can enable/disable the faction style for single token with a new hud button
  • Right click: Open a dialog for customize the border color

img7

API

game.modules.get('token-factions').api.retrieveBorderFactionsColorFromToken(tokenIdOrName:string) ⇒ string

A method to retrieve the string color hex border of a token on the canvas founded by id or name

Returnsstring

Param Type Description Default
tokenIdOrName string The oken id or name (if founded) #000000

async game.modules.get('token-factions').api.disableDrawBorderFactionsFromTokens(tokenIdsOrNames:string[]) ⇒ Promise<void>

A method to disable the draw border factions on a array of tokens on the canvas founded by id or name

ReturnsPromise<void>

Param Type Description Default
tokenIdsOrNames string[] The array of token ids or names (if founded) undefined

async game.modules.get('token-factions').api.disableDrawBorderFactionsFromToken(tokenIdOrName:string) ⇒ Promise<void>

A method to disable the draw border factions on a token founded by id or name

ReturnsPromise<void>

Param Type Description Default
tokenIdOrName string The token id or name (if founded) undefined

async game.modules.get('token-factions').api.enableDrawBorderFactionsFromTokens(tokenIdsOrNames:string[]) ⇒ Promise<void>

A method to enable the draw border factions on a array of tokens on the canvas founded by id or name

ReturnsPromise<void>

Param Type Description Default
tokenIdsOrNames string[] The array of token ids or names (if founded) undefined

async game.modules.get('token-factions').api.enableDrawBorderFactionsFromToken(tokenIdOrName:string) ⇒ Promise<void>

A method to enable the draw border factions on a token founded by id or name

ReturnsPromise<void>

Param Type Description Default
tokenIdOrName string The token id or name (if founded) undefined

 

Subscribe
Notify of
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x