wildphp/wild-irc-bot

A modular IRC bot written in PHP

2.0.3 2016-04-29 14:04 UTC

README

Build Status Scrutinizer Code Quality Scrutinizer Code Coverage Latest Stable Version Latest Unstable Version Total Downloads

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.
  • SSH or other local access to the system you plan on running WildPHP on.
    • WildPHP does NOT run on services where you can host your website. Do not ask for support for doing so.
  • WildPHP has been tested to work on Linux and Windows. Other platforms are supported but not guaranteed to work.
  • For the best experience, we recommend 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 #wildphp@irc.freenode.net. Development discussion in #wildphp-dev@irc.freenode.net.

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.

Configuration

Copy the example configuration file and edit it to suit you. It uses the Neon syntax (borrowed from Nette Framework). It is similar to yaml but less strict and much faster to parse.

$ cp config.neon.sample config.neon

Running the bot

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

$ php wildphp.php

Contributors

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

Major & Past Major Contributors