Automate posting and hosting of rounds on /r/picturegame
Project description
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
- All the files you interact with will live in the botterino-config folder which is located:
- windows:
C:\Users\your username\botterino-config
- mac:
/Users/<your username/botterino-config
- linux:
~/botterino-config
These files are created for you the first time you run the bot
- windows:
- You must have Python installed on your computer
- If on windows it is best to install python from the microsoft store
- Install the bot
- open a terminal or command prompt window and type the following command:
pip install botterino
- open a terminal or command prompt window and type the following command:
- You must create a Reddit app and add authentication details in
botterino-config/praw.ini
; seesample-praw.ini
for an example- Give app any name you choose, such as 'botterino'
- Choose 'script' as app type
- Fill in 'redirect URI' with
http://localhost:8080
(This is irrelevant but it's a required field) - Once created, you'll have a 'secret', copy/paste that as
client_secret
in botterino-config/praw.ini - 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
- 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. See sample-rounds.yaml on botterino github page for information on round syntax
- run with
python -m botterino
Normal hosting
Rounds are kept in the 'rounds/rounds.yaml' file, see 'sample.yaml' for some examples
Steps
- Add round(s) to 'botterino-config/rounds/rounds.yaml'
- Open a terminal or command prompt and type
python -m botterino
- Then all you have to do is win. Until you win, botterino will do nothing
- 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
- You post manually and decide you would like bot to host
- Bot posts for you but crashes during hosting for some reason
Steps
- Will use the top round in rounds.yaml
url
field should be omitted
- Run with
python -m botterino.failure
Misc
Customize
Options such as correct message and incorrect message can be customized in botterino-config/config.ini
Update
Update this botterino with
pip install --upgrade botterino
Issues
- Bot does not run, crash message shows 403 error, everything in praw.ini looks correct
- try a different user agent
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file botterino-0.1.9.tar.gz
.
File metadata
- Download URL: botterino-0.1.9.tar.gz
- Upload date:
- Size: 11.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19c33460440e3dcac0c345a0bc49c19489c060933b6bbd595d21d18696891d69 |
|
MD5 | d1d8436c857f2b615b549f92f2601318 |
|
BLAKE2b-256 | 06f87c12a711ee0c0b63b24f54bb8e35232f6ae350b45c8d2ea9404bf35bda30 |
File details
Details for the file botterino-0.1.9-py3-none-any.whl
.
File metadata
- Download URL: botterino-0.1.9-py3-none-any.whl
- Upload date:
- Size: 12.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3ce409afc33d023ca671bce4e8d645bf986bc1f92ba2b938ee2eb8f01c239aa |
|
MD5 | e4f02a88158c800f93cce7e61b06006e |
|
BLAKE2b-256 | 26a94839215581b16911ba6140bf42e7d061e5882021605f27d30e0f0e8a4a94 |