Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: about 15 hours 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 (10 months ago)
- Default Branch: main
- Last Pushed: 2024-08-06T18:14:12.000Z (3 months ago)
- Last Synced: 2024-08-06T21:54:10.273Z (3 months ago)
- Topics: discord, discord-bot, poise, rust
- Language: Rust
- Homepage:
- Size: 1.99 MB
- Stars: 3
- Watchers: 1
- Forks: 3
- 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
#### Mensa plan
know what's up for lunch
show the next available plan
automatically skips weekends
find your friends
## Images
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
1. [Install Rust](https://www.rust-lang.org/tools/install)
2. [Install Shuttle](https://docs.shuttle.rs/getting-started/installation)
3. Optional: [Install PostgresQL](https://www.postgresql.org/download/), you can also use a Docker container
4. Change the Database URL (`postgres://test:pass@localhost:5432/postgres`) in `main.rs` to your local
PostgresQL instance, if you leave it blank shuttle will use a Docker container.
5. Create a Discord Bot on the [Discord Developer Portal](https://discord.com/developers/applications)
6. Copy the bot token and put it in a `Secrets.toml` file in the root directory:
```toml
DISCORD_TOKEN = "your token here"
```
You can also create a `Secrets.dev.toml` file if you want to test with a different token for development.
7. Invite the bot to your server with the `ADMINISTRATOR` permission. You can also only choose the permissions you need.
8. Run the bot with `cargo shuttle run`
Some features also require a font and images from the `assets` folder.
Due to legal reasons, not all of them can be provided here. What's missing:
- `rockwill.ttf`: [Rockwill Font](https://fontmeme.com/fonts/rockwill-font/)
- `obama_medal.jpg`: [Obama Medal](https://a.pinatafarm.com/1015x627/ade80aa63d/obama-medal.jpg)
- `mensa_plan.png`: [Mensa Plan](https://www.meck-architekten.de/projekte/id/2019-mensa-campus-garching/) or
from [here](https://www.heinze.de/architekturobjekt/zoom/12979688/)
Simply download them and place them in the `assets` folder with the same name.
## 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's hosted on [Shuttle](https://www.shuttle.rs/) 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 also 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
0: 0
}
auto_reactions: {
robot: {
name: "🤖"
}
vibing: {
animated: true
name: vibing
// emoji id
id: 0
}
}
auto_replies: [
{
keywords: [
"wobot info"
"wobot help"
]
// discord user id
user: 0
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
}
}
```