https://github.com/friendly-banana/wobot
Powerful and fun Discord Bot written in Rust
https://github.com/friendly-banana/wobot
discord discord-bot poise rust
Last synced: 3 months ago
JSON representation
Powerful and fun Discord Bot written in Rust
- Host: GitHub
- URL: https://github.com/friendly-banana/wobot
- Owner: Friendly-Banana
- Created: 2023-12-29T18:39:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-20T18:59:43.000Z (4 months ago)
- Last Synced: 2025-04-12T04:53:55.638Z (3 months ago)
- Topics: discord, discord-bot, poise, rust
- Language: Rust
- Homepage:
- Size: 2.83 MB
- Stars: 3
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WoBot
## Features
WoBot comes with a ton of features, including:
##### Improved Events:
* create a Discord Event, a thread and allow RSVP via reactions with a **single** command
* export all events to your calendar (works on mobile)
##### Improved Emojis:
* `add`, `rename` and `remove`
* `upload` to convert images into emojis
* `copy` emojis from other servers to your own
##### Easy Reaction Roles
simply react with the emojis you want
##### Memes:
* Obama: when someone congratulates themselves
* Cutie Pie: tell your friends how cute they are
##### ToDo list
store anything you like
#### Reminder
schedule whatever you like for later
#### Mensaplan
* know what's up for lunch
* show the next available plan
* automatically skips weekends
* find your friends
## Screenshots
Not yet convinced? Have some images:
## Contributing
If you have a great idea or suggestion, feel free to open [an issue](https://github.com/Friendly-Banana/wobot/issues).
If you want a feature right now and can code, open [a pull request](https://github.com/Friendly-Banana/wobot/pulls).
Please make sure to run `cargo fmt` before committing.
### Running the Bot
With Cargo:
1. [Install Rust](https://www.rust-lang.org/tools/install)
2. Create a Discord Bot on the [Discord Developer Portal](https://discord.com/developers/applications)
3. Invite the bot to your server with all permissions you need (`ADMINISTRATOR` is the easiest).
4. Run the bot with `DISCORD_TOKEN='' cargo run`
With Docker Compose:
1. [Install Docker Compose](https://docs.docker.com/compose/install/)
2. Build the docker file: `docker build -t wobot .`
3. Copy the bot token and put it in a `.env` file in the root directory:
```
DISCORD_TOKEN=''
```
4. Copy the `assets` folder. You can add additional files like the config here.
5. Run the bot with `docker compose up -d`
## Technical Overview
WoBot is a Discord Bot written in [Rust](https://www.rust-lang.org/)
with [the Poise framework](https://github.com/serenity-rs/poise/).
It can be hosted on any server and uses a PostgresQL database.
The mensa plan uses the [Eat API](https://tum-dev.github.io/eat-api), the mensa coordinates link
to [Google Maps](https://www.google.com/maps).
The [Mensaplan API](https://github.com/Friendly-Banana/mensaplan) is written by myself in Elixir.
### Configuration
`config.hjson` uses a human-friendly JSON version, [HJson](https://hjson.github.io/).
You can set up automatic reactions and replies based on keywords. All of them are case-insensitive.
Auto-reactions match only on word boundaries, ignoring punctuation around them.
For example, `wobot` would match `WoBot!` but not `wo bot`.
WoBot can react with both Unicode and custom Discord emojis, even animated ones.
#### Example Config
```hjson
// channel for event threads
event_channel_per_guild: {
// guild_id: channel_id
1: 1
},
auto_reactions: {
robot: {
name: "🤖"
}
vibing: {
animated: true
name: vibing
// emoji id
id: 1
}
},
auto_replies: [
{
keywords: [
"wobot info"
"wobot help"
]
// discord user id
user: 1
title: About WoBot
description: "Hi, I'm **WoBot**, your friendly neighborhood bot. Please send any questions or feedback to my author, {user}. This message was sent {count} times. Have a nice day!"
colour: 15844367
}
]
```