https://github.com/lolei/ircbot
~Small~ bloated IRC bot 🤖
https://github.com/lolei/ircbot
docker hacktoberfest irc irc-bot kubernetes lmr python snoonet
Last synced: 2 months ago
JSON representation
~Small~ bloated IRC bot 🤖
- Host: GitHub
- URL: https://github.com/lolei/ircbot
- Owner: LoLei
- License: mit
- Created: 2020-04-14T18:37:07.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-03T22:38:16.000Z (over 1 year ago)
- Last Synced: 2025-02-08T02:29:04.498Z (4 months ago)
- Topics: docker, hacktoberfest, irc, irc-bot, kubernetes, lmr, python, snoonet
- Language: Python
- Homepage:
- Size: 698 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ircbot
~~Small~~ bloated IRC bot :robot:
Tested with [irc.snoonet.org](https://snoonet.org/)
## Features
* Automatic reconnect on connection loss
* Live injection of new responses at runtime
* Persistent user database
* Variable command prefix
* Easy new command addition
* As simple as creating a new subclass in `command.py`
* Many built-in commands
* Dynamic overly-long message splitting (Thanks primitve IRC protocol)
## Usage
Start it once on your server and use the commands within your IRC client.
### Server
```
./start.py
```
Configure settings (nick, server, channel, command prefix, etc.) in `.env`.
(This file isn't read but the environment variables must be set. Source them via e.g. `export $(cat .env | xargs)`.)
### Client
```
\help
\cmds
\about
\uptime
\date
\time
\sentiment |
\lastmessage
\words
\wordcloud
...
```
Only the last 1000 messages of users are stored. This parameter can be changed.
## Container
```sh
# Prepare
docker pull ghcr.io/lolei/ircbot:
# or
docker build -f Containerfile . -t ghcr.io/lolei/ircbot:
# Run
docker run --env-file .env.local -v $(pwd)/storage:/app/storage ghcr.io/lolei/ircbot:
```
## Deployment
The bot can either be run from the git repo itself, as a container with e.g. docker or docker-compose, or within Kubernetes.
It has been deployed for a long time (> 1 year) on a Raspberry Pi (therefore it works on ARM, which is made sure by some version requirements),
and it is currently deployed on Kubernetes. (See [`k8s/`](https://github.com/LoLei/ircbot/tree/master/k8s))
## Example User Word Cloud
