A bot mainly for Twitch channels, but can be used for other purposes as well.
The bot supports writing custom commands using Lua, and saves it's states in an sqlite database.
The documentation for using the bot, creating commands, etc. is in the GitHub project wiki at https://github.com/lietu/twitch-quote-bot/wiki.
You can totally just download a .zip with an .exe in it and you don't need to worry about any other requirements.
- Go to twitch-bot releases page
- Download the latest .zip, extract to where-ever you wish
- Copy
settings.example.pytosettings.py, and edit it. - Check the Getting an OAuth token for Twitch chat IRC access -section for basic connectivity help. At least
USER,OAUTH_TOKENandCHANNEL_LISTshould be edited. - Run
twitchbot.exe - Profit!11eleven
- When updating, make sure you copy your
settings.pyandbot.sqlite.
- Python 2.6/2.7/3.3/3.4
- pip
- lua (5.1, 5.2 or luajit should work)
Python 3.1 and 3.2 don't work because of they broke backwards compatibility with unicode string literals. Thanks pals.
Optional:
- virtualenv
- virtualenvwrapper
How to install prerequisites in Ubuntu:
sudo apt-get install python-pip lua5.1 liblua5.1-dev
sudo pip install virtualenv virtualenvwrapper
And on RHEL/CentOS/Fedora/similar:
# Enable EPEL repos for python-pip, for CentOS 6
rpm -Uvh http://ftp.linux.ncsu.edu/pub/epel/6/i386/epel-release-6-8.noarch.rpm
yum -y install python-setuptools python-pip python-devel lua lua-devel gcc
pip install virtualenv virtualenvwrapper
For Qt frontend you'll also need to install PySide:
pip install PySide==1.2.2
- Get the code from GitHub.
- (Optional) Create virtualenv
source $(which virtualenvwrapper.sh) mkvirtualenv virtualenv # In the future, instead run: ```workon virtualenv``` - Install dependencies
pip install -r requirements.txt # You might have to prepend sudo if not using virtualenv - Copy settings.example.py to settings.py, and edit to needs
- Run the bot:
python start.py
You should visit these pages for help:
Getting rid of the bot itself is fairly easy, just stop it on the server you are running it on (press CTLR+C a few times)
However, you probably want access to your valued data as well. The bot's database is implemented using a very widely known engine called SQLite. There are plenty of tools you can use to take the bot.sqlite (default name) database and extract whatever data you want from it.
Quotes will probably be the only data actually useful outside of this bot, so there is a separate tool just for extracting them, dump_quotes.py.
Usage is fairly simple, call it and give it your channel's name (e.g. #lietu):
python dump_quotes.py "#lietu"
Notice the quotes in the example above, they are important to make sure your shell does not think you are writing a comment.
If you want to extract the quotes to a file, just redirect the output:
python dump_quotes.py "#lietu" > quotes.txt
Your data is important, which is why there's a bundled backup tool with the bot.
The tool handles:
- Keeping a given number of backups (e.g. 30)
- Optionally compressing the backups (with gzip)
The settings for the backups are also in settings.py and should be fairly easy to understand.
To schedule the backups you need to use your crontab or other scheduling system. E.g. on linux, run:
crontab -e
Check the path to your python executable (usually /usr/bin/python):
which python
And add the following line (replace /path/to/ and /usr/bin/python with the correct paths):
0 * * * * /usr/bin/python /path/to/backup.py > /dev/null
The development environment is built into the project via Vagrant.
To start using the development environment, install the following:
After these are installed, you can boot up the Vagrant virtual machine.
Open a terminal, and change to the root directory of the project, then tell Vagrant to boot up the machine:
vagrant up
Once the VM is up, you can connect to it over SSH.
You can open your favorite SSH client (e.g. [KiTTY](http://www.9bis
.net/kitty/) on Windows) by using the IP address 172.30.30.30.
Alternatively on Linux and Mac OS X you can connect to it with:
vagrant ssh
User and password are both: vagrant
To get to the development environment, you need to switch users:
sudo su - bot
Then activate the bot virtual environment:
workon bot
The source code is located on the virtual machine in /src, you might want to go there:
cd /src
When you have your Vagrant based development environment (or any other correctly set up environment) running, and you're in the root of the source folder you can run the unit tests via nose:
nosetests
If using the Vagrant VM in Windows, the shared folder causes some minor issues, you can work around that by telling nose to also include executable files in it's search for valid tests:
nosetests --exe
You can generate HTML code documentation from the source code with Sphinx by going to the docs/ folder and telling Sphinx to rebuild the HTML and run the doctest tests embedded in the source at the same time:
make html doctests
On the Vagrant VM be sure to have activated the development virtualenv and
run the command in /src/docs
The development environment VM configuration is managed with Salt Stack.
If you make changes within the salt/ -directory, you can tell vagrant to apply the changes via Salt:
vagrant provision
Also if you pull changes from GitHub, you should probably run that command before trying to continue using the VM.
To build the .exe for Windows use, you'll need a bit of extra help:
pip install cx_Freeze packaging
python setup.py build_exe
Icons designed by Freepik
This project has been made possible thanks to Cocreators and Lietu. You can help us continue our open source work by supporting us on Buy me a coffee.
