Giter Club home page Giter Club logo

krcg-bot's Introduction

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, write krcg followed by a card name. Partial inputs may yield several results: Partial Input Example

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"

krcg-bot's People

Contributors

lionel-panhaleux avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.