stat_summoner/module/whoisfollowed/mod.rs
1pub mod utils;
2/// 🛠**Module commands**: Contains all bot commands for the Discord bot.
3///
4/// This module organizes the different commands used by the bot. Each command is stored in its own file
5/// within the `commands` directory. These commands are registered and used through the bot's interaction
6/// with Discord via the Poise framework.
7///
8/// # Files in this module:
9/// - `whoisfollowed.rs`: The command for fetching and displaying the list of summoners being followed in the current Discord guild.
10///
11/// # Example:
12/// To use commands in this module, ensure they are registered in the bot's main framework setup:
13///
14/// ```rust
15/// use commands::whoisfollowed::whoisfollowed;
16///
17/// #[shuttle_runtime::main]
18/// async fn main() {
19/// let framework = poise::Framework::builder()
20/// .options(poise::FrameworkOptions {
21/// commands: vec![whoisfollowed()], // Register the whoisfollowed command
22/// ..Default::default()
23/// })
24/// .build();
25/// }
26/// ```
27/// A new command `whoisfollowed` allows users to retrieve a list of summoners currently being followed in the guild, along with the remaining follow time.
28///
29/// As more commands are added, they will be included here and imported into the main bot setup.
30pub mod whoisfollowed;