laravel-twitch-irc
Twitch IRC Bot for laravel applications. This ships with the ability to create custom commands for your bot, with aliases, cooldowns, ability to connecto to multiple channels, etc.
Installation
You can install the package via composer:
composer require idevelopthings/laravel-twitch-irc
You can publish the config file with:
php artisan vendor:publish --tag="twitch-irc-config"
Usage
Publish the config file first, add to your .env:
TWITCH_BOT_USERNAME="your bots username"
TWITCH_BOT_ACCESS_TOKEN="your bots token"
You can obtain a token here: https://twitchapps.com/tmi/ When using the token, don't include the "oauth:" prefix.
Now we can create a command, the default location is app/Services/TwitchIrc/Commands, you can change this path in the config file
<?php
namespace App\Services\TwitchIrc\Commands;
use TwitchIrc\Bot\Command\BaseCommand;
class HelloWorldCommand extends BaseCommand
{
public function identifier(): string {
return "hello";
}
public function aliases(): array {
return [
'hi',
'hw',
'helloworld',
];
}
public function description(): string {
return "Responds with hello world.";
}
public function handle(): void {
$this->reply('Hello world.');
}
}
Now you can run "php artisan twitchbot" to start the bot. We can also use "php artisan twitchbot --stop" to stop the bot, which is useful for CI setups.
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.
10 Oct 6, 2022
12 Nov 19, 2022
5.8k Jan 1, 2023
2 Dec 15, 2022
7 Aug 28, 2022
272 Dec 22, 2022
994 Dec 29, 2022
951 Dec 25, 2022
474 Dec 31, 2022
89 Dec 27, 2022
24 Oct 4, 2022
1.2k Dec 28, 2022
464 Dec 28, 2022
173 Dec 30, 2022
6 May 3, 2022
2.4k Jan 6, 2023
5 Aug 15, 2022
7 Aug 21, 2022