laralove143 / larabot

Common code used by my Discord bots

🤖 larabot

This repository is a non-published Rust crate that has the common code used by my Discord bots.

Although the code itself is very opinionated, feel free to fork the project and adjust it however you wish.

✨ Features

🔃 Interaction Handling Flow

🫡 Command Creation

Has a method to create a commands for the given guild or globally based on the build configuration.

🏃 Interaction Handling

Provides a trait to handle the interaction, which is meant to be implemented on each interaction's struct.

The trait's provided handle method sets up automatic deferring, runs the interaction, and handles the error by reporting it to the user.

🌐 Localization

Has a struct to hold text in a localized manner, with methods to get the text in the desired language or return Discord-compatible arrays of localized texts.

All user-facing texts used in this crate are also localized.

📨 User Feedback

Includes a command that users can use to provide feedback, which uses Sentry to report the feedback.

Users can also provide feedback with the button attached to the interaction error message.

📝 Tracing

Has a function to set up tracing with a formatter, environment filtering, Sentry support, and log crate compatibility.

🙈 Generic Option to Result Conversion

Provides a trait to convert an Option to a Result concisely. This is here because the Discord API returns many optional values.

📡 Event Handling

Provides methods to handle the ready event, as well as errors that occur while handling or receiving an event.

🎨 Colors

Allows you to use Discord-defined colors with an enum the crate provides.

larabot's Issues

metrics support

support sentry's metrics feature, through abstraction functions and also collect metrics within the crate

centralize localization further

currently, RequiredData associated type in traits is used to pass locale around, which is more code than necessary since basically every action involving ui requires locale context, so locale should be attached directly to traits in interaction module

they can be set to "" if they're not used anyway

centralize help commands

some parts of help commands are the same, such as the embed thumbnail (bot's avatar) and the components (feedback button, server invite)

write a function that gives the starting point for the response, the rest can be customized specifically for the bot

set bot's presence message

the set message will probably follow the same principles as #1 #2 #3

it'll change every day or something

celebrate important dates in embed footers

probably as part of the function in #1

if the current date is an important date, this overrides the random footer message

the date is prioritized by reverse length, so a special day is prioritized over a special month

example messages:

• Happy pride!
• Happy mother's day!

random footer message

add a function that picks a random string to be used as the embed footer

useful for petty messages like:

• Consider donating...
• Want to edit others' messages? Check out Message Bender!

publish metrics

there will probably be a background task that stores guild count and other metrics to a public database like r2

unless sentry has a way of doing that

show updates in footers

probably part of #1 and #2, overrides both when there's an update

on an update, footer should be set to a short description of the update once, once the footer has been displayed, its discarded and #2 or #1 take effect as usual

if there are multiple updates not shown in a guild yet, they are shown in order until they deplete

example messages:

• You can now see what's new in the bot with these footers.
• Use the new /ban command to ban your friends without having the necessary permissions!