Skip to content

aobolensk/walbot

Repository files navigation

Lint Test Nightly CodeQL

codecov

walbot

Discord bot written in Python*

* Bot has partial support for Telegram backend. See supported backends section

Supported backends

Requirements:

Operating systems:

  • Linux
  • macOS
  • Windows

Dependencies

Required
  • libmagic
    Windows:
    $ pip install python-magic-bin
    Debian/Ubuntu:
    $ sudo apt-get install libmagic-dev
    macOS:
    $ brew install libmagic
  • Python 3.9-3.12
Optional
  • ffmpeg - for built-in DiscordVideoQueue plugin

Quick start:

$ python -m pip install -r requirements.txt
$ python -m pip install -r requirements-extra.txt  # optional
$ python walbot.py start

or using Poetry

$ poetry install
$ python walbot.py start

Command line options overview:

$ python walbot.py start          # Start the bot
$ python walbot.py stop           # Stop the bot
$ python walbot.py restart        # Restart the bot
$ python walbot.py suspend        # Start dummy bot (useful for maintenance)
$ python walbot.py docs           # Generate commands documentation

# Start the bot and enable automatic update (requires starting from git repo)
$ python walbot.py autoupdate
$ python walbot.py start --autoupdate

# Run tests and tools
$ python walbot.py test           # Run walbot tests
$ python walbot.py patch          # Patch config files
$ python walbot.py mexplorer      # Run Markov model explorer

$ python walbot.py help           # Get help

Documentation

Patch tool docs: Read
Plugins tutorial: Read
FAQ: Read

Commands

Discord commands help: Read
Telegram commands help: Read

About

Discord bot written in Python

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •