Foundry commands
Change location in three keys
Activate the next scene, start its ambient sound and set its darkness, each command on its own key.
The JDR Ninja module for Foundry
Control your character sheets from your Stream Deck.
Activate a scene, show a clue, make a roll or edit a character sheet directly from Stream Deck. The JDR Ninja plugin sends your commands to Foundry VTT, and variables let you reuse the same keys throughout the game.
A key can change any field that Foundry lets you edit: a character’s inspiration, hit points or currency, an item’s charges, the name of a journal page. Up to 16 fields change in a single update.
With variables, a key can also:
Each example shows what it uses and links to its step-by-step setup in the guide.
Foundry commands
Activate the next scene, start its ambient sound and set its darkness, each command on its own key.
Variables: list and combined command
A list of pages and a combined command: move to the next clue and show it to your connected players, with no macro.
Variables: counter and composed text
A counter from 0 to 6 saved in a variable: raise it and announce its new value in the chat.
Document updates
Turn inspiration on or off on a player’s character sheet, without opening it.
The plugin offers 40 commands: 31 for Foundry VTT, including document updates, and 9 for variables. Each command respects the permissions of the signed-in Foundry user, and commands marked GM are reserved for the game master.
A list of NPCs or clues, a counter, a bonus: with variables and lists created in Foundry, a few keys are enough for the whole game. A combined command changes a value and then runs an action, for example moving to the next clue and showing it. Values and permissions are checked on every press.
Variables are saved in Foundry’s settings, not in the browser.
game.settings
flags.jdr-ninja.arguments
Document#update()
Each command calls a Foundry VTT function, shown under its name: Foundry does the work, with its own rules and your permissions.
Open actor
Actor#sheet.render()
Execute macro
Macro#execute()
View scene
Scene#view()
Activate scene GM
Scene#activate()
Preload scene GM
game.scenes.preload()
Set darkness GM
Scene#update({ darknessLevel })
Open journal page
JournalEntry#sheet.render()
Share journal page GM
Journal.show()
Play or stop sound GM
Playlist#playSound() / stopSound()
Next or previous track GM
Playlist#playNext()
Stop playlist GM
Playlist#stopAll()
Set volume GM
PlaylistSound#update({ volume })
Pause or resume GM
game.togglePause()
Open sidebar tab
ui.sidebar.changeTab()
Select tool
ui.controls.activate()
Roll dice
Roll#toMessage()
Draw from table
RollTable#draw()
Send chat message
ChatMessage.create()
Select token
Token#control()
Target token
Token#setTarget()
Hide or reveal token GM
TokenDocument#update({ hidden })
Adjust token resource
Actor#modifyTokenAttribute()
Apply or remove condition
Actor#toggleStatusEffect()
Start combat GM
Combat#startCombat()
End combat GM
DialogV2.confirm() + Combat#delete()
Next turn GM
Combat#nextTurn()
Previous turn GM
Combat#previousTurn()
Next round GM
Combat#nextRound()
Roll initiative GM
Combat#rollAll()
Test overlay
JDR Ninja server, Premium access
“Adjust token resource” only changes the token’s resource bar: it does not handle damage or healing according to each system’s rules. “End combat” asks for confirmation in Foundry.
These captures show module settings in a real Foundry browser and the plugin development inspector. They illustrate local configuration and do not certify physical Stream Deck hardware. The temporary port in the captures differs from the guide’s default port 19114.
In the module’s “Stream Deck” window, enter the connection address and the pairing key, then click “Save and enable”.
The command and its input fields depend on the selected session and Foundry user's permissions.
The Stream Deck plugin sends your commands to the JDR Ninja module over a local connection, in the Foundry browser you chose. Foundry executes the commands and checks the permissions of the signed-in user. That browser must stay open on the same computer as Stream Deck, but the Foundry server can be hosted elsewhere. The local connection uses its own pairing key: it asks for no JDR Ninja account token and does not replace any Foundry permission.
Each key stays tied to the world, user and browser you chose. The plugin distinguishes a completed command from a refused one or one with an uncertain outcome. If the outcome is uncertain, check Foundry before pressing again.
You need Foundry V14 or later with the JDR Ninja module enabled, the Stream Deck application with the JDR Ninja plugin, and Node.js 24 for the local connection. Each key must explicitly target a session.
Commands respect the Foundry permissions of the selected session. Overlay test carries a Premium marker and requires account connection, overlay enablement and server access verification. Other module features have separate conditions. No general subscription tier has been announced for local commands.
They store a value in Foundry: the chosen NPC, the current clue, a counter or a bonus. A key uses the value of the moment, and the “Change variables and run command” command changes it and then acts in Foundry.
Yes. The browser that opens the game must still run on the same computer as Stream Deck.
No. They only work if a Foundry browser is open, connected to the game and ready to receive commands. If you close that browser, the session ends.
Select the session again on your keys. Each new Foundry connection gets a new identity. Reconnecting only the plugin can rediscover a Foundry session that stayed connected.
Available actions depend on the signed-in Foundry user's permissions. A key grants no additional rights and never automatically switches users.
Overlay test requires Premium access verified in Foundry. No general subscription requirement has been announced for local commands. Generators and other module features have their own access conditions.
Development tests use a real Foundry browser and a simulated Elgato host. Physical Stream Deck hardware, Windows/macOS installation and trusted-certificate wss still await acceptance. No general hardware compatibility claim is made.
Yes, if Foundry lets you edit that document: the GM can edit anything, a player only what belongs to them. The field path depends on the game system and the module does not check it. Foundry ignores a field that does not exist, and an increase or a toggle on that field is reported on the key.
Follow the guide to connect the three components and test a simple command.