Code Monkey home page Code Monkey logo

xbot's Introduction

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
  2. Deploy the bot with docker:
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:

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.

xbot's People

Contributors

ngn13 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.