dhjw / php-freenode-irc-bot Goto Github PK

A simple but powerful IRC bot written in PHP. Supports Libera, Rizon, GameSurge, Freenode and other networks.

• Install PHP with pcntl, cURL, mbstring, XML and JSON support, e.g. on Ubuntu sudo apt install php php-curl php-mbstring php-xml php-json
• Clone this repository. git clone https://github.com/dhjw/php-freenode-irc-bot or just download bot.php and settings-example.php
• Copy settings-example.php to settings-<instance>.php
• Create an account for the bot to authenticate. See /msg nickserv help register (Freenode, Rizon) or /msg authserv help register (GameSurge), or just use your existing user credentials
• Install pastebinit for help text (recommended) sudo apt install pastebinit or find a binary here
• Get a bitly token for short URLs (recommended)
• Edit the settings-<instance>.php file to contain your settings, username and password
• Run the bot with php bot.php <instance> or php bot.php <instance> test for test mode. On Linux it is recommended to run the bot in screen so closing the terminal won't kill the bot
• For Freenode admin op commands give the bot account access with ChanServ for your channel /msg chanserv flags ##example botuser +ort

• Create a project at console.cloud.google.com
• Under APIs and Services enable YouTube Data API v3
• "Where will you be calling the API from?" CLI Tool
• Under Credentials create an API key
• Add the API key to the $youtube_api_key variable in settings-<instance>.php
• Usage is free for thousands of queries per day

You can set up custom triggers and loop processes in settings-<instance>.php files directly or create plugin .php files and include them from there. Custom triggers are overridden by admin triggers and override global triggers, which you should probably avoid. See bot !help for a list of active triggers.

Examples of custom triggers:

// custom triggers (trigger in channel or pm will cause specific string to be output to channel or pm or a custom function to execute)
// array of arrays [ trigger, string to output (or function:name), respond via PM true or false (default true. if false always posts to channel), help text ]
// with custom function
// - $args holds all arguments sent with the trigger in a trimmed string
// - with PM true $target global holds the target whether channel or user, with PM false $target always holds channel, respond with e.g. send("PRIVMSG $target :<text>\n");
$custom_triggers[]=['!rules-example', 'Read the channel rules at https://example.com', true, '!rules-example - Read the channel rules'];
$custom_triggers[]=['!func-example', 'function:example_words', true, '!func-example - Output a random word'];

function example_words(){
	global $target,$args;
	echo "!func-example / example_words() called by $target. args=$args\n";
	$words=['quick','brown','fox','jumps','over','lazy','dog'];
	$out=$words[rand(0,count($words)-1)];
	send("PRIVMSG $target :$out\n");
}

Examples of custom loop functions:

register_loop_function('custom_loop_example');
function custom_loop_example(){
	global $data,$time,$channel;
	echo "[custom loop] time=$time data=$data\n";
}

Example of including a plugin file containing triggers, functions and/or loop functions:

include('plugins/example.php');

Hit up dw1 on Libera or Rizon with any questions or bugs.

Do whatever you want with it.