readme added

master
const an teen 2021-12-06 03:02:43 -05:00
parent b4e6709f57
commit 878aa4a479
1 changed files with 45 additions and 0 deletions

45
README.md 100644
View File

@ -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.
<img src="https://notabug.org/acetone/ircabot/raw/master/screenshots/screenshot-1.png" alt="screenshot-1" style="zoom:50%;" />
<img src="https://notabug.org/acetone/ircabot/raw/master/screenshots/screenshot-2.png" style="zoom:50%;" />
##### 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`.