wildphp/wild-irc-bot

This package is abandoned and no longer maintained. No replacement package was suggested.

A modular IRC bot written in PHP

2.0.3 2016-04-29 14:04 UTC

Requires

• php: >=5.5.0
• myclabs/php-enum: ^1.4
• react/react: ^0.4
• wildphp/api: *

Requires (Dev)

• phpunit/phpunit: *

GPL-3.0

README

An advanced and scriptable PHP IRC bot.

It is designed to run off a local LAMP, WAMP, MAMP stack or just plain PHP installation. No web server is required, only a working PHP installation.

System requirements

In order to run WildPHP, we ask a few things from your system. Notably:

• A PHP version equal to or higher than 7.1.0.
• Command-line access to the system you plan on running WildPHP on.
  • WildPHP will NOT run inside a web server like Apache or Nginx. Do not ask for support for doing so.
• WildPHP has been tested to work on Linux and macOS. Other platforms are not supported and not guaranteed to work.
• For the best experience, we recommend either using the included systemd service (adjust it to your needs) or using tmux or screen to allow the bot to run in the background.

IRC Community & Support

If you need help or just want to idle in the IRC channel join us at #[e-mail]. Development discussion in #[e-mail].

Features and Functions

Right now this version of the bot is under heavy development, therefore the feature list is not definitive. We will update this once a reliable list becomes available.

Installation

To install the latest development build, you need Composer. Install WildPHP using the following commands:

$ git clone https://github.com/WildPHP/irc-bot
$ cd irc-bot
$ composer install

This will pull all Composer dependencies required to run the bot.

Please note that the bot may be unstable and that it might not even start. Please file a bug if you encounter an issue!

Configuration

Copy the example configuration file and edit it to suit your needs. Carefully read the comments.

$ cp config/config.sample.php config/config.php

Running the bot

While you can run the bot in a terminal it is best to run it in tmux or screen so that it can run in background.

$ php bin/wildphp.php

Alternatively, a systemd service is included. Edit it (carefully read the comments), then drop it in /etc/systemd/system/. Issue a systemctl daemon-reload afterwards and you should be able to use the service.

Contributors

You can see the full list of contributors in the GitHub repository.

Major & Past Major Contributors

• Super3
• Pogosheep
• Matejvelikonja
• Yoshi2889
• TimTims
• Amunak