parky's twitch bot

A free, minimal, lightweight, cross-platform, easily expandable Twitch IRC/API bot.

Features

• 🔌 Connect to Twitch IRC chat!
• 🔌 Connect to Twitch API! (change game, title)
• 🔊 Play custom sounds!
• ⚡ Make your own plugins with 5 lines of Python code! 🐍

Windows (8, 8.1, 10) 💾

Get @ Releases page

Linux 🐧

You may use the following live script to install this app on your machine.
Open a terminal and choose your favourite method below to install:

Using "wget"

sh -c "$(wget https://raw.githubusercontent.com/parklez/twitch-bot/master/scripts/install.sh -O -)"

Using "curl"

sh -c "$(curl -fsSL https://raw.githubusercontent.com/parklez/twitch-bot/master/scripts/install.sh)"

MacOS 🍎

See running locally below.

⚡ Included plugins

Plugin	Commands
Custom commands	!add <!command> < response >
Google's TTS	!tts, !< language >
Misc	!commands, !remind < something >
Pat & Love	!pat, !love < someone >
Plugin toggle	!plugin < disable/enable > <!command>
Sounds¹	!< file_name >
Twitch API²	!uptime, !game < optional >, !title/!status < optional >

[1]: Custom sounds go inside /sounds in mp3/wav formats.
[2]: One must fulfill API credentials inside the application settings.

💡 Simple plugin example

Copy the template below:

from parky_bot.settings import BOT
from parky_bot.models.message import Message

@BOT.decorator(commands=['!hello', '!hi']):
def my_custom_command(message): 
    BOT.send_message(f'Howdy {message.sender}!')

Save your my_custom_plugin.py under /plugins folder and you're ready to go!

Running locally

• Install Python 3.7 or newer
• Set up a virtual env (optional):

python -m venv .venv
# Unix
source .venv/bin/activate

# Windows
.venv/Scripts/Activate.ps1

• Install dependencies:

pip install -r requirements.txt

# MacOS Only:
pip install pyobjc tkmacosx

• Start the application:

python -m parky_bot.app
# Console only/No tkinter:
python -m parky_bot.app --console

Linting

This project uses autopep8 for linting. Subject to change.

Disclaimer

This project is under heavy development and subject to refactoring and code smells.

Contributors

• xKittieKat (Artist) deviantart.com

3rd party resources

• Volume icon icon-icons.com
• Shiba icon icon-icons.com
• Menu icon icons-icons.com
• Banner github.com/liyasthomas