SimpleIRCLib 2.1.0

.NET Core 2.0 This package targets .NET Core 2.0. The package is compatible with this framework or higher. .NET Framework 4.5 This package targets .NET Framework 4.5. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package SimpleIRCLib --version 2.1.0                

                    
                

            
NuGet\Install-Package SimpleIRCLib -Version 2.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="SimpleIRCLib" Version="2.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add SimpleIRCLib --version 2.1.0                

                    
                

            
#r "nuget: SimpleIRCLib, 2.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install SimpleIRCLib as a Cake Addin
#addin nuget:?package=SimpleIRCLib&version=2.1.0

// Install SimpleIRCLib as a Cake Tool
#tool nuget:?package=SimpleIRCLib&version=2.1.0

SimpleIRCLib for Csharp

THIS LIBRARY IS STILL IN DEVELOPMENT STARTING AT V2.0.0 THIS LIBRARY IS NOT BACK-WARDS COMPATIBLE WITH PREVIOUS VERSIONS!

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.

1.2.3

  • Abort download only deletes file if it was actually downloading the file.(had issues where it would still delete even if the file was already done downloading)

1.2.4

  • Bug where some DCC SEND messages from bots were not detected & parsed properly.
  • Should support IPv6 now. (Not really tested).
  • Added function to check if download thread is still running.
  • Added some debug messages for debugging purposes.
  • Default download directory is now set to the same directory where the libary resides.
  • Added flag to check if an error occured of any kind within the library (doesn't tell what kind of error yet).

2.0.0

  • Rewritten IrcConnect class (now called IrcClient) to prevent Race conditions!
  • Added timeout warnings.
  • Added support for TLS/SSL
  • Added better error handeling using the error codes from RFC 1459 IRC Protocol
  • Added full support for receiving and sending to seperate channels
  • Added comments and changed names to fit C# code convention
  • Under the hood DCC fixes for more stability and error handeling when downloads go wrong
  • Changed Action based callback methods to Event handlers

2.1.0

  • Support for multiple .NET FrameWorks such as: .NET 4.5, .NET 4.6, .NET 4.7 & .NET CORE 2.0 & .NET CORE 2.1
  • Renamed a few properties.

Wiki

To get a better picture of the available methods and properties, go to this wiki: SimpleIRCLib Wiki

For a full WinForms example, go to: WinForm Example

For a simplified console example: Console Example

Tutorial

A winform example including video tutorial (v1.1.2) OLD - NOT SUPPORTED FOR v2.0.0: YouTube

-New v2.0.0 and up tutorial comming soon!

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!

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 is compatible.  netcoreapp2.1 is compatible.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 is compatible.  net461 was computed.  net462 was computed.  net463 was computed.  net47 is compatible.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • .NETCoreApp 2.0

    • No dependencies.

  • .NETCoreApp 2.1

    • No dependencies.

  • .NETFramework 4.5

    • No dependencies.

  • .NETFramework 4.6

    • No dependencies.

  • .NETFramework 4.7

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on SimpleIRCLib:

Repository Stars
erfg12/AOL_4.0_Emu
Emulating AOL 4.0
Version Downloads Last updated
2.2.1 1,775 10/28/2018
2.2.0 945 8/21/2018
2.1.2 846 8/21/2018
2.1.1 895 8/9/2018
2.1.0 1,012 6/21/2018
2.0.0 974 5/21/2018
1.2.4 973 1/28/2018
1.2.3 941 10/22/2017
1.2.2 1,031 10/5/2017
1.2.1 907 8/31/2017
1.2.0 1,085 1/7/2017
1.1.90 1,953 4/24/2016
1.1.8 1,510 4/24/2016
1.1.7 1,232 3/20/2016
1.1.6 1,286 3/20/2016
1.1.5 1,216 3/20/2016
1.1.4 1,243 3/20/2016
1.1.3.1 1,215 3/20/2016
1.1.3 1,309 3/19/2016
1.1.2 1,381 2/3/2016
1.1.1 1,307 2/2/2016
1.1.0 1,330 2/2/2016
1.0.2 1,266 2/1/2016
1.0.1 1,317 2/1/2016
1.0.0 1,323 2/1/2016

-- Now supports multiple frameworks such as: .net45 to .net47 & core 2.0 & core 2.1