https://github.com/w9jds/beholder-bot
Discord Bot to help DMs run their RPG games!
https://github.com/w9jds/beholder-bot
discord golang hackweek rpg
Last synced: about 12 hours ago
JSON representation
Discord Bot to help DMs run their RPG games!
- Host: GitHub
- URL: https://github.com/w9jds/beholder-bot
- Owner: w9jds
- License: mit
- Created: 2019-06-28T06:49:25.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-08-16T14:24:33.000Z (over 5 years ago)
- Last Synced: 2024-05-16T01:11:27.769Z (12 months ago)
- Topics: discord, golang, hackweek, rpg
- Language: Go
- Size: 5.97 MB
- Stars: 12
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Beholder Discord Bot
#### Created for Discord Hack Week 2019
The goal of this discord bot is to create a tool that helps DMs run their RPG games! There are loads of different tools online that will help you run a virtual table top RPG. However, Discord is one of the best solutions for setting up a voice and text channel for your group. So, unlike a normal Beholder, this bot will help you keep track and setup what you need.
---
## Install!
If you just want to add the bot to your server, you can just use this url to add it:
[Add the Deholder Bot!](https://discordapp.com/api/oauth2/authorize?client_id=464308781501906944&scope=bot&permissions=8)
However, if you would like to build and host it yourself, a `DockerFile` is provided for you. Just build the docker image, and then run it with the below environment variables filled in with your own information.
---
## Commands
- `!createadventureparty [name] [@mention players]` (Done)
- This command automatically creates a category with a text and voice channel based on the name you pass the command. The person running the command is setup as the `DM` of the group, and gets admin for the category. All mentioned players are added to the permissions list as players, only getting permissions for reading, writing, and using the voice channel.
- `!rollstats` (Planned)
- This command will role dice and output values for your stats that you can assign as you wish for a brand new DnD character.
- `!setnextsession [datetime]` [DM Only] (Planned)
- Setting the next session with a datetime formatted like `mm/dd/yyyy hh:mm` will store when you are planing to play your next game.
- `!nextsession` (Planned)
- Print out when the next session is scheduled for.
- `!pollbestday` [DM Only] (Done)
- Create a reaction based poll to find out which day of the week is best suited for all of your players.
- `!addmap [name]` [DM Only] (Done)
- Register a new map for the game channel you are in (only works in game text channels and requires a file to be attached).
- `!getmap [name]` (Done)
- Pull the map with the name provided. This will pull the file from the message that is saved, and post it again automatically for you.
## Environment Variables
|Variables|Description|
|---------|-----------|
|`BOT_TOKEN`|Discord bot token|
|`POSTGRES_HOST`|Postgres host, in this case Instance connection name `project-name:region:instance-name`|
|`POSTGRES_DB`|database name|
|`POSTGRES_PORT`|connection port|
|`POSTGRES_USER`|bot user|
|`POSTGRES_PASSWORD`|user password|
## Components
This bot is currently powered by Postgres, and configured in the code to connect directly to a Google Cloud Platform Cloud SQL instance. However, it can easily be updated to just connect to a normal Postgres hosted instance.