Skip to content

fantasycalendar/FoundryVTT-MinionManager

Repository files navigation

Minion Manager

Latest Release Download Count Forge Installs Foundry Core Compatible Version Latest Version


Fantasy Computerworks Logo

A module made by Fantasy Computerworks.

Other works by us:

  • Fantasy Calendar - The best calendar creator and management app on the internet
  • Sequencer - Wow your players by playing visual effects on the canvas
  • Item Piles - Drag & drop items into the scene to drop item piles that you can then easily pick up
  • Tagger - Tag objects in the scene and retrieve them with a powerful API
  • Rest Recovery - Automate most D&D 5e long and short rest mechanics
  • Token Ease - Make your tokens feel good to move around on the board

Like what we've done? Buy us a coffee!

Buy Me a Coffee at ko-fi.com


What is this module?

Minion Manager is a module that automates the MCDM "Flee, Mortals!" minion rules. This includes:

  • Overkill damage from melee and ranged weapons
  • Minion group attacks
  • Group-style initiative

These are all configurable through the module's settings.

Minions & Group Attacks

You can right-click on actors to turn them into minions, and then right-click on their attacks to turn them into group attacks.

Turning a token into a minion Turning a minion's attack into a group attack

You can also include the identifier @numberOfMinions anywhere in the attacks to reference the number of minion attacking.

Note: This is automatically included in any damage part that does not already have it.

Number of minions modifier in the damage

Group Initiative

You can set this by **right-clicking&& on the token HUD's "toggle battlemode" button (two crossed swords over a shield) to open the group initiative interface - clicking on a number within that UI moves all the selected tokens into that initiative group.

Reducing or deleting any characters of a group does not affect the combat tracker, unless all of them are deleted or marked as defeated.

Where can I find the minion rules?

You can find the full MCDM book here:

https://shop.mcdmproductions.com/collections/flee-mortals-the-mcdm-monster-book

Or the preview packet for the minion rules here:

https://files.mcdmproductions.com/FleeMortals/FleeMortalsPreview.pdf

Documentation

API

You can access the API through game.modules.get("minionmanager").api

Functions

setGroupInitiative

game.modules.get("minionmanager").api.setGroupInitiative(targets, groupNumber) ⇒ boolean | Promise<Array<Document<any, Scene>>>

Sets the group initiative of a set of tokens or actors.

Kind: global function

Param Type Description
targets Array<string/Token/TokenDocument/Actor>/Atring/Token/TokenDocument/Actor The targets to add to the group initiative
groupNumber Number The group initiative to set on the targets

removeGroupInitiative

game.modules.get("minionmanager").api.removeGroupInitiative(targets) ⇒ boolean | Promise<Array<Document<any, Scene>>>

Removes the group initiative of a set of tokens or actors.

Kind: global function

Param Type Description
targets Array<string/Token/TokenDocument/Actor>/Atring/Token/TokenDocument/Actor The targets to remove the group initiative from

getActors

game.modules.get("minionmanager").api.getActors(targets) ⇒ Array<Actor>

Helper function - turns a list of UUID strings/tokens/token documents into a list of the respective actors

Kind: global function

Param Type
targets Array<string/Token/TokenDocument/Actor>/Atring/Token/TokenDocument/Actor

turnIntoMinions

game.modules.get("minionmanager").api.turnIntoMinions(actors) ⇒ Promise<void>

Turns the given actors into minions by creating a minion feature document on the actor.

Kind: global function

Param Type
actors Array<string/Token/TokenDocument/Actor>String/Token/TokenDocument/Actor

revertMinions

game.modules.get("minionmanager").api.revertMinions(actors) ⇒ Promise<void>

Removes the minion feature from a set of actors, turning them back into normal actors.

Kind: global function

Param Type
actors Array<string/Token/TokenDocument/Actor>stringTokenTokenDocumentActor

isMinion

game.modules.get("minionmanager").api.isMinion(target) ⇒ boolean

Helper function - returns true or false whether the given target is a minion or not

Kind: global function

Param
target

setActorItemToGroupAttack

game.modules.get("minionmanager").api.setActorItemToGroupAttack(item, isGroupAttack) ⇒ Promise<Item>

Helper function - sets the given item to become a group attack type feature

Kind: global function

Param Type
item Item
isGroupAttack boolean

isItemGroupAttack

game.modules.get("minionmanager").api.isItemGroupAttack(item) ⇒ boolean

Helper function - returns whether the given item is a group attack type feature

Kind: global function

Param Type
item Item

turnActorAttacksIntoGroupActions

game.modules.get("minionmanager").api.turnActorAttacksIntoGroupActions(actors) ⇒ Promise<void>

Turns every feature or item on a given actor into group attack type features

Kind: global function

Param Type
actors Array<Actor>

revertActorAttacksFromGroupActions

game.modules.get("minionmanager").api.revertActorAttacksFromGroupActions(actors) ⇒ Promise<void>

Reverts every feature or item on a given actor back into a normal item from being a group attack type feature

Kind: global function

Param Type
actors Array<Actor>