https://github.com/ngn13/xbot

Simple, configurable and modular MUC XMPP bot
https://github.com/ngn13/xbot

xmpp xmpp-bot xmpp-python

Last synced: 26 days ago
JSON representation

Simple, configurable and modular MUC XMPP bot

• Host: GitHub
• URL: https://github.com/ngn13/xbot
• Owner: ngn13
• License: gpl-3.0
• Created: 2024-02-07T15:47:34.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-05-13T18:40:12.000Z (6 months ago)
• Last Synced: 2024-09-26T12:21:18.144Z (about 1 month ago)
• Topics: xmpp, xmpp-bot, xmpp-python
• Language: Python
• Homepage:
• Size: 23.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# xbot | modular XMPP bot 

Simple, configurable and modular MUC XMPP bot written in python.

### 🗂 Modules

| Name       | Description                                          | Commands 

| ---------- | ---------------------------------------------------- | -------------------------------

| `general`  | Simple commands                                      | `help`, `echo`, `ping`, `info`

| `afk`      | Set & clear AFK status                               | `afk-set`, `afk-clear`

| `redirect` | Provides alternative privacy friendly frontend links | none

| `tor`      | Search for TOR relays, see network status etc.       | `tor-sum`, `tor-top`, `tor-search`

### 🚀 Install

1. Copy over the example configuration and modify it for your needs: [`config.json.example`](config.json.example)

2. Deploy the bot with docker:

```bash

docker run -d --restart=unless-stopped          \

           -v $PWD/config.json:/bot/config.json \

           ghcr.io/ngn13/xbot:latest 

```

### 🛠 Development

Start by cloning the repository and creating a virtual environment:

```bash

git clone https://github.com/ngn13/xbot.git

cd xbot && python3 -m venv venv

source venv/bin/activate.sh

```

When you are in the virtual environment, run the `requirements.sh` script to install all the requirements. 

You can extend the bot and more modules. To load your new module, add it to `modules/__init__.py` and to your configuration.