bl0b

A discord bot to notify you about upcoming CTFs from CTFtime, and more.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contributors

About The Project

Built With

• golang
• discordgo
• sqlx

Getting Started

The recommended way of deploying bl0b on your server is using docker.

Prerequisites

• docker
• docker-compose

You can install docker and docker-compose with the help of the following links.

• docker: https://docs.docker.com/engine/install/
• docker-compose: https://docs.docker.com/compose/install/

Installation

Assuming you have already obtained a bot token from Discord, you need to follow these steps to get the bot up and running.

1. Clone the repo and cd into it.

git clone https://github.com/csivitu/bl0b.git
cd bl0b

2. Create a file called .env.prod to store all the secrets (environment variables). Here's a sample:

DG_TOKEN=Bot Asf1fa94jfn1n3nfeqafn4231.saf1F3.Asff_dadfVdaw1354f_d-0NsMLSofpg
DB_USER=root
DB_PASS=root
DB_IP=db
DB_PORT=3306

The configuration above will work directly if you replace the token Asf1fa94jfn1n3nfeqafn4231.saf1F3.Asff_dadfVdaw1354f_d-0NsMLSofpg with your Discord bot token.

Here are some things to note:

• The DG_TOKEN must have the prefix Bot . If the token you got from Discord does not begin with Bot , prepend it to the string as show in the sample above.
• If you're using docker-compose, make sure the DB_IP is db, i.e, the name of the service responsible for running the mysql database.
• The DB_USER must have permission to create a database, which is why it's easiest to set it to root if you're using the docker-compose way. If not, it is not recommended to set DB_USER to root, instead, create a database called bl0b and grant all permissions on that database to the DB_USER.

3. Run bl0b using docker-compose.

docker-compose up -d --build

Congratulations! You have bl0b up and running.

Usage

Once you add bl0b to your server, you can request the help menu using the following command:

bl0b help

Alternatively, you can tag the bot or send it a DM.

# Tagging the bot
@bl0b help

# DM-ing the bot
help

The help menu lists all the commands you can use!

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

You are requested to follow the contribution guidelines specified in CONTRIBUTING.md while contributing to the project 😄.

License

Distributed under the MIT License. See LICENSE for more information.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Rohan Mukherjee 💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!