Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/the-programmers-hangout/rafflebot
[Fork] from https://github.com/Abzylicious/RaffleBot RaffleBot is a discord bot built originally for The Programmer's Hangout that focuses on managing giveaways.
https://github.com/the-programmers-hangout/rafflebot
discord discord-bot discordkt kotlin the-programmers-hangout tph
Last synced: about 1 month ago
JSON representation
[Fork] from https://github.com/Abzylicious/RaffleBot RaffleBot is a discord bot built originally for The Programmer's Hangout that focuses on managing giveaways.
- Host: GitHub
- URL: https://github.com/the-programmers-hangout/rafflebot
- Owner: the-programmers-hangout
- License: mit
- Created: 2020-05-17T19:25:14.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-10-12T21:00:43.000Z (over 2 years ago)
- Last Synced: 2024-11-18T23:47:15.110Z (3 months ago)
- Topics: discord, discord-bot, discordkt, kotlin, the-programmers-hangout, tph
- Language: Kotlin
- Homepage:
- Size: 179 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RaffleBot 🎉
RaffleBot is a discord bot built originally for [The Programmer's Hangout](https://github.com/the-programmers-hangout) that focuses on managing giveaways.
This bot might be useful for all kinds of discord servers though.
Join us at https://discord.gg/programming
## Required Permissions
- View Channels
- Send Messages
- Read Message History
- Use External Emojis
- Add Reactions
## Features
While **RaffleBot 1.0.0** focuses on essential functionality, there are many more features to come in the future. Currently the following features are available:
- [x] Convert an existing message or embed to tracked giveaway
- [ ] Create new tracked giveaway as message or embed
- [ ] Create a timed giveaway
- [ ] Add a timer to a given giveaway
- [ ] Create a new giveaway with a timer
- [ ] A giveaway automatically ends after its timer has expired
- [ ] Persist timed giveaways (timed giveaways are not affected by bot downtimes & host machine reboots)
- [ ] RaffleBot can access any guild channel for its commands
- [x] Assign a custom emoji to react to per giveaway (the **default** for this is 🎉)
- [x] Manually end a given giveaway and draw `X` winners (the **default** for this is `1`)
- [x] A giveaway does not end if there are no winners available (no one except the bot reacted to a giveaway)
- [x] A giveaway does not end if there are not enough participants (you want to draw more winners than there are participants)
- [x] A giveaway is automatically removed from the giveaway list after it ends
- [x] Remove tracked giveaways
- [x] Remove all tracked giveaways
- [ ] RaffleBot removes its own reaction from a tracked message after its respective giveaway either ended or is removed from the giveaway list
- [ ] Clean up the giveaway list (automatically remove all entries of non-available giveaways (eg. the respective message was deleted))
- [x] A permission system protects RaffleBot to be abused by your members
- [x] Command invocations are logged (given a configured logging channel)
- [x] Multi Guild support
- [x] A conversation simplifies the initial guild configuration
- [x] Each guild can configure its own bot prefix
- [x] Each guild can configure its own default reaction for creating giveaways (this may either be a `unicode emote` or a `guild specific emote`)
- [x] Each guild can configure its respective logging channel
- [x] Each guild can configure RaffleBots permission system to work with different `Staff` and `Admin` roles
- [x] Dockerize the bot easily via the provided **Dockerfile** and **docker-compose.yml** file
## Commands
Refer to [commands.md](commands.md) for a general list and explanation of all available commands. To learn about commands during runtime, use the `help` command!
## Getting Started ⚙️
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Requirements
- Java
- Docker
- Docker-Compose (compatible with docker-compose version 3.8)
Get the Docker version you need [here](https://hub.docker.com/search?q=docker&type=edition&offering=community)!
### Setup
Since this bot has a **docker-compose.yml** file and is hosted on [DockerHub](https://hub.docker.com/r/theprogrammershangout/rafflebot), all you need to start your own version of RaffleBot locally is to `clone` this repository and set up the **.env** file.
The **.env** file is used to configure the bot token and owner id, in the following format:
```
BOT_TOKEN=
BOT_OWNER=
```
#### For **Linux** and **Mac** run
```console
$ cp .env.example .env
```
#### For **Windows** run
```powershell
> Copy-Item .env.example .env
```
Edit the **.env** file with your favourite editor, filling out the following properties:
- **BOT_TOKEN** (you can find the bot token under `https://discord.com/developers/applications/bot-id/bot` for an overview of all your bots visit https://discord.com/developers/applications)
- **BOT_OWNER** ([Where can I find my User/Server/Message ID?](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-))
Run the bot via `docker-compose`
```console
$ docker-compose up --build --detach
```
## Versioning 🏷️
This project uses [Semantic Versioning](http://semver.org/) for versioning. For the versions available, see the [tags](https://github.com/Abzylicious/RaffleBot/tags/) on this repository.
## Authors 👤
* **Alexander Deledda** - *Original Author* - [@Abzylicious](https://github.com/Abzylicious)
See also the list of [contributors](https://github.com/Abzylicious/RaffleBot/graphs/contributors) who participated in this project.
## Contributing 🤝
Contributions, issues and feature requests are welcome! Feel free to check the [issues page](https://github.com/Abzylicious/RaffleBot/issues).
## Setup development environment 🛠️
For development you don't necessarily need **Docker** and **Docker-Compose** but **Java**
- `clone` this repository
- Open the project in your favourite Java / Kotlin IDE (JetBrains [IntelliJ IDEA](https://www.jetbrains.com/idea/) is the recommended IDE for Kotlin projects)
- For running the bot within your IDE you need to add your bot token as `program argument` or `environment variable` (You might have to figure out how to do that in your IDE. **IntelliJ** let's you do that under `Run -> Edit Configurations...`)
## Show your support ⭐️
Give a ⭐️ if this project helped you!
## License 📝
Copyright © 2020 [Alexander Deledda](https://github.com/Abzylicious)
This project is [MIT](LICENSE) licensed.