Skip to content

BeastlyTheos/Dice-Mice

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

95 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dice Mice

seemlessly roll dice within discord chat

🎲🎲🎲

installation

  1. visit the authorisation page
  2. select the server you wish to add the bot to.
  3. click authorise.
  4. Your dice mice should arrive in your server shortly, ready to roll.

Examples:

Simply write standard RPG dice codes within your discord messages, and let the dice mice do the rest.

  • Theo types, "Attack the goblin for d20+5".
  • Dice Mice types, "Theo -- Attack the goblin for [18]+5 = 23".
    • Nicole types, "Deals d8 + 3d6 +3 damage to the troll with an arrow straight in the forehead!"
    • Dice Mice types, "Nicole -- Deals [6] + [3, 5, 2] +3 = 19 damage to the troll with an arrow straight in the forehead!"
    • Franklin types, "heals his comrade for 2d4-2 hit points."
    • Dice Mice types, "Franklin -- heals his comrade for [1, 3]-2 = 2 hit points."
  • To only include the highest/lowest dice in the final sum, append h or l, followed by the number of dice to keep.
    • Brandon types, "Uses the element of surprise to gain advantage on his pray! 2d20h1+6"
    • Dice Mice types, "Brandon -- Uses the element of surprise to gain advantage on his pray! [14, 3]+4 = 18"
    • Cass types, "rolls 4d6h3 to determine her strength ability."
    • Dice Mice types, "Cass -- rolls [2, 4, 4, 3] = 11 to determine her strength ability."
  • alternatively, append "adv" or "dis" to roll with advantage or disadvantage.
    • Brandon types, "Uses the element of surprise to gain advantage on his pray! d20adv+6"
    • Dice Mice types, "Brandon -- Uses the element of surprise to gain advantage on his pray! [9, 15]+4 = 19"
    • Cass types, "rolls 3d6adv to determine her strength ability."
    • Dice Mice types, "Cass -- rolls [4, 6, 1, 2] = 13 to determine her strength ability."

Make rolling easier with aliases

Store commonly repeated rolls as aliases, then invoke the alias later by putting an exclaimation mark '!' before the alias name.

  • create an alias
    • !alias stat = 4d6kh3
    • !alias att=does a d20+6 attack with his sword.
    • !alias axe = hits with his axe for d10+4 damage!
  • view all aliases
    • !alias
    • Theos has the following aliases defined:
      att = does a d20+6 attack with his sword.
      axe = hits with his axe for d10+4 damage!
      stat = 4d6kh3
  • execute an alias
    • !axe
      Theos -- hits with his axe for [8]+4 = 12 damage!
    • !att
      does a [17]+6 = 23 attack with his sword.

syntax

dice codes have the syntax [<num dice>]d<num sides>[<keep/drop modifier>].

  • num dice (optional) is the number of dice to roll, and must be non-negative.
  • num sides is the number of sides the dice should have, and must be a positive number. E.G. d6 is a six-sided die, and d12 is a 12-sided die.
  • keep/drop modifier (optional) is a code of the form [k|d][h|l], where the first letter indicates whether to keep or drop, the second letter indicates whether the highest or lowest dice will be kep/dropped, and the num is the number of dice kept/dropped.
  • Alternatively, the modifier can be "adv" or "dis" to roll with advantage or disadvantage.

Upcoming Features

  • feature to repeat recent commands
  • optionally printout details about how the message was parsed to assist in debugging and learning syntax
  • syntax for repeating a given roll multiple times in a single message

About

A discord bot that interpolates dice rolling codes in messages, echoing them back to the user.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages