SimpleIRCLib 1.2.2

SimpleIRCLib for Csharp

THIS LIBRARY IS STILL IN DEVELOPMENT

This library is designed to make communication through IRC easier to implement in your application. In comparison to other C# IRC libraries, this library also enables you to download using the DCC (XDCC) protocol, used by IRC.

It's main features are:

• Is simple to use.
• Is simple to implement
• It's lightweight
• Multiple channel support
• DCC Download support

NuGet

NuGet Package

Version

1.0.0:

• First release version

1.0.1:

• Fixed bug where leaving out debug callback would cause nullreferenceexception.

1.1.1:

• Added split in username | message
• Added quit/disconnect method
• removed usesless getters and setters
• fixed a few more less significant bugs

1.1.2:

• Removed getDownloadProgress, now download information can be retreived within the downloadStatusChangedCallback.
• Fixed error when you try to check if client is running before connecting to a server!

1.1.3:

• Code mostly reworked by following feedback from this post: reddit, such as:
• removed static fields
• removed inheriting classes
• text now being parsed through regex
• for receiving messages: a async task instead of a thread
• getDownloadProgress/downloadStatusChangedCallback has different way of operation (see below)
• addes status attribute for downloadstatus/progress

1.1.3 → 1.1.7:

• stability issues fixed

1.1.8:

• bugfixes, see commit description

1.1.9:

• bugfixes, see commit description

1.2.0

• Functionality update: Added method to retreive all the users in the current channel, as well as in other channels (but most of them will be hidden, so not very usefull ^^).

1.2.1

• Functionality update: Send Raw Messages (such as NICK, PRIVMSG etc.)
• Functionality update: Retreive Raw Data
• Functionality update: Send /msg using normal sendMessage() function
• Functionality update: Receive Notice message just like PRIVMSG (end user sees the source of the notice, for example: NickServ: bla bla bla)
• Code update: changed parsing messages a bit.

1.2.2

• Fixed issue with downloading filesizes larger than 4Gb.

Usage - Console Application

TIP: If you do not want a seperate DLL file with your program you can either copy the .cs files to your solution/project and manually change the Namespace, or you can use a program called ILMerge to combine a exe and dll together(not tested)!

This is a list with the most important methods available to you:

(void)        setupIrc(ip, port, username, password, channel, chatOutputCallback);
(void)        setDebugCallback(debugOutputCallback);
(void)        setRawOutput(setRawOutputCallback);
(string)      downloadDir;            //is now string, can be changed while running instance 
(void)        setDownloadStatus(downloadStatusCallback);
(void)        startClient();
(void)        stopClient();
(bool)        isClientRunning();
(bool)        stopXDCCDownload(); 
(object)      getDownloadProgress(string whichdownloaddetail) //see below
(void)        getUsersInCurrentChannel();
(void)        getUsersInDifferentChannel(string channel)
(void)        sendMessage(message);
(void)        sendRawMessage(message); 
(string)      newUsername;            //is now string field instead of method
(string)      newChannel;             //is now string field instead of method

Full Example

An (quick and dirty) example can be found here: Example

A winform example including video tutorial (v1.1.2): YouTube

Development

I will try to fix (significant) bugs as quick as possible, but due to my study taking a rollercoaster dive in a few days it might take a while before an actual update will appear. It is very barebone and does need some refinement. So, progress in development will come down to how much free time I have and how much of it I want to spend working on this library.

Todos

• Some DCC fixes, most things seem to work, but there are some odd cases where it might not work.
• More readable code (getting better)
• Renaming some stupidly named names

Disclaimer

This library is still in alpha stadium, many things might go wrong and therefore I am not responsible for whatever happens while you use this application.

License

MIT

Free Software, Hell Yeah!