- TODO update pictures
Xayah Bot
is a Discord Bot primarily intended to use for giving League of Legends statistics (general data about champs, winrates, banrates, etc.). Additionally there are other useful commands which you can see later on.
This project is comepletey written in C# and references the following frameworks:
- Microsoft Entity Framework Core
- Discord.Net - Link
To present data Xayah Bot
will access the following APIs:
- Riot Games API
- Champion.GG API
Commands can be triggered by mentioning Xayah Bot
before using the command syntax except direct messages which don't need that.
Here are some additional points about how Xayah Bot
works:
- The title and description of commands of this documentation will differ to the ones provided in the help of
Xayah Bot
. Responses in Discord are meant to be "in character" and thus differently phrased. - If a command is replied to per direct message (to not clutter chats) the triggering message will receive a reaction to imply it was handled. This prevents users from assuming the Bot stopped working because they can't see a response. If the reaction is missing and the user did not receive a response please panic and contact me.
The help displays a message with a short overview of existing categories, how to access them and contact data.
Usage:
The keyword to this command is help
followed by an optional page number.
The 8ball command answers the triggering post with a random response which can be positive, neutral or negative. Additionally Xayah Bot
demands actual questions and has witty comments if this requirement is not fulfilled.
Usage:
The keywords to this command are are
, is
or am
followed by a sentence.
Reminders are exactly what the name implies. If the user creates a reminder and it expires he gets notified with the provided message.
There is a cap how long Xayah Bot
is allowed to wait and how long the message can be. This is configurable but defaults to 30 days and 100 characters, respectively.
Usage:
This command is split in three parts:
remind me [number] [time-unit] [text]
creates a new reminderremind me list
shows a list of active reminderremind me clear
clears the list of active reminder
To clarify the parameter when creating a reminder:
[number]
defines how longXayah Bot
has to wait before the reminder expires[time-unit]
can bedays, day, d, hours, hour, h, minutes, minute, mins, min, m
[text]
that will be posted once the reminder expires
The champ command gathers data about a specified champion (stats + stat-growth, spells, skins and misc). This data is only refreshed once on the first request each day (StaticData-Endpoint in API).
Usage:
They keyword to this command is champ
followed by the name to search for.
The name doesn't need to be exact! Special characters and/or whitespace can be ignored and even partial names will work. Though if the given name is too vague and could match multiple champs a different response will appear which lists all matching champions.
Example:
Request with a complete name
Request with a partial name that doesn't match a specific champion
If you still have questions, problems or even suggestions you can e-mail me at aergwyn@t-online.com
or add me in Discord Aergwyn#8786
.
There is also a discord server where you can reach me, try commands out or invite Xayah Bot
to your server.
Xayah Bot
isn't endorsed by Riot Games and doesn't reflect the views or opinions of Riot Games or anyone officially involved in producing or managing League of Legends. League of Legends and Riot Games are trademarks or registered trademarks of Riot Games, Inc. League of Legends © Riot Games, Inc.