stat_summoner/module/championsinfos/
mod.rs

1/// 🛠 **Module championsinfos**: Contains commands and utilities related to League of Legends champion information.
2///
3/// This module provides functionality for fetching and displaying detailed information about League of Legends champions.
4/// It includes the `championsinfos` command, which allows users to input a champion's name and receive comprehensive data,
5/// such as roles, winrate, banrate, popularity, recommended runes, and core item builds, all presented in a formatted Discord embed with appropriate emojis.
6///
7/// # Files in this module:
8/// - `championsinfos.rs`: The command for fetching and displaying champion information.
9/// - `utils.rs`: Utility functions used by the `championsinfos` command, such as functions for data retrieval, fuzzy matching, and processing.
10///
11/// # Example:
12/// To use the commands in this module, ensure they are registered in the bot's main framework setup:
13///
14/// ```rust
15/// use commands::championsinfos::championsinfos;
16///
17/// #[shuttle_runtime::main]
18/// async fn main() {
19///     let framework = poise::Framework::builder()
20///         .options(poise::FrameworkOptions {
21///             commands: vec![championsinfos()], // Register the championsinfos command
22///             ..Default::default()
23///         })
24///         .build();
25/// }
26/// ```
27///
28/// The `championsinfos` command allows users to fetch detailed information about a specific champion by entering the champion's name.
29/// It utilizes fuzzy matching to handle variations or misspellings in the champion's name input by the user.
30/// The command presents the information in a well-structured Discord embed, enhancing user experience.
31///
32/// As more commands or utilities related to champion information are added, they will be included here and imported into the main bot setup.
33pub mod championsinfos;
34pub mod utils;