Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fredimachado/IRCClient
Simple cross-platform console IRC Client written in C++
https://github.com/fredimachado/IRCClient
Last synced: 3 months ago
JSON representation
Simple cross-platform console IRC Client written in C++
- Host: GitHub
- URL: https://github.com/fredimachado/IRCClient
- Owner: fredimachado
- License: lgpl-3.0
- Created: 2011-09-30T02:26:28.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2018-10-12T02:27:17.000Z (over 6 years ago)
- Last Synced: 2024-08-01T03:29:08.778Z (6 months ago)
- Language: C++
- Homepage:
- Size: 63.5 KB
- Stars: 97
- Watchers: 10
- Forks: 32
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
- stars - fredimachado/IRCClient - platform console IRC Client written in C++ (HarmonyOS / Windows Manager)
README
## Simple cross-platform Console IRC Client
Windows | Linux | Azure (Linux/macOS)
:------------: | :------------: | :------------:
[](https://ci.appveyor.com/project/fredimachado/ircclient) | [](https://travis-ci.org/fredimachado/IRCClient) | [](https://dev.azure.com/FrediMachado/IRCClient/_build/latest?definitionId=1)
- It works on windows and linux (haven't tested on mac)
- Can be used as an IRC bot
- It has a simple hook system where you can do whatever you want when
receiving an IRC command.
- Example in Main.cpp
### Hooking IRC commands:
First create a function (name it whatever you want) with two arguments, an IRCMessage and a pointer to IRCClient:
```cpp
void onPrivMsg(IRCMessage message, IRCClient* client)
{
// Check who can "control" us
if (message.prefix.nick != "YourNick")
return;
// received text
std::string text = message.parameters.at(message.parameters.size() - 1);
if (text == "join #channel")
client->SendIRC("JOIN #channel");
if (text == "leave #channel")
client->SendIRC("PART #channel");
if (text == "quit now")
client->SendIRC("QUIT");
}
```
Then, after you create the IRCClient instance, you can hook it:
```cpp
IRCClient client;
// Hook PRIVMSG
client.HookIRCCommand("PRIVMSG", &onPrivMsg);
```
### Building on windows with Mingw:
- Edit Makefile
- Replace "-lpthread" with "-lws2_32" (no quotes) in LDFLAGS on line 3.
- Add ".exe" extension (no quotes) to the EXECUTABLE filename (line 8).
## Contribution
Just send a pull request! :)
## GNU LGPL
> IRCClient is free software; you can redistribute it and/or
> modify it under the terms of the GNU Lesser General Public
> License as published by the Free Software Foundation; either
> version 3.0 of the License, or any later version.
>
> This program is distributed in the hope that it will be useful,
> but WITHOUT ANY WARRANTY; without even the implied warranty of
> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
> Lesser General Public License for more details.
>
> http://www.gnu.org/licenses/lgpl.html