Skip to content

lionel-panhaleux/krcg-bot

Repository files navigation

KRCG Discord Bot

PyPI version Validation Python version License Code Style

A discord bot to display V:tES cards, using the VEKN official card texts and KRCG rulings list.

Portions of the materials are the copyrights and trademarks of Paradox Interactive AB, and are used with permission. All rights reserved. For more information please visit white-wolf.com.

Dark Pack

Use it

This bot lets you retrieve cards official text, image and rulings: Bot Example

To call the bot, use slash commands: /card followed by a card name. Make sure you use the name autocompletion or you might not get the result you want. By default, the bot answers to you with a private message other members do not see. You can use the optional public paramater to your slash command to make the message visible for everyone in the channel.

It is online and free to use, install it on your Discord server.

Contribute

Contributions are welcome !

This bot is an offspring of the KRCG python package, so please refer to that repository for issues, discussions and contributions guidelines.

Hosting the bot

If you need to host a new version of the bot yourself, Python 3 is required, as well as an environment variable DISCORD_TOKEN. The token can be found on your Discord applications page.

The preferred way to run the bot is to use a python virtualenv:

/usr/bin/python3 -m venv venv
source venv/bin/activate
pip install krcg-bot
DISCORD_TOKEN=discord_token_of_your_bot
krcg-bot

A systemd unit can be used to configure the bot as a system service:

[Unit]
Description=krcg-bot
After=network-online.target

[Service]
Type=simple
Restart=always
WorkingDirectory=directory_where_krcg_is_installed
Environment=DISCORD_TOKEN=discord_token_of_your_bot
ExecStart=/bin/bash -c 'source venv/bin/activate && krcg-bot'

[Install]
WantedBy=multi-user.target

For development, the environment variable DISCORD_TOKEN can be provided by a personal .env file at the root of the krcg folder (ignored by git):

export DISCORD_TOKEN="discord_token_of_your_bot"

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published