diff --git a/README.md b/README.md index 833bf67c7d29dbe324429dcb496e0f40ed9b91ca..6b1787a1cb3349cc21b8c75d487168f662715549 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ -# KumikoBot -A discord bot that posts pictures of Oumae Kumiko from Hibike Euphonium +# SMAW (Show Me A Waifu) +A discord bot that posts pictures of requested waifus. +Extended from [KumikoBot](https://github.com/TheSmallBlue/KumikoBot) made by [TheSmallBlue](https://github.com/TheSmallBlue) + + +## Requirements ++ python-praw ++ python-discord + + +## How to use +Will respond to `show me a xxx` or `show me an xxx`, `xxx` being the name of a waifu in the csv. + +To get a list of the available waifus (from discord), send `show me an help` + + +## How to launch +1. `cp .env.example .env` +1. Fill in the .env with your reddit/discord credentials +1. Fill a `subreddits.csv` file, with lines of `waifus,subreddits` to serve +1. `python launch.py` diff --git a/launch.py b/launch.py index 3a0ba3887ae24e0a2b7f65658f4f19d72a14016a..5b9cac81bba0443ca08f0e290954b2b3404351ea 100644 --- a/launch.py +++ b/launch.py @@ -84,8 +84,8 @@ async def on_ready(): async def on_message(message): if message.author == client.user: return - if message.content.lower() == "show me a help": - mess = "Usage : ``show me a xxxx``\nCurrently, I can show :```" + if message.content.lower() == "show me an help": + mess = "Usage : ``show me a xxxx`` or ``show me an xxxx``\nCurrently, I can show :```" for entry in subreddits.values(): mess += entry.name + " with a picture from r/" + entry.subName + "\n" mess += "```"