Channel Options - rpg-sage-creative/rpg-sage GitHub Wiki

These options are used during Channel Management.

Note: multiple options can be set at the same time

dialogPost=""

This determines how RPG Sage's dialog posts are handled.

Valid dialogPost values:

  • EMBED uses an embed that includes the character's avatar on the right. (default)
  • POST uses a simple message post some screen readers cannot read Discord embeds.
  • UNSET uses the dialogPost method inherited from either the User, Game, or Server.

Examples:

sage! channel update dialogPost="post"
sage! channel update dialogPost="unset"

NOTE: The embed option uses Discord embeds to show your content, but RPG Sage has no way of knowing if you have embeds turned on or off! If you plan on using embeds, you will need to ensure they are turned on in your Discord settings. As of this edit, they are in Settings > Chat > Embeds and Link Previews.

diceCrit="" (DnD5e and PF2e only)

This sets how Critical Hit damage is calculated.

Valid diceCrit values:

  • TIMESTWO rolls the dice and multiplies the results x2. (default)
  • ROLLTWICE rolls the damage twice and adds the results together.
  • ADDMAX rolls the dice once and then adds max damage to the result. (RPG Sage House Rule)
  • UNSET uses the diceCrit method inherited from either the Game or the Server.

Examples:

sage! channel update diceCrit="addmax"
sage! channel update diceCrit="unset"

diceOutput=""

This determines how compact or verbose the dice results are displayed. Read more about Dice Output here.

Valid diceOutput values:

  • XXS, XS, S
  • M (default)
  • L, XL, XXL
  • ROLLEM uses the diceoutput method that most closely emulates what Rollem uses.
  • UNSET uses the diceoutput method inherited from either the Game or the Server.

Examples:

sage! channel update diceoutput="xxl"
sage! channel update diceoutput="rollem"
sage! channel update diceoutput="unset"

dicePost=""

This determines how RPG Sage posts dice results.

Valid dicePost valus:

  • POST will output dice results in a simple post.
  • EMBED will output dice results in an embed in a post. (default)
  • UNSET uses the dicepost method inherited from either the Game or the Server.

Examples:

sage! channel update dicepost="post"
sage! channel update dicepost="unset"

NOTE: The embed option uses Discord embeds to show your content, but RPG Sage has no way of knowing if you have embeds turned on or off! If you plan on using embeds, you will need to ensure they are turned on in your Discord settings. As of this edit, they are in Settings > Chat > Embeds and Link Previews.

diceSecret=""

This determines how RPG Sage reacts to dice with the word "secret" in them.

Valid diceSecret values:

  • DM tells Sage to find the first available GM and send the dice results to them as a DM.
  • GM tells Sage to find a GM channel and send the dice results there. If no GM channel exists, this is treated as DM.
  • HIDE tells Sage to hide/redact the results using spoiler tags.
  • IGNORE simply ignores them. (default)
  • UNSET uses the dicesecret method inherited from either the Game or Server.

Examples:

sage! channel update dicesecret="ignore"
sage! channel update dicesecret="unset"

diceTo=""

This tells RPG Sage to send the results of any Dice rolled to the given Channel instead of the Channel they were rolled in. Secret Dice will still adhere to the settings of diceSecret (if set) and go to the appropriate GM channel if configured to do so.

Example:

sage! channel update diceTo=" #Dice-Only "

gameSystem="" (Non-Game Channels only)

This is the Game System, which determines how RPG Sage handles certain features, such as Dice and Search.

Valid gameSystem values:

  • CNC Coyote & Crow
  • DND5E Dungeons & Dragons 5e
  • E20 Essence 20 system (G.I. Joe, Power Rangers, Transformers, etc.)
  • PF1E Pathfinder RPG
  • PF2E Pathfinder 2e
  • QUEST Quest RPG
  • SF1E Starfinder
  • VTM5E Vampire: The Masquerade (5e)
  • NONE (default)

Examples:

sage! channel update gameSystem="vtm5e"
sage! channel update gameSystem="pf2e"

type=""

This sets the type of channel, which determines how RPG Sage handles certain features, such as Dialog and Dice.

Valid type values:

  • IC (In Character) only Dialog and Dice are allowed for GMs and Players
  • OOC (Out of Character) all Sage commands are allowed for GMs and Players
  • GM (Game Master) all Sage commands are allowed for GMs
  • DICE (Dice) only Dice commands are allowed for GMs and Players
  • MISC (Miscellaneous) all Sage commands are allowed for GMs and Players
  • UNSET tells Sage that this isn't a specific channel type

Note: A GM only channel is where secret dice rolls are sent!

Examples:

sage! channel update type="ooc"
sage! channel update type="gm"