Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tsabelmann/cthulhubot
An interactive discord bot that allows throwing dice according to the pen and paper game Cthulhu.
https://github.com/tsabelmann/cthulhubot
chaos cthulhu cthulhu-mythos dice dice-roller dice-rolling dice-rolling-application discord discord-bot poetry python python3 tabletop-rpgs ttrpg
Last synced: about 17 hours ago
JSON representation
An interactive discord bot that allows throwing dice according to the pen and paper game Cthulhu.
- Host: GitHub
- URL: https://github.com/tsabelmann/cthulhubot
- Owner: tsabelmann
- License: mit
- Created: 2020-12-02T11:54:08.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-11-27T18:45:55.000Z (12 months ago)
- Last Synced: 2023-11-28T15:03:58.544Z (12 months ago)
- Topics: chaos, cthulhu, cthulhu-mythos, dice, dice-roller, dice-rolling, dice-rolling-application, discord, discord-bot, poetry, python, python3, tabletop-rpgs, ttrpg
- Language: Python
- Homepage:
- Size: 243 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cthulhu Discord Bot
An interactive discord bot that allows convenient commands for dice throwing considering the pen and paper game **Cthulhu**.
## Installation
1. ```bash
git clone https://github.com/tsabelmann/cthulhu_discord_bot
```
2. ```bash
cd cthulhu_discord_bot
```
3. ```bash
poetry install
```
4. ```bash
echo "export DISCORD_TOKEN=YOUR_TOKEN" > .env
```
5. ```bash
poetry run cthulhu
```
## Usage
The **Cthulhu** discord bot provides two commands: **#roll** and **#probe**. The **#roll** command allows the throwing of dice and the subsequent summation and addition of optional values. The **#probe** command allows the check of ones *ability* against **one** thrown d100 with *additional* **bonus** or **malus** dice.
## Dice Syntax
A regular die is specified be the *amount* of dice you want to throw and the *dice eyes*. The most common dice eyes are **100**, **20**, **12**, **10**, **8**, **6**, **4**, and **3**.
### Examples
- `1d100`
- `2D100`
- `1w20`
- `3W10`
- `1d8`
- `6D6`
- `1W4`
- `2w3`
### Disclaimer
The letters **w** and **W** can be used as a shortcut, because the german word for die or dice is Würfel.
## Value Syntax
Values to be added to the final sum consists of a *sign*, and a *value* part.
### Examples
- `+2`
- `-3`
## Examples
- `#roll 1d100`
- `#roll 2d100 1d10 1d8 1d6 1d4 1d3`
- `#roll 1d20 +3`
- `#roll 1d20 +1+2+3`
- `#roll 1 + 1d20 +2+2d6 +1 + 7+1d8`
- `#probe 50 \\ neither bonus nor malus is applied`
- `#probe 50 b 1`
- `#probe 50 B 1`
- `#probe 50 bonus 1`
- `#probe 50 m 1`
- `#probe 50 M 1`
- `#probe 50 malus 1`
- `#probe 50b1`
- `#probe 50B1`
- `#probe 50 b1`
- `#probe 50B 1`
- `#probe 50 BOnUs 1`
- `#probe 50m1`
- `#probe 50M1`
- `#probe 50 m1`
- `#probe 50M 1`
- `#probe 50 MAlUs 1`
## Acknowledgement
The bot is currently only available if one executes it on the fly. It is not containerized at the moment. Furthermore, the installation requires `Poetry`.