An open API service indexing awesome lists of open source software.

https://github.com/chillfish8/innkeeper

A Advanced D&D and RPG roleplaying bot.
https://github.com/chillfish8/innkeeper

5e 5estuff discord discord-bot discord-py discord-python discord-python-bot discordbot discordbotlist dungeons-and-dragons python python3 roleplay

Last synced: 3 months ago
JSON representation

A Advanced D&D and RPG roleplaying bot.

Awesome Lists containing this project

README

        

# The Innkeeper discord bot

The Innkeeper is one of the most advanced D&D 5e discord bots around, Full Audio intergration, better initative tracking, full compatability dice rolling and fully custom content intergration. Used by over 180,000 Users across discord.

## Commands:


Content Commands:


+ ?spell - Using a D&D 5e API or pulling from user's custom content

+ ?class - Using a D&D 5e API or pulling from user's custom content

+ ?race - Using a D&D 5e API or pulling from user's custom content

+ ?monster - Using a D&D 5e API or pulling from user's custom content



Dice Commands:


+ ?roll - Supports complex dice rolling with exploding dice and more!

+ ?randstats - Get a standard 6 * 4d6kh3 roll block.



Audio Commands:


+ ?setup - Used to start the audio deck ready for adding and playing tracks

+ ?addtrack - adds a track to the audio deck to play.


## Self-Hosting

### Creating a config file
- Create a new file called `config.json`
- add the following to the file:
```
{
"token": "YOUR TOKEN HERE",
"dev_ids": [YOUR DISCORD ID HERE,],
"shard_count": 1
}
```

## Self-Hosting - With docker-compose
### Getting started:
- NOTE: This assumes you already have [docker desktop](https://www.docker.com/products/docker-desktop) installed (For windows)
1. go to the `Innkeeper` folder and type `cmd` into the file path bar.
2. make sure you have made the [config file](https://github.com/ChillFish8/Innkeeper/blob/master/README.md#creating-a-config-file)
3. run `docker-compose build`
4. run `docker-compose up` to start the bot.

## Self-Hosting - Without docker-compose
### Requirements:
- [Discord.py - VOICE](https://pypi.org/project/discord.py/)
- [lxml](https://pypi.org/project/lxml/)
- [Java JDK 11](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html)
- [Lavalink.py](https://pypi.org/project/lavalink/)
- [Pandas](https://pypi.org/project/pandas/)
- [requests](https://pypi.org/project/requests/)
- [bs4](https://pypi.org/project/beautifulsoup4/)

### Getting started:
- NOTE: This assumes you are firmilliar with the python syntax and processes used and is written for a windows user.

1. go to the `Innkeeper` folder and type `cmd` into the file path bar.
2. run `python3 -m venv project-env`
3. run `project-env\Scripts\activate.bat`
4. run `pip install -r requirements.txt`
5. create a [config file](https://github.com/ChillFish8/Innkeeper/blob/master/README.md#creating-a-config-file)
6. run `py main.py` in the venv