magicaltavern

Organize your PnP Sessions.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Welcome to the magical tavern! Travelers and adventurers from far and wide gather here to discuss their next adventure or simply just meet over a good ol' pint of beer.

Okay so... what is this really?

magicaltavern is a Discord Bot written in Python that aims to organise D&D/PnP Discord Servers by providing handy tools. These tools include:

• Commands to find players for a PnP campaign
• A database integration to store interested members and automatically create a server cateory and roles for them to talk in
• Cool things

(back to top)

Built With

• py-cord
• sqlite3
• magicaltavern-api

(back to top)

Getting Started

Here are some instructions to self-host the bot. The bot currently has no public instances and does not support public instances either.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• python 3.11

• pip

  python -m ensurepip --upgrade

• A running, connectable instance of magicaltavern-api with at least one valid API key present.

Installation

1. Clone the repo

   git clone https://github.com/bitfl0wer/magicaltavern.git

2. (Optional) Create and activate a venv in the project directory
   Linux and macOS:

   python -m venv venv
   source ./venv/bin/activate

3. Install pip requirements

   pip install -r requirements.txt

4. Modify the files in the /config directory to fit your needs. In config/config.json, set the guilds attribute to the id(s) of the guilds you want the bot to operate in. Also, do not forget to create a role for dungeon masters on your server. Copy the ID of that role into config/roles.json as the role-dm attribute. Do the same thing for the admin role, and finally, put the user ID of the person that is supposed to be the bots' owner under id-owner. Also, do not forget to create a config/apikey.json file, and put in your magicaltavern-api key as a key: value pair with the name "token".

5. Start the bot. From the project source (magicaltavern/) type

   TOKEN=YOURBOTTOKENHERE python -m src.bot

(back to top)

Usage

Not done yet. WIP!
For more examples, please refer to the Documentation

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the AGPL-3.0 License.

(back to top)

Contact

Flori - @starflowerflori - florian@proweber.de

Project Link: https://github.com/bitfl0wer/magicaltavern

(back to top)

Acknowledgments

• Yama for helping me figure out sqlite stuff! <3

(back to top)