An open API service indexing awesome lists of open source software.

https://github.com/mariogarridopt/mariobot

Discord Bot that manages the CROWD server
https://github.com/mariogarridopt/mariobot

bot discord discord-bot discord-py python

Last synced: 2 months ago
JSON representation

Discord Bot that manages the CROWD server

Awesome Lists containing this project

README

          

![MarioBot](img/mario-banner.jpg)

# MarioBot (Discord Bot) ![latest tag)](https://img.shields.io/github/v/tag/mariogarridopt/mariobot) [![Python Unit Test](https://github.com/mariogarridopt/mariobot/actions/workflows/unittest.yml/badge.svg)](https://github.com/mariogarridopt/mariobot/actions/workflows/unittest.yml)
> MarioBot is a mutipurpose Discord Bot built with [discord.py](https://github.com/Rapptz/discord.py)

## 📑 Requirements

1. Docker
2. A Discord Bot Token [Guide](https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot)

## 🚀 Getting Started

```sh
git clone https://github.com/mariogarridopt/mariobot.git
cd mariobot
```

Set up discord token
```sh
cp .env.example .env
# edit .env file
```

Start the bot
```sh
docker compose down
docker compose build --no-cache
docker compose up -d
```

Before submiting code please run the test suit:
```sh
docker exec -it mario-bot "make test"
```

## ⚙️ Configuration

⚠️ Please keep in mind that you should never commit or publicly distribute your token or API keys.⚠️

We have the file `.env` and all the configs should be there and never pushed.
**If you dont want to activate features that use this keys, you can leave them blank.**
```sh
BOT_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXX.XXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXX
```

## 🗨 Features & Commands

Rolls (commands)
- [X] **`roll`**

## 🤝 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 repository](https://github.com/mariogarridopt/mariobot/fork)
2. Clone your fork `git clone https://github.com//mariobot.git`
3. Create your feature branch `git checkout -b AmazingFeature`
4. Stage changes `git add .`
5. Commit your changes `git commit -m 'Added some AmazingFeature'`
6. Push to the branch `git push origin AmazingFeature`
7. Submit a pull request