Twitch-Pybot

A twitch bot with a web interface


Keywords
bot, twitch, web, interface, python
License
GPL-3.0
Install
pip install Twitch-Pybot==0.1.4.post2

Documentation

Pybot

Build Status Build status Code Health pip

Pybot is an open source twitch chat bot.

image

Dependencies

python pybot.py -setup will take care of any missing depencencies.

Features

  • Web interface mobile friendly
  • Moderator control
  • Custom commands
  • Chat Filters
  • User points
  • Custom raffles
  • Quotes
  • Link grabbing

Installation

View full installation guide here

  • Install via pip
    • pip install twitch-pybot
  • Or pull repo and run
    • python setup.py build install
    • or for development python setup.py develop
  • Configure your bot via the web interface:
    • pybot -run
    • then go to 127.0.0.1:8888 in your browser
  • or use the command line:
    • pybot --config bot.name botusername
    • pybot --config bot.auth oauth:botauthentication
    • pybot --config twitch.channel channeltomoderate
  • You can view the full configure proccess here
  • Now you can start pybot with pybot -run

If you're running multiple bots you may want to set the compatibility setting to change all the command names. This adds a p to the beginning of every command so multiple bot commands dont clash. ex: !quote would now be !pquote

  • pybot --config compatibility.append_to_commands p

Usage

  • Commands
Command Parameters wiki link
!quotes Quotes
!permit
!linkgrabber
!linkban
!command add remove
!raffle cost:# name:"" trigger:!raffle minpoints:#
!leave

Contributing

  1. Fork it
  2. Check the issues tab and start working on a bug / enhancement
  3. Check the wiki to understand how pybot works if you're confused
  4. Submit a pull request :D

History

Pybot started out as more of a closed source project mostly because I was using some terrible coding practices like hardcoded passwords, etc. I've burned alot of that stuff so I could more eaisly add it to a public github repository so anyone could download, run, and modify the code. I will be modifying pybot to be able to run without any help from its web interface, making it easier for people to modify and test it.

License

GNU General public licence