This version of the bot has been replaced with a go rewrite because the code became unmaintainable and even unrunnable on newer python versions. As it currently serves no real use, I'll be archiving this repo.
This is a code repository of the Twitch bot.
This bot uses UNIX sockets for IPC, so it may not work on Windows.
-
Create an app for your bot and authorize your bot account with it
- you can use this generator instead to get an oauth token to join the chat, however you won't be able to use the API.
-
Clone the repo, for example using
git clone https://github.com/Mm2PL/MmsUtilityBot -
Install requirements from
requirements.txtusing pip (pip install -r requirements.txt) -
Create necessary configuration files:
- Run
create_config_files.sh, - Edit
storage.jsonand changeyour lower case twitch usernameto your username.
The one you are looking for is lower case and doesn't contain any Asian characters. - Edit
twitch_api.json
- Run
-
Pick a database, for local testing you can use sqlite, for production you can use MariaDB,
- Path for sqlite is
sqlite:///PATH/TO/DB - For MariaDB or Mysql it is
mysql+pymysql://user:passowrd@host/db_name
- Path for sqlite is
-
Create a key pair for signing code. Make sure to store the private key somewhere safe, if you are running the bot in a vm or on an external host, don't send the key there You can use the included
generate_keys.pyscript to do this for you. Your keys should look a bit like this:-----BEGIN RSA PUBLIC KEY----- [all sorts of letters, numbers, slashes, pluses] -----END RSA PUBLIC KEY-----Save the public part as
code_sign_public.pemon the target machine, -
Start the bot
- For production
python util_bot.py --base-addr YOUR_DATABASE_ADDRESS - For debug
python util_bot.py --debug --base-addr YOUR_DATABASE_ADDRESS
NOTE: debug mode doesn't do much right now, it just uses
storage_debug.jsoninstead ofstorage.json - For production
-
Stop the bot using
Control+c, it is fine to press it again when the bot is not outputing anything, but still running -
Fine tune the config:
- Open
storage.jsonwith your favourite text editor - (optional) beatify the file somehow
- Find
"plugins": - Add desired plugins from the list
- Open
The main_stub.py is a version of the main file (util_bot.py) that doesn't require a connection to Twitch or the db.
Run python main_stub.py path/to/plugin to generate a human readable graph,
- yellow means it's a plugin,
- green that it is a plugin and was loaded before
Example graph of plugin_cancer:
plugins/plugin_cancer.py
* import asyncio
* import datetime
* import time
* import warnings
* import typing
* import typing
* import regex
* import PIL
* import utils
* import plugins.utils
* import helpers
* import plugins.helpers
- [yellow]import plugin_plugin_help
* import argparse
* import shlex
* import typing
* import typing
* import twitchirc
- [yellow]import plugin_plugin_manager
* import asyncio
* import traceback
* import typing
* import typing
* import twitchirc
* import twitchirc
* import plugins.models.channelsettings
* import plugins.models.channelsettings
- [yellow]import plugin_plugin_prefixes
* import shlex
* import typing
+ [green] import plugin_plugin_manager
* import twitchirc
+ [green] import plugin_plugin_manager
- [yellow] import plugin_hastebin
* import queue
* import typing
* import aiohttp
+ [green] import plugin_plugin_help
+ [green] import plugin_plugin_manager
* import twitchirc
- [yellow] import plugin_emotes
* import abc
* import typing
* import aiohttp
* import twitchirc
* import random
* import twitchirc
Run python main_stub.py path/to/plugin -H to generate a human readable graph and extract help
Example:
[snip, import graph]
- Section 0
- braillefy sensitivity_r: (2, 'braillefy sensitivity')
- braillefy sensitivity_g: (2, 'braillefy sensitivity')
- braillefy sensitivity_b: (2, 'braillefy sensitivity')
- braillefy sensitivity_a: (2, 'braillefy sensitivity')
- braillefy size_percent: (2, 'braillefy size')
- braillefy max_x: (2, 'braillefy size')
- braillefy pad_y: (2, 'braillefy size')
- plugin_cancer.py: (7, 'plugin_cancer')
- cancer: (7, 'plugin_cancer')
- ed: (7, '+ed')
- enterdungeon: (7, '+ed')
- +enterdungeon: (7, '+ed')
- Section 1
- hastebin: Create a hastebin of the message you provided.
- cookie: Add yourself to the list of people who will be reminded to eat cookies
- mb.pyramid: Make a pyramid out of an emote or text. Usage: pyramid <size> <text...>
- braillefy: Convert an image into braille. Usage: braillefy url:URL [+reverse] [sensitivity_(r|g|b|a):FLOAT] [size_percent:FLOAT] [max_x:INT (default 60)] [pad_y:INT (60)]
- Section 2
- braillefy url: URL pointing to image you want to convert.
- braillefy reverse: Should the output braille be reversed.
- braillefy sensitivity: Per-channel sensitivity of the converter. r(ed), g(reen), b(lue), a(lpha)
- braillefy size: Size of the image. Defaults: max_x = 60, pad_y = 60, size_percent=[undefined]. max_x, pad_y are in pixels.
- Section 7
- me: What do you need help with? Do you need one of these? https://en.wikipedia.org/wiki/List_of_suicide_crisis_lines
- plugin_cancer: Plugin dedicated to things that shouldn't be done (responding to messages other than commands, spamming).
- +ed: The `cancer` plugin sends a message containing +ed every five minutes to activate HuwoBot.
You can use the -m flag to make main_stub.py return machine readable exports in JSON format.