Twitch-Chat-Bot-PHP

This is Izybot! A simple, yet powerful, Twitch Chat bot written in PHP, to help make streamers' life easier. It will assist you by replying any command you will configure it to do with a relevant message.

FEATURES

On the other hand, Bot was not written to be performing Moderator tasks, at least not yet :)

PREREQUISITES

1. PHP will be needed on your environment.
2. You will need a valid Twitch User that the bot will use to authenticate to Twitch. It can be the username of your real account, or another account that you will create to use exclusively from your bot. This account will be the username the rest Twitch users will see in your bot's responses. To login to IRC, you will need to obtain an Oath token from Twitch API first. You can obtain it at: https://twitchapps.com/tmi/

INSTALLATION

1. Download the zip from this repository, and extract its contents to a folder.
2. To install PHP on Windows, see Appendix.

CONFIGURATION

1. Go to the conf directory and copy the config.php.TEMPLATE file to a new file called: config.php.

2. Edit that file and fill in the information required. edit the fields according to the instructions.

3. Repeat with the channel_credentials.php.TEMPLATE file: copy it to channel_credentials.php and fill in your channel,username and oath token (obtained from the https://twitchapps.com/tmi/ site)

4. If you plan to use the Twitch API v5 capabilities, please check the additional instructions mentioned here.

5. Streamers with PHP knowledge who want to implement commands that include PHP code for maximum flexibility, can use the conf/admin_commands_nonsafe.cfg.TEMPLATE file. Copy this file to appdata/admin_commands_nonsafe.cfg and manually add commands that include PHP code (i.e. nonsafe), for producing dynamic output. As a security measure, PHP enabled commands can't be added via Twitch Chat like other regular admin commands.

STARTING THE BOT

to start the bot, open "cmd" from the folder of the bot and run:

php startIzyBot.php

OR, for Windows users, you can use the supplied batch file.

STARTING THE WEB INTERFACE

To access the Web interface, we will be using the PHP built-in web server. To start it, run the supplied batch file called: startHTTP_GUI.bat.

To access the Web interface of the Bot, open this link with your browser: http://127.0.0.1:33333/

To start both the IzyBot and the Web interface, use the batch file: startIzyBot_and_HTTP_GUI.bat.

SAMPLE PREVIEW PICS FROM THE WEB INTERFACE

Twitch Chat:

Polls:

ADMIN COMMANDS

Unless, you have defined otherwise in the conf/config.php, the bot supports the below administrator commands:

• messages the bot will reply when triggered by viewers' commands:

• Bot's administrators management:

• Periodic messages management:

• Polls:

• Quotes:

• Giveaways:

• Bets:

• VIPs:

USER COMMANDS

• Reserved commands that are already configured:

• Quotes:

• Polls:

• Giveaways:

• Loyalty Points:

• Bets:

COMMANDS STATISTICS

Izybot keeps track of all the registered commands being triggered, for you to have some insights on the popularity of your configured commands.

You can view these statistics from the web interface.

LOYALTY POINTS

Loyalty points is a virtual currency that is awarded to viewers, according to their presence in the channel. They can use this virtual currency on bets. To enable and configure it, see config.php.

PLUGINS

Plugins are developed on demand.

APPENDIX

Installing PHP on Windows:

• download the PHP x86 or x64 version according to your system architecture from: http://php.net/downloads.php.

• extract its contents in a folder under C:, lets say under folder C:\PHP.

• cp php.ini-production to php.ini.

• Using a text editor, edit the php.ini file and:

  1. search for line: ; On windows: ; extension_dir = "ext"

  uncomment the 2nd line, making it look:

  ; On windows: extension_dir = "ext"

  2. search for line: ; extension=php_mbstring.dll

  uncomment it, making it look:

  extension=php_mbstring.dll

  same for line:

  ;extension=php_sockets.dll

  uncomment it, making it look:

  extension=php_sockets.dll

  save the file.

• add the php binary to the %PATH% env variable:

  right click on "My computer" > Properties > Change Settings > Advanced > Environment Variables. on bottom panel its the System Variables for your Windows account. Locate the "Path" Variable, click Edit and Append in its value: ;C:\PHP; You just made the PHP binary avaiable to be located and executed from any folder of your system. Press OK to save your change, press OK to close the Dialog. You may need to restart your PC for changes to take effect.

• Installation of PHP is done!

3RD PARTY SOFTWARE USED

IzyBot uses below 3rd party open source software:

CHANGE LOG

Changes per commit, can be found at the Change Log page.