8000 GitHub - tiltowait/botch: An advanced Discord bot for World of Darkness and Chronicles of Darkness.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

tiltowait/botch

Repository files navigation

Discord member count Patreon
MIT license Build status Code coverage

🤖 Botch

Botch is a Discord bot for World of Darkness and Chronicles of Darkness. It features a dice roller incorporating character traits (so you can type e.g. Strength + Brawl instead of a non-descriptive number), plus character stats tracking and, for premium supporters, image uploads.

🎲 Key features

  • Character sheet management via Discord application commands
  • Dice rolling with character sheet integration
  • Custom macros for common rolls
  • Willpower integration in rolls
  • Specialties and Custom Traits
  • Support for multiple WoD/CofD game systems
  • Premium features, including image uploads
  • Easy-to-use commands with natural syntax
  • Web-based character creation wizard
  • Comprehensive help menu

A comprehensive reference is available in the documentation.

⌨️ Example commands

/roll pool:dexterity+brawl difficulty:6
/mroll macro:hunt
/traits assign traits:Spelunking=3; Hot Air Ballooning=2

🕹️ Supported games

The bot is designed from the ground-up to be modular and extensible, allowing it to support multiple game lines. Currently supported games are:

🌒 World of Darkness

  • Vampire: The Masquerade
    • Both Final Nights and Dark Ages variants
    • Mortals, Ghouls, Vampires

🌑 Chronicles of Darkness

  • Vampire: The Requiem
    • Mortals and Vampires
  • Mummy: The Curse
    • Mummies

Due to the differences between the Storyteller and Storytelling systems, Botch is available in two flavors:

  • Botch, for World of Darkness (20th Anniversary Edition)
  • Beat, for Chronicles of Darkness (2E)

🔎 Looking for V5?

Check out Inconnu! It has many (and more!) of the same features.

🚀 Getting started

If you simply want to install either bot on your Discord server, you'll find installation links in the official documentation.

If you want to run the bot(s) locally, either for personal use or to contribute, read on.

✅ Requirements

  • Poetry
  • A registered Discord application
  • A MongoDB database
  • Emojis (default set found in the assets directory) installed in the server on which the bot will run. (At present, the Pycord library on which the bot is based does not support application emojis.)

⚙️ Environment variables

This repo contains three environment template files:

  • .env.template
  • .env.botch.template
  • .env.beat.template

Each contains documentation on the expected parameters. If you wish to do local testing, it's highly recommended to set the DEBUG variable.

🏃‍♂️ Running

  1. Install dependencies: poetry install
  2. Copy .env templates and supply variables:
    • .env.template.env
    • .env.botch.template.env.botch
    • .env.beat.template.env.beat
  3. Run the bot: poetry run botch or poetry run beat

🔮 Future plans

  • Web app
  • Convenience commands (such as a single command for Vampires to spend blood and heal)
  • More character templates

❓ Will it support X game line?

If X is a WoD20 or CofD 2E game, then: Maybe! It will depend on both personal and community interest.

About

An advanced Discord bot for World of Darkness and Chronicles of Darkness.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 2

  •  
  •  
0