GithubHelp home page GithubHelp logo

4ntil0l / qbot Goto Github PK

View Code? Open in Web Editor NEW

This project forked from arch-community/qbot

0.0 0.0 0.0 171 KB

QueryBot for Discord

License: GNU Affero General Public License v3.0

Ruby 68.97% Shell 0.11% Nix 30.93%

qbot's Introduction

            _/                 _/
    _/_/_/ _/_/_/     _/_/  _/_/_/_/
 _/    _/ _/    _/ _/    _/  _/
_/    _/ _/    _/ _/    _/  _/
 _/_/_/ _/_/_/     _/_/      _/_/
    _/
   _/

qbot is the Discord bot used by the unofficial Arch Linux community on Discord. Originally its only function was to manage support channels, but it has evolved to do much more.

Code structure:

  • bot.rb initializes the bot and loads modules from a list.
  • Each module in modules/*.rb contains support functions and bot commands.
  • The bot is configured in a file called config.yml. Copy config.yml.example to config.yml and add the correct settings for your instance or server.

Modules:

  • help provides a help command that displays information and usage for modules and commands.
  • queries helps manage support channels by managing a database of support questions.
  • snippets allows setting and posting configurable text snippets.
  • colors generates, manages, and assigns color roles.
  • arch contains commands for searching the Arch wiki, repositories, and AUR.
  • music is a fully functional music bot that uses youtube-dl to play audio from a URL.
  • figlet converts text to ASCII art.
  • util provides utility commands.
  • admin provides commands for bot administration.

Bot CLI:

  • rs or restart restarts the bot.
  • rc or reload-config reloads the config.
  • lm or load-module loads or reloads a module.
  • irb opens a REPL in the context of the bot. The CommandBot object is called @bot.
  • quit or stop stops the bot.

The bot uses an SQLite database to store support queries. On first run, open irb and run define_schema.

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.