README

A simple and easy to use library for reading from and writing to the twitch irc live chats by partially using the observer design pattern.

With this library you can easily build your own twitch chatbot with PHP.

Requirements

PHP Version 8.1 or higher

How to use

You can install the library with composer:

composer require voniersa/twitch-live-chat

Functionalities

Firstly you have to create a new TwitchChatAdapter:

$adapter = new TwitchChatAdapter(new IrcConnector(), new ConnectionVerifier());

With this Adapter you can open a connection to twitch live chats by executing the openConnection() function. This function needs the parameters

UserName - the username of your account which you want to use as your chatbot
Password - the authentication code of your chatbot account. You can get your oauth code at https://www.twitchapps.com/tmi/
ChannelCollection - a collection of all channels where your chatbot should be active. A channel always needs a # in front of the channel name

You can open multiple connections with different users and channels.

$connection = $adapter->openConnection(
    UserName::fromString("xxxxxx"),
    Password::fromString("oauth:xxxxxx"),
    ChannelCollection::fromArray([
        ChannelName::fromString("#xxxxxx"),
        ChannelName::fromString("#xxxxxx")
    ])
);

To this connection you can now add as many observers as you want by executing the attach() function and later also the detach() function to remove an observer.

$exampleObserver = new ExampleObserver();
$connection->attach($exampleObserver);

$connection->detach($exampleObserver);

You have to write the Observers by your own. For that simply create a new class which implements the MessageObserver interface. You need to add the Method update() with the parameter of type Message.

class ExampleObserver implements MessageObserver
{
    public function update(Message $message): void
    {
        // do here what ever you want ...
    }
}

This update() method gets called everytime when a message is written to the live chats. Here you can define what should happen if a message appears.

To actually start reading the chat simply call the function readLiveChat() of the Adapter. You need to provide the connection and a time after how many seconds the reading process should stop. The function returns a MessageCollection which contains all messages that are written to the chat in that time period:

$adapter->readLiveChat($connection, 30);

With this library you cannot only read from specific live chats. You can also write something to the chat by simply call the writeMessage() function.

$adapter->writeMessage($connection, ChannelName::fromString("#xxxxxx"), "This message is send to the live chat!");

Example

In the demo.php you can find a simple code snippet, how you can use this library.

To run this example script, execute the following command:

make demo username="xxxxxx" password="oauth:xxxxxx" channel="#xxxxxx"

License

This library is released under the MIT Licence. See the bundled LICENSE file for details.

Author

Sascha Vonier (@voniersa)

voniersa / twitch-live-chat

Maintainers

Details