Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 2 KB

README.md

File metadata and controls

76 lines (48 loc) · 2 KB
Raw

ALBot and ALBotA

A python3 Discord bot used to run the Open Source Club's Discord server. The bot is using the Discord.py rewrite.

Features

Current features include:

  • Printing the "Hello World" code of different languages
  • Compiling code using judge0 api
  • Setting the playing text/randomizing from a file
  • Echoing a command
  • Orange/Blue type chant
  • Play music from YouTube in the voice channels
  • Assigning roles to members for different projects

Checkout the Issues tab and TODO.md for wanted features.

Getting started

These instructions are for getting the code to run and a bot in a discord server.

Prerequisites

You will need Python 3 to run the bot. (NOTE the bot is only tested on 3.6 and 3.7).

Then install the requirements using pip3.

pip3 install -r requirements.txt

Getting a Discord token and inviting bot

TODO

Setting up config

Create a file named config.py and add the following:

# Tokens
ALBOT_TOKEN = "Add Your Discord Token" # Required
GITHUB_TOKEN = "Add your GitHub Token" # Only if working with git integration

# Roles
OFFICER_ROLE = 000000000000000000

# Channels
MEME_CHANNEL    = 000000000000000000 
OFFICER_CHANNEL = 000000000000000000
LEADERBOARD     = 000000000000000000

Make sure to replace the values above with your own tokens and IDs. For more information on how to get IDs, please go to this tutorial.

Running the bot

Running the bot is as easy as

python3 ALBot.py

Contributing

Please read CONTRIBUTING.md for information about contributing to this projects.

License

This project is licensed under the MIT License - see the LICENSE for more details.

Credits