Command Line Documentation

Command list

add

Adds one or more an entities to the game. When adding entities, users can optionally create the entity with a type and attributes such as hit points, armor class, and speed.

Flags:

  • -t, --type : Specify the type of entity (e.g., player, monster)
  • -c, --count : Specify the number of copies to create
  • -i, --initiative : Update the entities initiative.
  • -hp, --hit-points : Specify the entities maximum hit points
  • -ac, --armor-class : Specify the entities armor class
  • -sr, --speed-running : Specify the entities running speed. Must be a multiple of 5
  • -sf, --speed-flying : Specify the entities flying speed. Must be a multiple of 5
  • -ss, --speed-swimming : Specify the entities swimming speed. Must be a multiple of 5
  • -pp, --passive-perception : Specify the entities passive perception

Arguments:

  • name(s) : The name(s) of the entities to add (e.g., Boblin)

Example:

add --type monster Goblin -c 3 -hp 7 -ac 16 -spr 25 //Creates three goblin entities

remove, rm

Removes one or more an entities from the game.

Arguments:

  • name(s) : The name(s) of the entities to add (e.g., Boblin)

Example:

remove Goblin1 Goblin2 Goblin3 //Removes three goblin entities

rename, rn

Renames an entity.

Arguments:

  • old name : The name of the entity to name change.
  • new name : The new name of the entity.

Example:

rename Goblin2 Boblin //Changes goblin2s name to Boblin

roll-for-initiative, rfi

Prompts the user to roll and enter initiatives for all entities one at a time. Entered values must be between -99 and 99.

run

Starts the encounter.

stop

Stops the encounter.

next, n

Increments the active entity to the next entity sorted by initiative. The encounter must be active.

undo

Undo the previous action.

redo

Redo the previously undone action.

heal

Add hit points to one or more entities. Users can optionally deal half or double hit points of healing using the breakdown flag.

Flags:

  • -b, --breakdown : Optionally specify the multiplier breakdown for each entity to be healed. The number of characters must match the number of entities

Arguments:

  • name(s) : The name(s) of the entities to add (e.g., Boblin)
  • healing : The amount of hit points to give to each specified entity

Example:

heal Player1 Player2 Player3 12 -b ffh

damage, dmg

Subtract hit points from one or more entities. Users can optionally deal half or double hit points of damage using the breakdown flag.

Flags:

  • -b, --breakdown : Optionally specify the multiplier breakdown for each entity to be damages. The number of characters must match the number of entities

Arguments:

  • name(s) : The name(s) of the entities to add (e.g., Boblin)
  • damage : The amount of hit points to take from each specified entity

Example:

dmg Goblin1 Goblin2 10 -b fd

update

Flags:

  • -t, --type : Specify the type of entity (e.g., player, monster)
  • -i, --initiative : Update the entities initiative.
  • -hp, --hitpoints : Specify the entities current hit points. Must be less than or equal to current maximum.
  • -hm, --hitpoints-maximum : Specify the entities maximum hit points
  • -hb, --hitpoints-bonus : Specify the entities bonus or temporary hit points
  • -ac, --armor-class : Specify the entities armor class
  • -sr, --speed-running : Specify the entities running speed. Must be a multiple of 5
  • -sf, --speed-flying : Specify the entities flying speed. Must be a multiple of 5
  • -ss, --speed-swimming : Specify the entities swimming speed. Must be a multiple of 5
  • -pp, --passive-perception : Specify the entities passive perception

Arguments:

  • name(s) : The name(s) of the entities to update (e.g., Boblin)

Example:

update Player1 -ac 18 //Changes the armor class of Player1 to 18

show

Flags:

  • -a, --all : Show all columns
  • -n, --number : Show the entity number column
  • -t, --type : Show the entity type column (e.g., player, monster)
  • -i, --initiative : Show the entity initiative column
  • -c, --conditions : Show the entity status condition column
  • -hp, --hitpoints : Show the entity hitpoints column
  • -ac, --armor-class : Show the entity armor class column
  • -s, --speed : Show the entity speed column
  • -pp, --passive-perception : Show the entity passive perception column

Example:

show -ac --speed //Shows the armor class and speed columns if not already showing

hide

Flags:

  • -a, --all : Hide all but the name column
  • -n, --number : Hide the entity number column
  • -t, --type : Hide the entity type column (e.g., player, monster)
  • -i, --initiative : Hide the entity initiative column
  • -c, --conditions : Hide the entity status condition column
  • -hp, --hitpoints : Hide the entity hitpoints column
  • -ac, --armor-class : Hide the entity armor class column
  • -s, --speed : Hide the entity speed column
  • -pp, --passive-perception : Hide the entity passive perception column

Example:

hide -ac --speed //Shows the armor class and speed columns if not already showing

status, stat

Flags:

  • -a, --all : Apply or remove the provided status to or from all entities
  • -c, --conditions : Use with the -r/--remove and -a/--all flags to filter on specific conditions
  • -e, --entities : Use with the -r/--remove and -a/--all flags to filter on specific entities
  • -r, --remove : Remove the specified status
  • -d, --duration : Optionally specify the number of rounds the status should be applied

Example:

status Goblin1 Restrained //Apply the Restrained status to Goblin1
status -r Goblin1 Grappled //Remove the Grappled status from Goblin2
stat -a -r Confused //Remove the confused status from all affected entities.
stat Goblin3,Goblin4 Blinded //Apply the Blinded status to Goblin3 and Goblin4
stat Goblin5 Blinded,Deafened //Apply the Blinded and Deafened status to Goblin5
stat Goblin3 Goblin4 Blinded //INVALID SYNTAX, USE COMMA
stat Goblin5 Blinded Deafened //INVALID SYNTAX, USE COMMA
stat -a Confused -d 3 //Apply the confused status to all entities for 3 rounds