README is still a WIP.
All commands are case-insensitive.
- Send a random post from a specified subreddit. (IMPORTANT: This is probably broken due to Reddit's recent changes to their API and their authentication process)
- Example:
memes plz getdownmrpresident
- Write
memes plz <subreddit_name>
and the bot will send a random image/url/self post. - If
<subreddit_name>
is not specified, a random post from the specified default subreddit (determined byprocess.env.DEFAULT_SUBREDDIT
) is sent.
- Example:
Mention everybody in the chat.(Currently broken!)Write@all
to the group, and the bot will send a message which pings everybody in the chat.
- Create your own GroupMe bot.
- Make a fork, etc. of this repo and host it somewhere.
- Edit your GroupMe bot's callback URL to point to the URL where your fork is hosted (step 2).
- If using the Reddit features, you must have an authorized app created .
- Make sure your process.env variables point to your bot ID, group ID, etc. (see 'Configurations' below for more detail)
- Enjoy this not perfect / possibly not functional bot.
BOT_ID
: Bot ID, given by GroupMe.BOT_NAME
: Name of the bot, which you gave to GroupMe when creating the bot.GROUP_ID
: ID of the GroupMe group that this bot is added to.GROUPME_ACCESS_TOKEN
: Access token, given by GroupMe.
REDDIT_ID
: ID of your authorizied Reddit app.REDDIT_SECRET
: Secret of your authorizied Reddit app.REDDIT_REFRESH_TOKEN
: Reddit refresh token, which you must generate.- See here for an easy way to get a generated refresh token.
- (optional)
SHOULD_MENTION_ALL
: set totrue
to enable the@all
functionality. (by default, the bot assumes you don't want this feature). - (optional)
SHOULD_SEND_MEMES
: set totrue
to enable thememes plz
functionality. (by default, the bot assumes you don't want this feature). - (optional)
SEND_ONLY_IMAGE
: set totrue
if you want thememes plz
functionality to just send the image, rather than a link to the reddit post.