Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wrussell1999/food-flex-discord
🍔 Discord bot for rating your friends food
https://github.com/wrussell1999/food-flex-discord
discord discord-api discord-bot discord-py food-flex hacktoberfest ssh
Last synced: 3 months ago
JSON representation
🍔 Discord bot for rating your friends food
- Host: GitHub
- URL: https://github.com/wrussell1999/food-flex-discord
- Owner: wrussell1999
- License: mit
- Created: 2019-04-23T22:43:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-10T03:06:35.000Z (about 2 years ago)
- Last Synced: 2023-03-09T11:50:47.723Z (almost 2 years ago)
- Topics: discord, discord-api, discord-bot, discord-py, food-flex, hacktoberfest, ssh
- Language: Python
- Homepage: https://foodflex.wrussell.co.uk
- Size: 946 KB
- Stars: 15
- Watchers: 1
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Food Flex Discord Bot
## What does the bot do?
Food Flex is bot that manages:
- Submissions
- Voting
- Results
- Leaderboard
### Submissions (Monday 10:00 - Sunday 8:59)
When a user uploads a picture of their food to the chat, they are automatically entered into the competition. Users can only submit once. Additional photos will overwrite the existing submission so your last photo sent will be the one saved.
### Voting (Sunday 9:00 - Sunday 21:59)
Submissions are closed and a voting poll is displayed. Users can vote for their favourite by sending the letter that corresponds to the user. Users can only vote once, and not for themselves. The bot will won't count additional votes. Also, anyone who submitted, and hasn't voted by 21:00, will received a private message to remind them to vote. You will receive a private message to confirm your vote.
**NOTE:** If you submit a picture and don't vote, you are disqualified.
### Results (Sunday 22:00)
Voting is closed and a results message will be sent to the chat.
### Leaderboard
This is a read-only channel that updates every day once there are new results. This shows the overall scores over a period of time. This can be a month, university term, or a year. You can also see the leaderboard at [here.](https://foodflex.wrussell.co.uk/leaderboard)
## Docs
See the wiki for documentation on commands, json data and more.
## Setup For Bot
Go into the `bot` folder
### Debian-based
Install dependencies:
```bash
virtualenv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
To run:
```
python app/bot.py
```
### Docker Compose
The [Compose](docker-compose.yml) can also be used to run the application.
1. `cp example.env .env`
2. Configure the variables as equivilent to [config](###Configuration) *
3. Pull: `docker-compose pull`
4. Launch: `docker-compose up -d`
5. View logs: `docker-compose logs -f`
---
## Configuration
### Environment Variables
Will out the `.env` file.
```bash
TOKEN=
SERVER_ID=
COMMAND_PREFIX=
ADMIN_IDS=
MAIN_CHANNEL_ID=
LEADERBOARD_CHANNEL_ID=
DATA_ROOT=
```
\* The only thing to note here is that `admin_id` should be in the form of `1111, 2222, 3333` when using environment variables.
### Meaning of each key
- `token` - your bot's secret token
- `server_id` - the ID of your server
- `command_prefix` - a prefix that marks the message as a command for the bot (you may need a space at the end)
- `admin_ids` - a list of user IDs that will be allowed to use bot commands
- `main_channel_id` - the ID of the channel to use for submissions, voting and results
- `leaderboard_channel_id` - the ID of the channel to use for the leaderboard
- `data_root` - directory containing `leaderboard.json` and `state.json` (Default value of `.` if none is provided)
### Getting a token
[This guide](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token) will show you how to create a Discord Bot for your Discord server.
### Getting IDs
Go to Discord and turn on Developer Mode. With this, you can now right-click on guilds, channels, catergories, users, messages, etc. and get their ID (an integer).
## Contributors
- [Will Russell](https://www.github.com/wrussell1999): Submissions, voting, results, leaderboard, working with the discord.py API wrapper and Discord servers.
- [Daniel Spencer](https://www.github.com/danielfspencer): Voting validation, improved reliability, general refactoring, and performance improvements with dictionaries.
## License
MIT License for all the code written by Will and Dan.
[DejaVuSans font](https://dejavu-fonts.github.io/) - Bitstream Vera Fonts Copyright