lemtzas/rollem-discord repository overview

⁠Rollem for Discord

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. This is per-channel.

Add the beta bot to your server.⁠

⁠Links

• Patreon⁠
• Rollem Support Server⁠
• Issues Tracker⁠

⁠How to use this bot

Just roll.

Inline rolls.

Repeated rolls.

Stat generation.

Math.

⁠Dice Syntax

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

⁠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.
• Rolls prefixed with N# will be rolled N times. N > 100 will be ignored.

⁠Prefixing

Give Rollem a role of rollem:prefix:<your prefix here> to disable no-prefix 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.

⁠Development

⁠Single Shard development

• You will need an app bot user token from discord's applications page⁠
• Set up yarn⁠
• Run yarn install in the root directory
• Install typescript yarn global add typescript
• Rename and update ./secrets/sample-vscode.env
  • You will need to replace YOUR_TOKEN_HERE with an app bot user token from discord's applications page⁠
  • The Application Insights line may be deleted to switch to console-only logging.

⁠From VSCode (with debugging)

1. Rename and update ./secrets/sample-vscode.env
2. Press F5 while the project folder is open. Launch configuration is in ./.vscode/launch.json

⁠Single Shard (no debugging)

1. Rename and update ./secrets/sample-vscode.env
2. Run yarn run start

⁠Multiple Shards (no debugging)

1. Rename and update ./secrets/sample-vscode.env
2. Run yarn run start-sharder

⁠Running in Docker

1. yarn run package (The container will compile it)
2. yarn run start-package

⁠Local Kubernetes Development

These are incomplete and are a massive pain on Windows anyway.

1. Setup Minkube

• Windows-specific instructions⁠)
• General instructions⁠

1. minikube start (may need to restart VSCode or your terminal first for it to find the command)
2. kubectl cluter-info confirm it's working
3. minikube dashboard open the dashboard
4. eval $(minikube docker-env) to setup for local running
5. docker-machine create --driver virtualbox default to get docker going on virtualbox
6. docker build -t rollem-discord . to build the current docker image

⁠Deploying the Bot

• rollem-discord on docker hub⁠.
• Set the DISCORD_BOT_USER_TOKEN environment variable to your token from discord's applications page⁠.
• The docker hub will automatically update with the latest commits on master.

⁠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:

⁠Some useful links

• language-pegjs for atom⁠
• pegjs online⁠
• pegjs documentation⁠
• discord.js⁠
• discord.js docs⁠
• discord API docs⁠

⁠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) 2018 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.