The forums bot repo

Forums Bot Installation instructions

Example Control Panel

Example Bot Instructions

Write a custom action for the bot

  1. Enter Api Keys The basic bot setup uses four different apis to take its actions.
  • catApi
  • deepai
  • Imgur
  • Twitter

Some actions depend on these apis. For example, the action that posts a picture of a cat won’t work without the cat Api key. To get it working you’ll have to sign up for the cat api and enter the key in the control panel.

To Get the Cat Api Key
  1. Go to the cat api website and sign up
    Sign Up Here on the Cat Api Website

  2. You will get an email with the key in it.

Deep AI API

The Deep AI API provides a text generator. The bot uses it to generate responses to posts.

To get the Deep AI API key,

  1. Go to (https://deepai.org/) and click the ‘sign up’ button in the upper right.

    Provide a valid email address.

    They will email you a verification link.

  2. Click the verification link.

    You will then be logged in to the Deep AI website.

  3. The code will be displayed on the Deep AI profile screen.

To get the Imgur api keys follow the 4 steps below

If you already have an account with Imgur, you can skip step 1.

  1. Register an Imgur account

    https://imgur.com/register

  2. Log in to Imgur

    https://imgur.com/signin/

  3. Register an application on Imgur

    Registering an application will get you the client_id and client_secret.

    Go to this link: https://api.imgur.com/oauth2/addclient

    You’ll need to log in with your imgur account if you haven’t already.

    To register the application type the application name.

    It can be anything. I suggest something like “saForumsBot”

    Select “OAuth 2 authorization without a callback URL”.

    Skip the Authorization callback url and website fields.

    Fill in the email and description fields.

    Do the captcha if there is one.

    Click submit.

    Copy and paste the client_id and client_secret into the fields on this screen.

    The client_id is used to upload images “anonymously”, meaning they don’t go into one of the named albums on the account.

    1. Click the “Get Token” button to use your Imgur username and password to get the access token

    The access token is used to upload images to albums.

Get Twitter API Keys

Twitter documentation 1: Application-only authentication and OAuth 2.0 Bearer Token

Twitter documentation 2: Application-only authentication and OAuth 2.0 Bearer Token

Follow these 6 steps to get the authentication codes that you need to make your bot work with Twitter.

  1. You need to sign up for twitter, if you haven’t already.

  2. Sign Up for Twitter Developer Account

    Then you need to sign up for a twitter developer account.

    After you sign up, you’ll need to verify your account by clicking a link that Twitter will email you.

    You’ll also have to provide a phone number.

  3. Create an App

    Go to the Twitter developer dashboard and create an app.

  4. Get the ‘Consumer Key’ and the Consumer Secret’ Click the ‘Details’ button for the app.

    Details Button

    Click on ‘Keys and Tokens’.

    Keys and Tokens Button

    Get the consumer key and consumer secret for the app.

    Key and Secret

    Copy and paste the consumer key and consumer secret into the fields on this page.

  5. You also need the bearer token

    To get the bearer token, I suggest you use the built in button in the bot control panel.

    You can also read through the twitter documentation to figure out how to get it.

    getting-twitter-oauth-bearer-token.html