Register

Inline Roll Commands

An Add-on Module for Foundry Virtual Tabletop

Author: kaelad Project Source: Project URL Versions 11+ (Verified 12) Last Updated 5 months, 3 weeks ago

End Of Life Notice

The D&D 5e system has included it's own copy of these "enrichers" as of version 2.4.0. Version 3.2.0 added the /item command, finished adding the functionality that this module originally had. It's suggested that you use the system's version of this feature instead of the module going forward. The module includes a migration scripts that you can run from the module settings. You can find more information on the system's version of this feature at: https://github.com/foundryvtt/dnd5e/wiki/Enrichers

 

This module lets you create buttons in item descriptions, chat messages, or journal entries to trigger commands. They look very similar to the deferred inline roll buttons you can create with core Foundry. They also have a similar syntax, making them easy to use and you can use them in the same places.

Say a feature requires a skill check. Currently, the dnd5e system does not support that action type so you have to write it in the description and the player has to trigger it manually. Now you can put [[/rollSkill slt]] into the feature's description and this module will turn that into a button that will roll an Slight of Hand check when clicked.

Before and After

Fast Hands before screenshot Fast Hands after screenshot

Usage

If you are familiar with the deferred inline rolls that Foundry supports, then this should look familiar. You write a command inside square brackets that will trigger that command when clicked. You can optionally pass a flavor at the end to override the button text and use as flavor text when rolled.

General Syntax: [[/<roll-mode><command> <command arguments>]]{<flavor>}

Skill Command

This command will trigger a skill check for the currently-selected tokens. The command requires the skill ID (the short, 3-letter code) for the skill you want to roll. You can find the skill IDs by typing CONFIG.DND5E.skills into the browser's console.

Example: [[/rollSkill ath]] to make an Athletics check

Ability Command

This command will trigger an ability check for the currently-selected tokens. The command requires the ability ID (the short, 3-letter code) for the ability check you want to roll. You can find the ability IDs by typing CONFIG.DND5E.abilities into the browser's console.

Example: [[/rollAbility str]] to make a Strength ability check

Save Command

This command will trigger a saving throw for the currently-selected tokens. The command requires the ability ID (the short, 3-letter code) for the saving throw you want to roll. You can find the ability IDs by typing CONFIG.DND5E.abilities into the browser's console.

Example: [[/rollSave dex]] to make a Dexterity saving throw

Item Command

This command will use an item that the selected token has. The command requires the name of the item you want to use and only supports the roll Roll Mode.

Example: [[/rollItem Dagger]] to use a Dagger

Roll Modes

In additon to the regular /roll that uses the current roll mode at the bottom of the chat log, you can explicitly make the button perform other roll modes using their syntax. Useful if you want to prompt players to make a blind roll so only the GM sees the result by using /blindroll. More information on roll modes can be found on the Basic Dice Foundry KB article.

Example: [[/gmrSkill ath]] for a GM Roll or [[/srSkill ath]] for a Self Roll

Supported Game Systems

  1. Dungeons & Dragons Fifth Edition

    Latest Version: Version 4.1.2 Last Updated 13 hours, 18 minutes ago

Available Versions

  1. Version 1.0.1

    5 months, 3 weeks ago
    Foundry Version 11+ (Verified 12) Manifest URL Read Notes
  2. Version 0.3

    1 year, 6 months ago
    Foundry Version 10+ (Verified 11) Manifest URL Read Notes
  3. Version 0.2

    Foundry Version 10+ (Verified 10) Manifest URL Read Notes
  4. Version 0.1.1

    Foundry Version 10+ (Verified 10) Manifest URL Read Notes