You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Roxie Gibson 8f53c278b7 better youtube link 5 years ago
docs better youtube link 5 years ago
roxbot better youtube link 5 years ago
.gitignore Renamed config file to roxbot.conf, changed some links in the docs, redid the readme, moved requirements to build docs into another requirements.txt, 5 years ago
CHANGELOG.md added unicode emoji support to emote command. 5 years ago
LICENSE.md update license with email and improved docs file structure. 5 years ago
README.md updated the docs to be the readme from github and fixed some mistakes. 5 years ago
mkdocs.yml removed contributing link till i actually write that. 5 years ago
requirements.txt Renamed config file to roxbot.conf, changed some links in the docs, redid the readme, moved requirements to build docs into another requirements.txt, 5 years ago
roxbot.py updated about command, added it to the docs, and fixed a big with parsing the backup rate. 5 years ago
setup.py Renamed config file to roxbot.conf, changed some links in the docs, redid the readme, moved requirements to build docs into another requirements.txt, 5 years ago

README.md

Roxbot

Banner

Python MIT PRs Welcome

Roxbot: An inclusive modular multi-purpose Discord bot. Built with love (and discord.py) by Roxxers#7443.

Roxbot is designed to be provide many different services for users and modertors alike with a focus on customisability. Roxbot also has a focus on being inclusive and being fun for all kinds of people. Roxbot is a bot written by a queer woman with the lgbt community in mind.

Changelog - Docs - Command Docs

Quick Setup

Roxbot has only been tested on Linux machines so far so these instructions are written for Linux users.

Requirements:

Optional Requirements:

  • Imgur API client ID (for Reddit cog. Create a application to gain access to the Imgur API here)
  • ffmpeg (for Voice cog [music bot])
  • libopus (for Voice cog [music bot])

If you don’t meet the requirements for a cog, be sure to comment out that cog in the roxbot/__init__.py file.

  1. Clone Roxbot to your system

    $  git clone https://github.com/roxxers/roxbot.git
    $  cd roxbot/
    
  2. Create a venv for Roxbot

    $  python3 -m venv ./env
    $  source env/bin/activate      # For bash and zsh users
    $  source env/bin/activate.fish # For fish users
    
  3. Install Python dependencies

    $  python3 -m pip install -r requirements.txt
    
  4. Edit Roxbot’s config to add your bot accounts token (and imgur api token if you plan to use the Reddit cog) to the config, and also edit some other config settings. Then rename it so that Roxbot will be able to read it.

    $  nano roxbot/settings/roxbot_example.conf
    $  mv roxbot/settings/roxbot_example.conf roxbot/settings/roxbot.conf
    
  5. Run Roxbot and she should setup everything if you haven’t run her before.

    $  ./roxbot
    

Need Support?

If you want Roxbot support, a support Discord can be found by clicking the Discord banner at the top of the readme,

Support Me If you want/can

KoFi