TwitchPHP

A chat self-bot built with ReactPHP for the official Twitch TV Internet Relay Chat (IRC) interface.

Before you start

Before you start using this Library, you need to know how PHP works, you need to know the language and you need to know how Event Loops and Promises work. This is a fundamental requirement before you start. Without this knowledge, you will only suffer.

FAQ

1. Can I run TwitchPHP on a webserver (e.g. Apache, nginx)?
   • No, TwitchPHP will only run in CLI. If you want to have an interface for your bot you can integrate react/http with your bot and run it through CLI.
2. PHP is running out of memory?
   • Try increase your memory limit using ini_set('memory_limit', '-1');.

Getting Started

Requirements

• PHP 7.4.13
  • Technically the library can run on any PHP7 version or higher, however, no support will be given for any version lower than 7.4.13.
  • Despite the description above, this library is being built with PHP8 support in mind. There will come a time where PHP7 is no longer supported.
• Composer

Windows and SSL

Unfortunately PHP on Windows does not have access to the Windows Certificate Store. This is an issue because TLS gets used and as such certificate verification gets applied (turning this off is not an option).

You will notice this issue by your script exiting immediately after one loop turn without any errors. Unfortunately there is for some reason no error or exception.

As such users of this library need to download a Certificate Authority extract from the cURL website.
The path to the caextract must be set in the php.ini for openssl.cafile.

Recommended Extensions

• The latest PHP version.
• One of ext-uv (preferred), ext-libev or evt-event for a faster, and more performant event loop.
• ext-mbstring if handling non-english characters.

Installing TwitchPHP

TwitchPHP is installed using Composer.

1. Run composer require VZGCoders/TwitchPHP. This will install the lastest release.
2. Include the Composer autoload file at the top of your main file:
   • include __DIR__.'/vendor/autoload.php';
3. Make a bot!

Configuration

1. Add the required "secret" and "nick" values.
2. Customize your commands and responses.

Basic Example

<?php
require 'vendor/autoload.php';

//$loop = React\EventLoop\Factory::create();
require 'secret.php'; //$secret
$options = array(
    //Required
    'secret' => $secret, // Client secret
    'nick' => 'ValZarGaming', // Twitch username
    'channels' => [
        'daathren', // Channel to join
        'valzargaming', // (Optional) Additional channels
    ],
    
    //Optional
    //'discord' => $discord, // Pass your own instance of DiscordPHP (https://github.com/discord-php/DiscordPHP)    
    //'discord_output' => true, // Output Twitch chat to a Discord server's channel
    //'guild_id' => '116927365652807686', //ID of the server
    //'channel_id' => '431415282129698866', //ID of the channel
    
    //'loop' => $loop, // Pass your own instance of $loop to share with other ReactPHP applications
    'socket_options' => [
        'dns' => '8.8.8.8', // Can change DNS provider
    ],
    'verbose' => true, // Additional output to console (useful for debugging TwitchPHP)
    'debug' => false, // Additional output to console (useful for debugging communications with Twitch)
    
    //Custom commands
    'commandsymbol' => [ // Process commands if a message starts with a prefix in this array
        '!',
        ';',
    ],
    'whitelist' => [ // Users who are allowed to use restricted functions
        'valzargaming',
        'daathren',
    ],
    'badwords' => [ // List of blacklisted words or phrases in their entirety; User will be immediately banned with reason 'badword' if spoken in chat
        'Buy followers, primes and viewers',
        'bigfollows . com',
    ],
    'responses' => [ // Whenever a message is sent matching a key and prefixed with a command symbol, reply with the defined value
        'ping' => 'Pong!',
        'github' => 'https://github.com/VZGCoders/TwitchPHP',
        'discord' => 'https://discord.gg/yXJVTQNh9e',
    ],
    'functions' => [ // Enabled functions usable by anyone
        'help', // Send a list of commands as a chat message
    ],
    'restricted_functions' => [ // Enabled functions usable only by whitelisted users
        'join', //Joins another user's channel
        'leave', //Leave the current user's channel
        'ban', // Ban someone from the channel, takes a username and an optional reason
    ],
    'private_functions' => [ // Enabled functions usable only by the bot owner sharing the same username as the bot
        'stop', //Kills the bot
        'php', //Outputs the current version of PHP as a message
    ],
);
//include 'commands.php';
//$options['commands'] => $commands; // Import your own Twitch/Commands object to add additional functions

$twitch = new Twitch\Twitch($options);
$twitch->run();
?>

Documentation

Raw documentation can be found in-line in the code.