mirror of
https://github.com/NNTmux/newznab-tmux.git
synced 2026-08-29 01:01:24 +00:00
89 lines
1.9 KiB
Plaintext
89 lines
1.9 KiB
Plaintext
/**
|
|
* $Id$
|
|
* $Revision$
|
|
* $Author$
|
|
* $Date$
|
|
*/
|
|
|
|
Net_SmartIRC
|
|
----------------
|
|
What is this?
|
|
Net_SmartIRC is a PHP class for communication with IRC networks conforming to
|
|
RFC 2812 -- an API that handles all IRC protocol messages. This class is
|
|
designed for creating IRC bots, chatting, and showing IRC-related info on
|
|
web pages.
|
|
|
|
official PEAR package page:
|
|
https://pear.php.net/package/Net_SmartIRC/
|
|
|
|
files included in SmartIRC
|
|
--------------------------
|
|
SmartIRC.php
|
|
The class itself.
|
|
|
|
FEATURES
|
|
A full list of features that SmartIRC includes
|
|
|
|
CHANGELOG
|
|
Listing of changes between all versions.
|
|
|
|
README
|
|
this file
|
|
|
|
LICENSE
|
|
The license of Net_SmartIRC.
|
|
|
|
CREDITS
|
|
Creditlist with people that work/help on Net_SmartIRC.
|
|
|
|
SmartIRC/
|
|
defines.php
|
|
Nessesary IRC related defines (IRC reply codes).
|
|
|
|
messagehandler.php
|
|
All defined messagehandler that SmartIRC currently uses for channelsynching
|
|
and some other API handling.
|
|
|
|
irccommands.php
|
|
All supported IRC commands (like join/part/kick/etc..)
|
|
|
|
docs/
|
|
DOCUMENTATION
|
|
Appendix to the HTML documention for developers.
|
|
|
|
HOWTO
|
|
Mini howto with detailed information, step by step.
|
|
|
|
HTML/
|
|
index.html
|
|
the full documenation of SmartIRC
|
|
|
|
examples/
|
|
example.php
|
|
An example of how you can use this class for a mini php bot.
|
|
|
|
example2.php
|
|
This example shows how to display the amount of users in a specific
|
|
IRC channel on your homepage.
|
|
|
|
example3.php
|
|
This bot echos the oplist if !ops is said on the channel.
|
|
|
|
example4.php
|
|
This bot checks all realnames of people that are on the channel
|
|
and displays the result.
|
|
|
|
example5.php
|
|
This bot can kicks users when !kick NICKNAME is said on the channel.
|
|
|
|
example6.php
|
|
This example shows how an onjoin greeting can be done with SmartIRC.
|
|
|
|
example7.php
|
|
This is an example how timers can be used and how to unregister them.
|
|
|
|
modules/
|
|
PingFix.php
|
|
This is a module you can load with your script to fix a connection keep-alive
|
|
issue until it gets fixed in the main class code.
|