Skip to content

oxy/Starbot

 
 

Repository files navigation

Starbot - An Open-Source Discord Bot Build Status Doc Status

Project Overview

Welcome to the Starbot project! This project is intended as a complete overhaul of CorpNewt's CorpBot.py project. The bot includes many features, silly and useful. A list of commands will be posted soon(tm), since the bot is under very active development.

Why should I use this bot?

Most people probably won't find the bot too useful in it's current state. It's in the very early stages and is composed of mostly developer and debug commands. Your welcome to run it if you'd like a toy to mess with though.

I've encountered an issue!

If you've found a problem with Starbot, please report it to the JIRA - it's free to make an account and helps us keep track of the problems in the bot!

How can I contribute?

Documentation

You may read the docs here

Making plugins

This is very easy! Go ahead and take the template and hack it up to your hearts content. This can be in your own repo, no need to clone the bot. Third party plugins are welcomed, and the bot doesn't need any modifications to run them. Plugins would go into the plugins folder.

Working on the core

If your feeling particularly adventurous you may find working on the core of the bot appealing. This would include all the very core features and APIs. Start by looking through the JIRA for open issues and reading through the documentation.

Installing and running Starbot

There may be a build of the StarBot Runtime available that works on your system if you're feeling adventurous.

  1. Make sure you have Python 3.5 or 3.6 installed, as well as git

  2. Run pip install discord.py pluginbase psutil pyparsing pyspeedtest tqdm in a terminal session to install the dependancies

  3. Run git clone https://github.com/1byte2bytes/Starbot.git to copy the code to your local system

  4. Run echo [my token here] > token.txt to create a file for the bots token

  5. Run ./run.sh to run the bot!

About

A rewrite of @corpnewt's CorpBot, designed to be completely modular and scalable.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.6%
  • Other 0.4%