Public | Automated Build

Last pushed: 13 days ago
Short Description
A feature-filled dicebot for Discord that allows you to just roll.
Full Description

Rollem for Discord v1.5.1

A feature-filled dicebot that allows you to just roll.

Add this bot to your server.

View the change log. (or type @rollem changelog in chat)

Beta Channel

Changes will be vetted in the beta channel before being moved to the main bot.

It is recommended to also have the main bot on your server. The beta bot will only be online while changes are being vetted.

If both exist, the main bot will defer to the beta bot.

Add the beta bot to your server.

How to use this bot

Just roll.

@you: 4d6
@rollem: @you, 17 ⟵ [6, 5, 3, 3]4d6

@you: 4d6 for glory
@rollem: @you, 'for glory', 17 ⟵ [6, 5, 3, 3]4d6

Inline rolls.

@you: Rolling [4d6] for glory
@rollem: @you, 17 ⟵ [6, 5, 3, 3]4d6

@you: Rolling [4d6 for glory]
@rollem: @you, 'for glory', 17 ⟵ [6, 5, 3, 3]4d6

Math.

@you: &50+50
@rollem: @you, 100 ⟵ 50 + 50

@you: r50+50
@rollem: @you, 100 ⟵ 50 + 50

Dice Syntax

X and Y are integers. A and B are arbitrary Expressions.

Syntax
XdY Rolls X dice of Y size. 4d6 rolls 4 six-sided dice.
dY Rolls a single die of Y size.
dY! XdY! Exploding dice. Rolly Y on a Y-sided die grants an additional die roll.
A+B A-B Arbitrary chains of addition and subtraction.
A*B A/B Arbitrary chains of multiplication and division.
A++B A--B Arbitrary chains of per-die addition and subtraction. Each value modifies each individual die roll. 4d6--2 rolls 4d6 with 2 subtracted from each.
(E) Parenthetic expressions
A<<B Counts the quantity of values in A that are lower than or equal to the value B. 10d6 << 3 counts the number of dice at 3 or below.
A>>B Counts the quantity of values in A that are greater than or equal to the value B. 10d6 >>4 counts the number of dice at 4 or above.
A<B A>=B Equality comparison on A and B. Must be the last operator ((1 < 2) * 5 is invalid, 1 < (2 * 5) is valid). Supported operators: < <= > >= =
BX GX WX Burning Wheel notation. Aliased to Xd6 >> Y where Y is determined by B/G/W. B=4, G=3, W=2.
BX! GX! WX! Burning Wheel open roll notation. Aliased to Xd6! >> Y where Y is determined by B/G/W. B=4, G=3, W=2.
dF XdF Fate Dice notation. Rolls dice with values of -1, 0, 1. Represented by -, 0, and +.

Limitations

  • Rollem will not roll more than 100 dice.
  • Rollem will not roll "one-sided" dice.
  • Rollem will not roll single numbers.
  • Pure math must be prefixed with & or r.

Prefixing

Give Rollem a role of rollem:prefix:<your prefix here> to disable aggressive rolling.

With this role:

  • Rollem will still roll lines prefixed with & or r
  • Rollem will still roll lines addressed to him. @Rollem 2d20
  • Rollem will still roll inline syntax swing the sword [2d20 for justice]
  • Rollem with not aggressively parse lines 2d20 for justice
  • Rollem will aggressively parse lines prefixed with <your prefix here>

Commands

All commands are performed by mentioning @rollem in server chat, and without prefix in private chat.

Command Example Purpose
stats, help @rollem stats Dump stats, uptime and credit.
changelog, changes, change log, diff @rollem changelog View the most recent changelog entries.

Reporting Problems and Requesting Features

Development

Running the bot directly from Node

  1. DISCORD_BOT_USER_TOKEN=<YOUR TOKEN> node bot.js

Vagrant and Docker Setup

  1. Setup Vagrant with vagrant up
  2. vagrant ssh to get into it.
  3. Code will be in /vagrant.
  4. From /vagrant, run docker build -t rollem . && docker run -it --rm -e DISCORD_BOT_USER_TOKEN='<YOUR TOKEN>' --name rollem rollem

Deploying the Bot

Publishing

  • Bump the version number. Follow semver.
  • npm publish

Using rollem.js as a library

  • npm install rollem-discord
  • const Rollem = require ('rollem-discord');
  • var result = Rollem.tryParse(text) (or Rollem.parse(text) to get the errors from valid rolls)

  • If text did not look like a valid roll, result === null.

  • If text looked like a roll, but was illegal. typeof(result) === "string", where the value is the error message.
  • If text was a valid roll, typeof(result) === "object" and follows this format:
{
  "value": 27,
  "values": [ value1, value2, value3 ],
  "pretties": "[value1, value2, **value3**]",
  "label": "Anything you want",
  "depth": 5,
  "dice": 7
}

Breakdown:

Field
value The final value. Usually a number. Will be boolean if the last statement was of the type x < y. If dice were involved, it will be the collapsed result of summing values.
values The most recent array of results. 2d2 * 2 will result in an array of length 2 with values of either 2 or 4. Probably not useful.
pretties The pretty-printed result. Markdown-compatible. Designed for use with discord. Min/max values are bolded.
depth The depth of the operations. Ex: 5 is 1. 5+5 is 2. d5 is 2. (d5+7)*3 is 4. Use this to avoid matching on 5.
label Any junk text that was passed after the parsed text. Ex: 5 And Some Junk has And Some Junk for this value.
dice The total number of dice used for this roll. Does not include explosions.

Some useful links

Some useful commands

Change image:

curl --request PATCH --header "Authorization: Bot {TOKEN HERE}" -H "Content-Type: application/json" --data '{ "avatar": "{BASE-64 HTML EMBED HERE}" }' https://discordapp.com/api/users/@me
(echo -n '{ "avatar":"'; base64 -w 0 {FILENAME HERE}; echo '" }') | curl --request PATCH --header "Authorization: Bot {TOKEN HERE}" -H "Content-Type: application/json" -d @- https://discordapp.com/api/users/@me

Credits

Avatar by Kagura on Charisma Bonus.

License: MIT

Copyright (c) 2016 Lemtzas

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Docker Pull Command
Owner
lemtzas
Source Repository

Comments (0)