From 878aa4a4799b8cd026760f7ee96e5c57c3d5f96b Mon Sep 17 00:00:00 2001 From: acetone Date: Mon, 6 Dec 2021 03:02:43 -0500 Subject: [PATCH] readme added --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0c3f190 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# IRCaBot +An undemanding IRC logger with a functional web interface. + +##### User futures + +- The web interface displays the current online for each chat, with nicknames highlighted in the log; +- Search with regular expressions; +- To get the log as plain text, you need to substitute the `.txt` to the link; +- To hide the message in the log, you can put a dot at the beginning (message will be displayed as "Blinded message"); +- Connection status to the servers is displayed in real time (green check mark or red cross). This allows you to judge whether the log is up to date. + +screenshot-1 + + + +##### Admin futures + +- Unlimited number of servers and chat rooms; +- Ability to use one nickname for all connections, or unique for each server; +- Nickname authorization support via NickServ; +- Customizable triggers for issuing information by bot in chat; +- Low system resource consumption: connecting to two servers and active use of the web interface requires ~10MB. + +#### First start (Debian/Ubuntu/etc) + +``` +# Qt5 C++ framework dependencies: +sudo apt install qt5-default + +# Create a configuration file template: +./ircabot --example ./config.conf + +# Edit config.conf for your case. + +# Start ircabot with new configuration file: +./ircabot --config ./config.conf +``` + +##### Install + +- Edit `systemd/ircabot.service`; +- Copy service file to `/lib/systemd/system/`; +- Run ircabot: `sudo systemctl start ircabot.service`; +- Enable (for autorun at system startup): `sudo systemctl enable ircabot.service`. +