# Quick Start Guide

{% hint style="warning" %} <mark style="color:orange;">**Warning:**</mark> <mark style="color:orange;"></mark><mark style="color:orange;">LoL Esports Companion is</mark> <mark style="color:orange;"></mark><mark style="color:orange;">**still in beta**</mark><mark style="color:orange;">. There will be</mark> <mark style="color:orange;"></mark><mark style="color:orange;">**bugs and issues**</mark> <mark style="color:orange;"></mark><mark style="color:orange;">with the bot in its current state! The bot is a</mark> <mark style="color:orange;"></mark><mark style="color:orange;">**work in progress**</mark><mark style="color:orange;">, some functionality may change. Any such changes will be documented here.</mark>
{% endhint %}

LoL Esports Companion is a **interactions based discord bot** that allows you to easily view **scheduling, standings, team information, and team + player statistics** for any league in the world! With more features planned for the future.

What do I mean by "Interactions based discord bot"? Put simply it just means this discord bot utilizes all the new **interactive discord features such as slash commands, buttons and autocomplete** to name a few. These new Discord features make for a fluid experience with bots and make it easy to learn new commands.

Data powered by Riot's [LoL Esports ](https://lolesports.com/)API & [Oracles Elixir's](https://oracleselixir.com/) API.

[Use LoL Esports Companion on your own Discord Server](https://discord.com/api/oauth2/authorize?client_id=991597497606742117\&permissions=0\&scope=bot%20applications.commands).

## Feedback or Issues?

If you have any problems using the bot or have general feedback feel free to[ join the support discord server and let me know!](https://discord.gg/ZPFq6uHnu3)

## What Can LoL Esports Companion do?

### **`/all_leagues`**&#x20;

List all of the available leagues. If the region parameter is used it will list all leagues in the provided region. If the region option is used a validated list of regions will appear once you start typing for you to choose from.&#x20;

This command isn't the most useful but its nice to able to see what leagues are out there for you to use in other commands in the bot.

{% hint style="info" %} <mark style="color:blue;">International events such as</mark> <mark style="color:blue;"></mark><mark style="color:blue;">**MSI & Worlds**</mark> <mark style="color:blue;"></mark><mark style="color:blue;">are considered</mark> <mark style="color:blue;"></mark><mark style="color:blue;">**their own leagues.**</mark>
{% endhint %}

**Optional Parameters:                                                                                                                                                               \<region> -** Filter the results so only leagues in the region provided are shown.

<figure><img src="https://i.imgur.com/Uom7nD2.gif" alt=""><figcaption><p>Using /all_leagues</p></figcaption></figure>

### `/league_schedule <league>`

Get a particular leagues upcoming schedule. The \<league> parameter has a validated list of leagues you can choose from as seen in the GIF below. This command only grabs the schedule for the upcoming week/weekend and does not show multiple week/weekends worth of scheduling.

By default timestamps are shown in UTC, this can be changed with the optional parameter \<timezone>.&#x20;

:white\_check\_mark: - If you see this next to a scheduled match, it means it has already concluded.

:crown: - A crown indicates the victor of a concluded match.

**Required Parameters:                                                                                                                                                               \<league> -** The league you want to get the schedule of. This parameter provides a validated list of acceptable leagues as you start to type in it.

**Optional Parameters:                                                                                                                                                               \<timezone> -** Show schedule times in the selected timezone, a validated list of time zones is provided as an autocomplete list for this parameter.

{% hint style="info" %} <mark style="color:blue;">If no timezone is provided the times are shown in UTC.</mark>
{% endhint %}

<figure><img src="https://i.imgur.com/IGjjnuS.gif" alt=""><figcaption></figcaption></figure>

{% hint style="danger" %} <mark style="color:red;">If there are no upcoming events scheduled for the selected league the bot may not respond.</mark>
{% endhint %}

### `/league_standings <league> <stage>`

Get the standings for the **currently active tournament** for the provided league & stage. If there is no active tournament, the **most recently active tournament's standings will be displayed instead**

{% hint style="info" %} <mark style="color:blue;">Most recently active tournament will be used if an there is no active tournament for selected league.</mark>
{% endhint %}

**Required Parameters:                                                                                                                                                               \<league> -** The league you want to get the schedule of. This parameter provides a validated list of acceptable leagues as you start to type in it.                                                                                                                           **\<stage> -** The stage you want to get standings for, options are: `Regular Season, Playoffs, Play Ins Knockouts, Play Ins Groups, and Groups.`&#x20;

{% hint style="info" %} <mark style="color:blue;">**Play Ins Knockouts, Play Ins Groups and Groups**</mark> <mark style="color:blue;"></mark><mark style="color:blue;">stages are only available in the Worlds league.</mark>
{% endhint %}

<figure><img src="https://i.imgur.com/kpufikC.gif" alt=""><figcaption><p>Using /league_standings</p></figcaption></figure>

### **`/team_info <team>`**

Get the home league, roster, and basic stats for any team in any league. If you want to get the definitions for the team stats use the [/stat\_definitions](#undefined) command to get them.

{% hint style="info" %}
The statistics shown for the team are pulled from the most recently active tournament.
{% endhint %}

**Required Parameters:                                                                                                                                                               \<team> -** The team you are looking for, as with all commands a validated list of teams is provided. You must select one from this list.&#x20;

<figure><img src="https://i.imgur.com/ylMCVSn.gif" alt=""><figcaption><p>Using /team_info</p></figcaption></figure>

### `/player_statistics <player> <scope>`

Get statistics for a particular player and scope. The player parameter has autocomplete so as you start to type in a player it should show up.  Will give the last three years or splits worth of statistics.

**By scope we mean would you prefer the statistics by year or by split.**

**Required Parameters:                                                                                                                                                               \<player> -** The particular player you are looking to get stats on. Can be any pro league player.                                                     &#x20;

**\<scope> -** Scope of the statistics, either **by year or by split**.

<figure><img src="https://i.imgur.com/JRUNL42.gif" alt=""><figcaption></figcaption></figure>

### `/stat_definitions`

Get the definitions to the various data points shown in player & team stats.

<figure><img src="https://i.imgur.com/FeOdcQd.gif" alt=""><figcaption><p>Using /stat_definitions</p></figcaption></figure>

&#x20;                                                                                                                   &#x20;