A UDF to connect to IRC using TCP Functions, as well as perform actions once connected.
WANTED: Technical Writer able to create / maintain a helpfile (.chm) using the Autoit helpfile layout for an negotiated rate.
Originally created by Chip.
UDF Headers updated compared to old script.
Error and Parameter Handling updated compared to old script.
If you need to bypass the RFC compliance of this UDF, use _IRCRaw.
The majority of the old functions have been modified. It will break most, if not all, scripts using the old UDF.
These commands should work on every server following either RFC 1459 (legacy) or RFC 2812 (preferred).
IRC Chat Clients
Chatroom Integration for software
IRC Bots for Channel / Server Administration
IRC Bots for Games such as Hangman, Mafia, and WereWolf
Remote Administration without having to setup your own AutoIt server
Chips' Old UDF Topic:
While these downloads are more stable than the ones above, I do not have time to thoroughly test all functions and variable entries. If something doesn't work as expected or gives you an error please check @error and @extended variables then create a reply to this topic.
IRC.au3 Fixed : Updated Headers to UDF-spec (- instead of =)
_IRCGetMsg Fixed : Incorrect Return Value On Error
_IRCStripSpecial Added : Better documentation of Flags
_IRCMultiSendMsg Added : Better documentation of Flags
_IRCMultiSendMsg Fixed : Max Message Size based on https://forums.unrealircd.org/viewtopic.php?t=6811
Updated all files to consider themselves a standalone install by default
All Functions that didn't Return anything now return Number of bytes sent
Slight Performance Improvements by using Parameter Gating instead of Single Input Single Output
Example.au3 Fixed : Includes
Example.au3 Renamed: IRC_Example.au3
IRC.au3 Changed: Minor Performance Improvements
IRCConstants.au3 Updated: A Ton of New Constants added
IRCMultiSendMsg Added : Color Example
Increased TCP Timeout in all Examples
CUI.au3 Updated: Errors now output to Error Stream in Console
(C/G)UI.au3 Fixed : Userlists (FOR REAL THIS TIME) by being sure to get the current channel
Removed: Duplicate Constants File Include
Removed: Local Declaration inside of While loop for Performance
Updated: TCPTimeout Increased
Updated: $sTemp renamed $sStrip for Readibility
Example.au3 Updated: TCPTimeout Increased
GUI_Client.au3 Renamed: GUI.au3
_IRCStripSpecial Added : Parameter Checking
_IRCMultiSendMsg Added : Additional flags for Message Type (POSSIBLY SCRIPT BREAKING if using $_bTrim!)
Updated: Example to show new flags
Updated: Increase Max Message Size from 368 To 436
IRC.au3 Updated: All Documentation
Added : Now has a Constaznts file
_IRCConnnect Fixed : Now PROPERLY returns any errors
_IRCGetMsg Removed: $_iChars parameter since it gets one packet at a time and parsing is easier
_IRCReplyTo Fixed : Now properly returns username
_IRCStripSpecial Added : Now uses Constants File
All files are now in a single ZIP
Includes 2 basic IRC "clients", a CUI, and a GUI
Example.au3 Added : Improved Debugging
Updated: All Space Indents to Tab Idents
IRC.au3 Removed: Exception skipping @error = -1 in IRCGetMsg() as 188.8.131.52 fixed it
Example.au3 Added : Ping Timeout
Fixed : Userlist clipping of last user
IRC.au3 Fixed : IRCGetMsg() Hang
Example.au3 Fixed : User Lists
Fixed : Nickname now switches to backup nickname if first choice is already in use
IRC.au3 Added : UDF Index
Added : #include-once
Updated: All Functions updated to Single Entry, Single Exit
Updated: Now passes Au3Check on -q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7
Example.au3 Fixed : Ampersand channels causing a crash
Example.au3 Fixed : Nicks not updating on all channel lists when a user changed their nick
Fixed : Nicks not deleting on all channel lists when a user quits the network
Example.au3 Added : User lists
Added : Channel lists
Added : Bot keeps track of own nick
Added : Secondary nick in case first nick choice is in use.
Added : Extremely Minor performance improvements
_IRCConnect Added : Improved parameter checking
_IRCGetMsg Updated: Now only retrieves one packet by default (MAY be script breaking)
Example.au3 Added : Shutdown TCP on exit
Fixed : $Recipient now gets the actual Recipient instead of the 3rd message
Added : Now exits when told to quit.
IRC.au3 Added : Improved Error Reporting (Includes @extended on error)
_IRCDisconnect Added : Close Socket on Disconnect
_IRCStripSpecial Added : Improved Color Stripping
_IRCConnect Fixed : Checking if Mode was blank.
_IRCGetMsg Fixed : Spamming of 0 and incorrectly thinking there was an error.
IRC.au3 Fixed : All functions now return when errors are encountered instead of continuing
_IRCConnect Added : Now returns an error if optional password failed to send
_IRCGetMsg Added : Now returns an error if it failed to receive a custom amount of data
_IRCServerVersion Fixed : Capitalized "Version"
Example.au3 Fixed : Pings not ending with @CRLF
IRCExtras.au3 Added : _IRCStripSpecial(), Cleans special characters sometimes seen in IRC
Example.au3 Added : Checking for PrivMsg
Fixed : Infinite loop if you removed _IRCDisconnect
Updated: Bot now disconnects when receiving "!quit" instead of automatically
Discontinuted BETA UDF project.
IRCExtras.au3 Added : Additional IRC Functions
_IRChangeNick Renamed: _IRCSelfSetNick (SCRIPT BREAKING! Fix: Replace _IRCChangeNick with _IRCSelfSetNick)
_IRCGetMsg Fixed : Now no longer Splits Packets if Default option is used
_IRCChannelInvite Added : Invites a User to a Channel
_IRCChannelKick Added : Kick a User from a channel
_IRCJoinChannel Renamed: _IRCChannelJoin (SCRIPT BREAKING! Fix: Replace _IRCJoinChannel with _IRCChannelJoin)
_IRCMode Renamed: _IRCMultiMode (SCRIPT BREAKING! Fix: Replace _IRCMode with _IRCMultiMode)
_IRCOper Renamed: _IRCSelfOper (SCRIPT BREAKING! Fix: Replace _IRCOper with _IRCSelfOper)
_IRCPartChannel Renamed: _IRCChannelPart (SCRIPT BREAKING! Fix: Replace _IRCPartChannel with _IRCChannelPart)
_IRCPing Renamed: _IRCServerPing (SCRIPT BREAKING! Fix: Replace _IRCPing with _IRCServerPing)
_IRCPong Renamed: _IRCServerPong (SCRIPT BREAKING! Fix: Replace _IRCPong with _IRCServerPong)
_IRCSelfSetStatus Added : Sets you AFK and un-AFK
_IRCSendMessage Renamed: Renamed _IRCMultiSendMsg. (SCRIPT BREAKING Fix: Replace IRCSendMessage with IRCMultiSendMsg)
_IRCSendMessageRaw Renamed: Renamed _IRCRaw (SCRIPT BREAKING! Fix: Replace _IRCSendMessageRaw with _IRCRaw)
_IRCServerTime Added : Get time from a Server
_IRCServerVersion Added : Get Software Version from a Server
_IRCTopic Renamed: _IRCChannelTopic (SCRIPT BREAKING! Fix: Replace _IRCTopic with _IRCChannelTopic)
Improved Parameter detection in all Functions
Renamed Functions to show who/what they effect, MASSIVE Script Breaking. Sorry! :/
_IRCGetMsg Added : Use to get IRC Messages.
_IRCSetTopic Changed: Now named _IRCTopic (SCRIPT BREAKING! Fix: Replace _IRCSetTopic with _IRCTopic)
Changed: Can now be used to query topic and does so by default. Use "" to blank the topic
All functions now thoroughly check their parameters
Updated all functions to use @extended to some errors
Fixed @error returning 0 by starting all errors at 1 instead of 0
_IRCChangeMode Changed: Now named _IRCMode (SCRIPT BREAKING! Fix: Replace _IRCChangeMode with _IRCMode)
Changed: $_sMode is now OPTIONAL. Allowing the command to be used to Query current mode as well
_IRCConnect Fixed : Missing Colon Before $_sRealName. It should now allow Real Names with spaces
_IRCDisconnect Fixed : Issue with Blank Messages. Should now properly blank to Default
_IRCPing Changed: $_Server is now REQUIRED. (SCRIPT BREAKING! Fix: Specify a server as Parameter 2)
_IRCSendMessage Added : $_bTrim, Trims message if too long instead of breaking up the message, Default is true
_IRCSetTopic Added : Command for setting a Channel Topic
Updated Most Functions to include better error checking
Updated Most Channel Related Functions to check for valid channels
_IRCChangeMode Added : Optional parameters for channel modes
Changed: Parameter ordering Target is now before Mode (SCRIPT BREAKING! Fix: Swap Parameters 2 and 3)
_IRCConnect Changed: No longer exits the script on error, instead returns TCPConnect Error Code
_IRCJoinChannel Added : Now Supports Channel Passwords
_IRCOper Added : Command for IRC Server Operator Login
Updated All Functions to have UDF standard error codes
_IRCSendMessage Changed: Split Into _IRCSendMessage and _IRCSendMessageRaw (SCRIPT BREAKING! No Simple Fix Available)
Made variables comply to UDF Standards http://www.autoitscript.com/autoit3/udfs/UDF_Standards.htm
Removed MsgBoxes left over from old UDF
Updated / Uploaded IRC.au3
Known and Reported Bugs:
Message output only displays ANSI characters in CUI. (Can't Fix)
Freenode requires registration for part messages thus the part message in example doesn't show up (Can't fix)
Messages (e.g. PRIVMSG) are not forwarded?, when it contains umlauts/german mutations and when the message only contains a dot '.' (Unconfirmed)
Do NOT send a lot of messages at once. MOST networks will disconnect you. SOME networks will permanently ban you. A MINORITY will harshly retailiate.
Do NOT use the Sleep() function in your scripts. It prevents you from receiving any new data, can disconnect your from the network, and have other undesired consequences. Use the TimerInit() and TimerDiff() functions and possibly a message queue.
Possibly add in SSL functionality
Create More Functions for IRC commands
An entire IRC daemon written in AutoIt
Possibly Include Kips TCP UDF for ASync Port Listening in Example
Create Additional UDFs for extras such as CTCP, DCC, and Error Lookup
Experiment with having functions check for the reply and see if reliable.
To Be Decided