Skip to content

Commit

Permalink
Update README, enable in /r/YuGiOhMemes
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinlul committed May 7, 2023
1 parent d252bca commit d15880e
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,27 @@ A free and open-source Reddit bot for looking up cards and other useful informat
_Yu-Gi-Oh! Trading Card Game_ and _Official Card Game_. This is a port of the
[Discord bot](https://github.com/DawnbrandBots/bastion-bot).

## Getting started
[Announcement post on /r/yugioh](https://reddit.com/r/yugioh/comments/139u4wb/the_bastion_card_bot_is_now_available_on_this/).

## Usage

Summon [/u/BastionBotYuGiOh](https://reddit.com/u/BastionBotYuGiOh) in your submissions and comments on related subreddits
with doubled curly braces, e.g. `{{Tindangle Jhrelth}}`. This is a fuzzy search on OCG and TCG cards and their prereleases.
To summon Bastion elsewhere on Reddit, you can mention the bot user in your comments that contain curly brace search terms.
If [/u/BastionBotYuGiOh](https://reddit.com/u/BastionBotYuGiOh) is mentioned without any search terms, it will reply with
a short explanation about itself.

For bot safety, currently Bastion is tuned very conservatively to prevent bad behaviour,
so it will ignore any summons in replies to its comments,
there is a maximum of five card searches per submission or comment,
and it will comment a maximum of 10 times per submission, resetting when the program is restarted.

### Subreddits

- [/r/yugioh](https://reddit.com/r/yugioh)
- [/r/YuGiOhMemes](https://reddit.com/r/YuGiOhMemes)

## Getting started with development

Create a Python 3 [virtualenv](https://virtualenv.pypa.io) and install dependencies with
[pip-tools](https://github.com/jazzband/pip-tools):
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ services:
REDDIT_CLIENT_SECRET:
REDDIT_USERNAME: BastionBotYuGiOh
REDDIT_PASSWORD:
SUBREDDITS: yugioh
SUBREDDITS: yugioh+YuGiOhMemes
API_URL:
logging:
driver: "${DOCKER_LOG_DRIVER:-journald}"
Expand Down

0 comments on commit d15880e

Please sign in to comment.