botterino 0.1.1

Automate posting and hosting of rounds on /r/picturegame

Botterino

Botterino allows automation of hosting and posting of /r/picturegame coordinates rounds

When running botterino, if you win a round, your round will automatically be posted. It will reply with 'x' or '+correct' to any comments on your round automatically, with configurable tolerances.

---

Pre-requisites

0. All the files you interact with will live in the botterino-config folder which is located:
   1. windows: C:\Users\your username\botterino-config
   2. mac: /Users/<your username/botterino-config
   3. linux: ~/botterino-config These files are created for you the first time you run the bot
1. You must have Python installed on your computer
   1. If on windows it is best to install python from the microsoft store
2. Install the bot
   1. open a terminal or command prompt window and type the following command: pip install botterino
3. You must create a Reddit app and add authentication details in botterino-config/praw.ini; see sample-praw.ini for an example
   1. Give app any name you choose, such as 'botterino'
   2. Choose 'script' as app type
   3. Fill in 'redirect URI' with http://localhost:8080 (This is irrelevant but it's a required field)
   4. Once created, you'll have a 'secret', copy/paste that as client_secret in botterino-config/praw.ini
   5. You'll also have a less obvious client id, in the top left under the app name and the words 'personal use script' - copy/paste that into client_id in praw.ini
4. Fill out the rest of 'botterino-config/praw.ini' with your Reddit username/password as well as anything you want for user_agent

---

Usage

• add round(s) in botterino-config/rounds/rounds.yaml
• run with python -m botterino

Normal hosting

Rounds are kept in the 'rounds/rounds.yaml' file, see 'sample.yaml' for some examples

Steps

1. Add round(s) to 'botterino-config/rounds/rounds.yaml'
2. Open a terminal or command prompt and type python -m botterino
   1. Then all you have to do is win. Until you win, botterino will do nothing
   2. When you win, the top round in rounds.yaml is posted as soon as you are approved to host

Any new rounds added to 'botterino-config/rounds/rounds.yaml' while the app is running will automatically be added to the queue, no need to restart. Once a round is complete, it will be moved to 'botterino-config/rounds/archive.yaml'.

Live rounds

Botterino can be used on a round that is already live

This is useful for cases where

1. You post manually and decide you would like bot to host
2. Bot posts for you but crashes during hosting for some reason

Steps

1. Will use the top round in rounds.yaml
   1. url field should be omitted
2. Run with python -m botterino.failure

---

Misc

Update

Update this botterino with pip install --upgrade botterino

Colors on windows

This botterino uses colorful output. If you see strange output like this on windows then download Windows terminal from the Microsoft store.