From 8c6188d1a83b2d88a59207f2141cb54d60055760 Mon Sep 17 00:00:00 2001 From: SolidX Date: Sat, 6 Dec 2014 23:56:23 -0500 Subject: [PATCH] Update README file and Change log --- CHANGES | 40 ++++++++++++++++++++++---------------- README.md | 58 ++++++++++++++++++++++++++++--------------------------- 2 files changed, 53 insertions(+), 45 deletions(-) diff --git a/CHANGES b/CHANGES index b0ad87b..5b80980 100644 --- a/CHANGES +++ b/CHANGES @@ -1,17 +1,23 @@ -[IRCmasher v0.21] - -- added some commands/actions: - see http://ircmasher.latainski.de/docs/commands.htm for more -- modules/ - new modules: peak.php - obsolet modules: linux.php(joined basic.php) -- some little changes on the core. - - -[IRCmasher v0.20] -- Some bug fixes: Joining a channel should work now everytime, hello message too. -- [MODULE] admin.php: module for some administrative stuff. -- channel rejoin. -- added ACTIONS to a.php: the bot can do the '/me barfs on the floor' command ;D -- cleand up the code a bit. -- the rest I don't know anymore. +[IRCsmasher v1.0.0] +- Forked IRCmasher +- Refactored IRCmasher. + Removed deprecated function calls + Documented core functions + Added common IRC connection actions to functions.php + Removed unused functions and irrelevant comments + Refactored modules to be class based and have a unified interface. + Switched config file to .ini format + Consolidated message parsing logic +- Fixed bugs with Admin, Peak and AI modules. +- Added functionality to Admin module + Ability to have bot join channels + Ability to have the bot say something to all channels it is currently in +- Added modular Logging solutions + Console logging + HTML logging +- Added global configuration management + Tracking changes to bot nick + Tracking changes to channels the bot is currently in +- Made the bot compatible with PHP 5.5+ +- Added error exit codes +- Updated README diff --git a/README.md b/README.md index 8d7d184..fa81278 100644 --- a/README.md +++ b/README.md @@ -3,61 +3,63 @@ IRCsmasher A fork of the [IRCmasher](http://sourceforge.net/projects/ircmasher/) IRC bot project by by Ralf Oechsner and Volker Latainski. +The original intent of this bot was to create a lightweight, easy to deploy IRC bot that didn't rely on a database. However, it's always nice to have options, so feel free to extend this to use one. -Disclaimer ----------- - -Use this bot at your own risk. We don't guarantee it works all the time... or ever. Installation & Use ------------------ ###Webserver Drop the source files in to an accessible path on your web server and visit index.php. -You should protect this script with a password or something. See your web server's manual for more information! - +You should protect this script with a password or something otherwise anyone who visits will be able to launch your IRC bot. +See your web server's manual for more information! ###Command Line Alternatively, you can run this from the command-line (DOS-Prompt, Shell, ect.). This requires PHP with CLI-Support! (See [Using PHP from the command line](http://www.php.net/manual/en/features.commandline.php)) +(You may want to set `debug_output_html` to `Off` in the [config file](inc/config.ini) if you do this.) + Configuration ------------- -Edit the values in the [config file](inc/config.php). +Edit the values in the [config file](inc/config.ini). + Modules ------- You can extend the functionality of your IRCsmasher by adding modules to it's `modules` directory. -All modules placed in the directory are automatically loaded and run. +All modules placed in the directory are automatically loaded and run at run time. To create a new module see [modules/basic.php](modules/basic.php) as an example. + Commands -------- Below are some examples of commands you can run out of the box. -NOTE: It is highly recommended that you query the bot directly to perform admin tasks - but you can also perform them by messaging a channel the bot is in. +NOTE: It is highly recommended that you private message the bot directly to perform administrative tasks - but you can also perform them by messaging any channel the bot is in. ``` -// mute/unmute the bot... -mute $botpasswd $channel (mute the bot) -unmute $botpasswd $channel (unmute the bot) - -// Admin commands -giveop $botpw $channel $nick (give chan-op status) -takeop $botpw $channel $nick (take chan-op status) -give voice (voice a user) -dvoice $botpw $channel $nick (de-voice a user) -kick $botpw $channel $nick (kick a user from channel) -say $botpw $your_message_txt (let the bot talk) -go to bed $nick $botpw (disconnect) - -// Common triggers... -!time (the time...) -!date (the date...) -!uptime (returns the bot uptime) -!peak (returns the peak number of users and when it occurred for a given channel) +//AI module +!mute (mute AI module) +!unmute (unmute AI module) + +//Admin commands +giveop (give chan-op status) +takeop (take chan-op status) +give voice (voice a user) +dvoice (de-voice a user) +join (have bot join the specified channel) +kick (kick a user from channel) +say (Have the bot say something to a user or channel) +go to bed (shutdown the bot) + +//Common triggers... +!time (display the bot's current time) +!date (display the bot's current date) +!uptime (returns the bot's uptime) +!peak (returns the peak number of users and when it occurred for a given channel) ``` License @@ -67,4 +69,4 @@ License Bugs, Contact, Comments ----------------------- -Questions? Bugs? Suggestions or comments? Feel free to jump in! +Questions? Bugs? Suggestions or comments? Feel free to jump in and create issues or pull requests!