rollem-discord v0.1.1
Rollem for Discord
A feature-filled dicebot that allows you to just roll.
How to use this bot
Just roll.
@you: 4d6
@rollem: @you, 17 ⟵ 6, 5, 3, 34d6@you: 4d6 for glory
@rollem: @you, 'for glory', 17 ⟵ 6, 5, 3, 34d6
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. |
(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: < <= > >= = |
Limitations
- Rollem will not roll more than 100 dice.
- Rollem will not roll "one-sided" dice.
Reporting Problems and Requesting Features
- Issues Tracker
- @Lemtzas on Twitter
- @Lemtzas on Discord. I can be found on Charisma Bonus.
Development
Vagrant and Docker Setup
- Setup Vagrant with
vagrant up vagrant sshto get into it.- Code will be in
/vagrant. - From
/vagrant, rundocker build -t rollem . && docker run -it --rm -e DISCORD_BOT_USER_TOKEN='<YOUR TOKEN>' --name rollem rollem- You will need to replace
<YOUR TOKEN>with an app bot user token from discord's applications page
- You will need to replace
Deploying the Bot
- rollem-discord on docker hub.
- Set the
DISCORD_BOT_USER_TOKENenvironment 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.parse(text)If
textdid not look like a valid roll,result === null.- If
textlooked like a roll, but was illegal.typeof(result) === "string", where the value is the error message. - If
textwas 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
}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. |
Some useful links
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.