Initial Setup - cswendrowski/FoundryVTT-Discord-Rich-Presence GitHub Wiki
Foundry 0.4.X
Install the latest Module using the url https://raw.githubusercontent.com/cswendrowski/FoundryVTT-Discord-Rich-Presence/master/module.json
.
Foundry 0.3.X
Install the latest Module using the url https://raw.githubusercontent.com/cswendrowski/FoundryVTT-Discord-Rich-Presence/0.3.9/module.json
.
Launch a World, go to Module Management
, and turn on Discord Rich Presence
.
Configure the Module settings.
For each and every user, turn on the "Enabled for this client" setting
All display Text settings can insert any Foundry value using [[ <VALUE> ]]
syntax.
The defaults of the settings show how this is used - For example, Playing as [[game.user.character.name]]
while having a chosen Actor of "Leeroy Jenkins" will render out Playing as Leeroy Jenkins
in Discord
game.user.data.currentSceneName
is a custom property added by this module that contains the name of the Scene the Player is currently viewing.
game.system.data.title
is the name of the World's system, such as 13th Age
game.user.character.name
is the Player's currently selected Actor's name
game.world.title
is the name of the World setup by the GM
On each Client machine (not the server!), install the latest matching Companion API from https://github.com/cswendrowski/FoundryVTT-Discord-Rich-Presence/releases
A Module of version 1.X.Y
will always be compatible with a Companion API of 1.X.Y
. Module 1.7.1
will work with Companion API 1.2.5
for instance.
Run the Companion API at least once (per machine) - on first run, the API registers itself with Discord as well as with your OS so that foundryvtt-richpresence://run
launches it. After first run, the Module will control the API's lifecycle.
Mac specific info: imore.com/how-open-apps-anywhere-macos-catalina-and-mojave