From 29d3e6f6392ef5387a73010c6169b3dd7db3337d Mon Sep 17 00:00:00 2001 From: Max Date: Sun, 28 Sep 2025 14:37:25 +0300 Subject: [PATCH 1/5] readmeeee --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/README.md b/README.md index 9cc0c33..0bc3e0c 100644 --- a/README.md +++ b/README.md @@ -1 +1,40 @@ # irc_hive + +Welcome to **irc_hive**, our C++ implementation of an IRC (Internet Relay Chat) system. IRC is a protocol for real-time text messaging over the internet, like chat rooms from the early web days. + +## What We Did + +We built a full IRC server in C++20 that manages clients, channels, and commands (JOIN, PART, PRIVMSG, etc.). Plus, a bot that connects to servers, joins channels, responds to commands, and filters bad words. The server works with **irssi** as an irc client. + +## SERVER FEATURES PLEASE ADD .... + +### Bot Features + +The bot shines with its smart word-filtering system – only channel operators can add/remove banned words, and it auto-kicks offenders to keep chats clean. + +We're proud of the robust reconnection logic with exponential backoff that handles network hiccups gracefully, and the extensible command system that lets you easily add new features. + +It also accepts invites to join new channels automatically. + +Available commands: +- `!ping` - Replies with "pong!" +- `!help` - Lists available commands +- `!filter ...` - Adds words to the channel filter (operators only) +- `!unfilter ...` - Removes words from the channel filter (operators only) +- `!listfilter` - Lists filtered words in the channel + +It's a powerful automation tool for IRC, especially with irssi integration. + +## Shared Responsibilities + +- [Joonas](https://github.com/jotuel): Server +- [Ville](https://github.com/v-kuu): Server +- [Max](https://github.com/oliynykmax): Bot + +## Getting Started + +Build: `make all` `make bot` + +Run server: `./ircserv [password]` + +Run bot: `./ircbot -s -p -c ` From 03dd2819f2a07006bc496c58d4c86f28bac23154 Mon Sep 17 00:00:00 2001 From: Max <85843900+oliynykmax@users.noreply.github.com> Date: Sun, 28 Sep 2025 15:48:35 +0300 Subject: [PATCH 2/5] Update README to streamline bot features section Removed redundant information about reconnection logic. --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 0bc3e0c..213d6ba 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,6 @@ We built a full IRC server in C++20 that manages clients, channels, and commands The bot shines with its smart word-filtering system – only channel operators can add/remove banned words, and it auto-kicks offenders to keep chats clean. -We're proud of the robust reconnection logic with exponential backoff that handles network hiccups gracefully, and the extensible command system that lets you easily add new features. - It also accepts invites to join new channels automatically. Available commands: From 6c201db9b9bfa4eab49305c16094eaae46c3e109 Mon Sep 17 00:00:00 2001 From: Max <85843900+oliynykmax@users.noreply.github.com> Date: Sun, 28 Sep 2025 15:51:37 +0300 Subject: [PATCH 3/5] Revise README for clarity and feature updates Updated README to clarify bot features and improve wording. --- README.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 213d6ba..60562cf 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,13 @@ # irc_hive -Welcome to **irc_hive**, our C++ implementation of an IRC (Internet Relay Chat) system. IRC is a protocol for real-time text messaging over the internet, like chat rooms from the early web days. +Welcome to **irc_hive**, our C++ implementation of an Internet Relay Chat system. IRC is a protocol for real-time text messaging over the internet, like chat rooms from the early web days. ## What We Did -We built a full IRC server in C++20 that manages clients, channels, and commands (JOIN, PART, PRIVMSG, etc.). Plus, a bot that connects to servers, joins channels, responds to commands, and filters bad words. The server works with **irssi** as an irc client. +We built an IRC server in C++20 that manages clients, channels, and commands (JOIN, PART, PRIVMSG, etc.). Plus, a bot that connects to servers, joins channels, responds to commands, and kicks users for writing forbidden words. The server works with **irssi** as an IRC client. ## SERVER FEATURES PLEASE ADD .... -### Bot Features - -The bot shines with its smart word-filtering system – only channel operators can add/remove banned words, and it auto-kicks offenders to keep chats clean. - -It also accepts invites to join new channels automatically. - Available commands: - `!ping` - Replies with "pong!" - `!help` - Lists available commands @@ -21,8 +15,6 @@ Available commands: - `!unfilter ...` - Removes words from the channel filter (operators only) - `!listfilter` - Lists filtered words in the channel -It's a powerful automation tool for IRC, especially with irssi integration. - ## Shared Responsibilities - [Joonas](https://github.com/jotuel): Server From cecfd18a4484697015b0517953d84328b563e45a Mon Sep 17 00:00:00 2001 From: Max <85843900+oliynykmax@users.noreply.github.com> Date: Sun, 28 Sep 2025 15:52:33 +0300 Subject: [PATCH 4/5] Remove placeholder for server features in README Removed placeholder for server features section. --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 60562cf..e67d33e 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,6 @@ Welcome to **irc_hive**, our C++ implementation of an Internet Relay Chat system We built an IRC server in C++20 that manages clients, channels, and commands (JOIN, PART, PRIVMSG, etc.). Plus, a bot that connects to servers, joins channels, responds to commands, and kicks users for writing forbidden words. The server works with **irssi** as an IRC client. -## SERVER FEATURES PLEASE ADD .... - Available commands: - `!ping` - Replies with "pong!" - `!help` - Lists available commands From 24981dbc68f6d4f19cff7577c5d30989b57cea05 Mon Sep 17 00:00:00 2001 From: Max <85843900+oliynykmax@users.noreply.github.com> Date: Sun, 28 Sep 2025 15:53:39 +0300 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e67d33e..bd09e84 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Welcome to **irc_hive**, our C++ implementation of an Internet Relay Chat system We built an IRC server in C++20 that manages clients, channels, and commands (JOIN, PART, PRIVMSG, etc.). Plus, a bot that connects to servers, joins channels, responds to commands, and kicks users for writing forbidden words. The server works with **irssi** as an IRC client. -Available commands: +Available bot commands, the bot can join the channel if you `/invite ` or mention the channel after -c option when launching bot: - `!ping` - Replies with "pong!" - `!help` - Lists available commands - `!filter ...` - Adds words to the channel filter (operators only)