Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/serenity-rs/poise
Discord bot command framework for serenity, with advanced features like edit tracking and flexible argument parsing
https://github.com/serenity-rs/poise
discord hacktoberfest rust serenity slash-commands
Last synced: 7 days ago
JSON representation
Discord bot command framework for serenity, with advanced features like edit tracking and flexible argument parsing
- Host: GitHub
- URL: https://github.com/serenity-rs/poise
- Owner: serenity-rs
- License: mit
- Created: 2021-03-30T15:47:07.000Z (almost 4 years ago)
- Default Branch: current
- Last Pushed: 2024-12-22T17:35:51.000Z (20 days ago)
- Last Synced: 2024-12-28T17:00:08.004Z (14 days ago)
- Topics: discord, hacktoberfest, rust, serenity, slash-commands
- Language: Rust
- Homepage:
- Size: 70.6 MB
- Stars: 700
- Watchers: 6
- Forks: 119
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - serenity-rs/poise - Discord bot command framework for serenity, with advanced features like edit tracking and flexible argument parsing (Rust)
README
[](https://serenity-rs.github.io/poise/)
[](https://crates.io/crates/poise)
[](https://docs.rs/poise/)
[](https://serenity-rs.github.io/poise/)
[](https://opensource.org/licenses/MIT)
[](https://blog.rust-lang.org/2023/11/16/Rust-1.74.0.html)
# Poise
Poise is an opinionated Discord bot framework with a few distinctive features:
- slash commands: completely define slash commands with a single function signature
- flexible argument parsing: command parameters are defined with normal Rust types and parsed automatically
- text commands: commands are agnostic over old text-based commands and slash commands
- edit tracking: when user edits their message, automatically update bot response
# How to use
Most information is in the [API documentation](https://docs.rs/poise/). Also take a
look at the [examples](examples), especially [`feature_showcase`](examples/feature_showcase), to learn what poise can do.
If you're using a development version from git directly, you probably want to look at the documentation for the
[`current`](https://serenity-rs.github.io/poise/current) or [`next`](https://serenity-rs.github.io/poise/next) branch instead.
For further questions, don't hesitate to join the support server: https://discord.gg/serenity-rs.
# Bots using poise
For each bot, there's a list of notable features for you to take inspiration from.
- [Dexscreener Pricebot](https://github.com/keiveulbugs/Dexscreener_pricebot) by [@keiveulbugs](https://github.com/keiveulbugs): embeds, API calls, ephemeral messages
- [TTS Bot](https://github.com/Discord-TTS/Bot/) by [@GnomedDev](https://github.com/GnomedDev): localization, database, voice
- [Scripty](https://github.com/scripty-bot/scripty) by [@tazz4843](https://github.com/tazz4843): localization, database, voice
- [Etternabot](https://github.com/kangalio/Etternabot) by [@kangalio](https://github.com/kangalio): response transformation, variadic and lazy arguments
- [Rustbot](https://github.com/rust-community-discord/ferrisbot-for-discord) by [@kangalio](https://github.com/kangalio): database, custom prefixes
- [StatPixel](https://github.com/statpixel-rs/statpixel) by [@matteopolak](https://github.com/matteopolak): modals, buttons, dropdowns, database, localization
- [CrackTunes](https://github.com/cycle-five/cracktunes) by [@cycle-five](https://github.com/cycle-five): database, voice, custom prefixes, modals.
You're welcome to add your own bot [via a PR](https://github.com/serenity-rs/poise/compare)!
For more projects, see GitHub's [Used By page](https://github.com/serenity-rs/poise/network/dependents).