https://github.com/thekodetoad/letterbox
Simplistic ModMail bot
https://github.com/thekodetoad/letterbox
Last synced: 10 months ago
JSON representation
Simplistic ModMail bot
- Host: GitHub
- URL: https://github.com/thekodetoad/letterbox
- Owner: TheKodeToad
- License: mit
- Created: 2024-12-12T18:57:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-28T23:58:42.000Z (about 1 year ago)
- Last Synced: 2025-04-29T00:41:04.439Z (about 1 year ago)
- Language: Rust
- Size: 274 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Letterbox
A simplistic, lightweight ModMail ~~bot~~ app for Discord using modern features like forums. Uses [poise](https://crates.io/crates/poise) under the hood meaning it won't take much memory!
## Usage
You will need a postgres database!
- Copy config.toml.example to config.toml and edit as necessary.
- Copy .env.example to .env and edit as necessary.
- Run `cargo run -r`
TODO: Nix, docker instructions (help needed)
## Philosophy
Advanced features like a web panel are not the goal here, nor is making the configuration flexible enough to satisfy absolutely everyone's needs.
Only posting to a forum will ever be supported - hidden channel viewers exist but hidden thread viewers do not, and text channels need to be deleted when a thread is closed otherwise there will be a lot of clutter and the 500 channel limit could easily be reached on a large server.
## Features
- Users can DM the bot to create a thread.
- More messages will add to the thread.
- These threads appear tagged as "Open" in a forum channel.
- Staff can reply using the reply command.
- Staff can *anonymously* reply using anon_reply.
- Messages can be edited and deleted using their respective commands.
- Threads can be closed using the close command. This will lock the forum post and retag it as "Closed".
- anon_close and silent_close are available. silent_close will not attempt to notify the user that the thread has been closed.
- Staff can open a thread to a user without their interaction using the contact command.