# KRCG Discord Bot
[](https://badge.fury.io/py/krcg-bot)
[](https://github.com/lionel-panhaleux/krcg-bot/actions)
[](https://www.python.org/downloads/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/psf/black)
A discord bot to display V:tES cards, using
the VEKN [official card texts](http://www.vekn.net/card-lists) and
[KRCG](https://github.com/lionel-panhaleux/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](http://www.white-wolf.com).
## Use it
This bot lets you retrieve cards official text, image and rulings:
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](https://discordapp.com/oauth2/authorize?client_id=703921850270613505&scope=bot%20applications.commands).
## Contribute
**Contributions are welcome !**
This bot is an offspring of the [KRCG](https://github.com/lionel-panhaleux/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](https://www.python.org/downloads/) is required, as well as an
environment variable `DISCORD_TOKEN`.
The token can be found on your
[Discord applications page](https://discord.com/developers/applications).
The preferred way to run the bot is to use a python virtualenv:
```bash
/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](https://en.wikipedia.org/wiki/Systemd) unit can be used
to configure the bot as a system service:
```ini
[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):
```bash
export DISCORD_TOKEN="discord_token_of_your_bot"
```
Raw data
{
"_id": null,
"home_page": "http://github.com/lionel-panhaleux/krcg-bot",
"name": "krcg-bot",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "vampire vtes ccg discord bot",
"author": "lionelpx",
"author_email": "lionel.panhaleux@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/44/d0/3ec1f732428f88b9a80ef21a15568ae4496e694430de6576ea699fb29717/krcg-bot-4.0.tar.gz",
"platform": null,
"description": "# KRCG Discord Bot\n\n[](https://badge.fury.io/py/krcg-bot)\n[](https://github.com/lionel-panhaleux/krcg-bot/actions)\n[](https://www.python.org/downloads/)\n[](https://opensource.org/licenses/MIT)\n[](https://github.com/psf/black)\n\nA discord bot to display V:tES cards, using\nthe VEKN [official card texts](http://www.vekn.net/card-lists) and\n[KRCG](https://github.com/lionel-panhaleux/krcg) rulings list.\n\nPortions of the materials are the copyrights and trademarks of Paradox Interactive AB,\nand are used with permission. All rights reserved.\nFor more information please visit [white-wolf.com](http://www.white-wolf.com).\n\n\n\n## Use it\n\nThis bot lets you retrieve cards official text, image and rulings:\n\n\nTo call the bot, use slash commands: `/card` followed by a card name.\nMake sure you use the name autocompletion or you might not get the result you want.\nBy default, the bot answers to you with a private message other members do not see.\nYou can use the optional `public` paramater to your slash command to make the message\nvisible for everyone in the channel.\n\nIt is online and free to use,\n[install it on your Discord server](https://discordapp.com/oauth2/authorize?client_id=703921850270613505&scope=bot%20applications.commands).\n\n## Contribute\n\n**Contributions are welcome !**\n\nThis bot is an offspring of the [KRCG](https://github.com/lionel-panhaleux/krcg)\npython package, so please refer to that repository for issues, discussions\nand contributions guidelines.\n\n## Hosting the bot\n\nIf you need to host a new version of the bot yourself,\n[Python 3](https://www.python.org/downloads/) is required, as well as an\nenvironment variable `DISCORD_TOKEN`.\nThe token can be found on your\n[Discord applications page](https://discord.com/developers/applications).\n\nThe preferred way to run the bot is to use a python virtualenv:\n\n```bash\n/usr/bin/python3 -m venv venv\nsource venv/bin/activate\npip install krcg-bot\nDISCORD_TOKEN=discord_token_of_your_bot\nkrcg-bot\n```\n\nA [systemd](https://en.wikipedia.org/wiki/Systemd) unit can be used\nto configure the bot as a system service:\n\n```ini\n[Unit]\nDescription=krcg-bot\nAfter=network-online.target\n\n[Service]\nType=simple\nRestart=always\nWorkingDirectory=directory_where_krcg_is_installed\nEnvironment=DISCORD_TOKEN=discord_token_of_your_bot\nExecStart=/bin/bash -c 'source venv/bin/activate && krcg-bot'\n\n[Install]\nWantedBy=multi-user.target\n```\n\nFor development, the environment variable `DISCORD_TOKEN` can be provided\nby a personal `.env` file at the root of the krcg folder (ignored by git):\n\n```bash\nexport DISCORD_TOKEN=\"discord_token_of_your_bot\"\n```\n",
"bugtrack_url": null,
"license": "\"MIT\"",
"summary": "\"Discord bot for VTES cards\",",
"version": "4.0",
"project_urls": {
"Homepage": "http://github.com/lionel-panhaleux/krcg-bot"
},
"split_keywords": [
"vampire",
"vtes",
"ccg",
"discord",
"bot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b34c6dbc21f86900b645e033f8231e8e93831dbbf23ae292d4a59207ced8309",
"md5": "d74b02b63d0b584956dda6e2a60a8d01",
"sha256": "c66c84d74e2da298da74c100bab395cf1b72f263df1a87a08e46da513987f43b"
},
"downloads": -1,
"filename": "krcg_bot-4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d74b02b63d0b584956dda6e2a60a8d01",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10231,
"upload_time": "2023-08-11T17:15:13",
"upload_time_iso_8601": "2023-08-11T17:15:13.743091Z",
"url": "https://files.pythonhosted.org/packages/6b/34/c6dbc21f86900b645e033f8231e8e93831dbbf23ae292d4a59207ced8309/krcg_bot-4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "44d03ec1f732428f88b9a80ef21a15568ae4496e694430de6576ea699fb29717",
"md5": "c92bbdc354175aa26d8a6f071f8df85e",
"sha256": "8258f6f2214b61ee7466b5fe69679621692dc5d531a5a6cae30465298d8d640a"
},
"downloads": -1,
"filename": "krcg-bot-4.0.tar.gz",
"has_sig": false,
"md5_digest": "c92bbdc354175aa26d8a6f071f8df85e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10359,
"upload_time": "2023-08-11T17:15:14",
"upload_time_iso_8601": "2023-08-11T17:15:14.911252Z",
"url": "https://files.pythonhosted.org/packages/44/d0/3ec1f732428f88b9a80ef21a15568ae4496e694430de6576ea699fb29717/krcg-bot-4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-11 17:15:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lionel-panhaleux",
"github_project": "krcg-bot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "krcg-bot"
}
JSON
