# What it Does
This bot has 2 primary functions, it can show you the current weekly combos of what track your favorite series are on, and compare you to your friends through the leaderboards and other statistics. You can find the commands to do these actions below.

# Some Important Notes
- The iRacing API is _slow_ to update. 
  When you finish a race it can take a day or sometimes more to appear in their API, which means the bot will not have that information either.
  When in doubt, run `!update`
- Please do not spam `!update` and `!updateserver`. 99% of the time the iRacing API just hasn't updated yet, 
  so you will never get live to the minute data, that just isn't a capability of the current iRacing API.

# Support
You can reach out to me on Discord as `Xander#1234` for help if something seems to be wrong

## Commands
## Series Combos Related
### !allseries
This will give a list of all current active series names and IDs(which are used for the favorite series commands).

### !setfavseries <Series IDs\> OR !addfavseries <Series IDs\>
This will set the favorite series for your discord server. Series IDs in this case is a list of comma separated
Series IDs that can be found from the `!allseries` command. Setting favorite series is necessary to
use the `!currentseries` command.

### !currentseries
Once favorite series have been set through `!setfavseries` this command prints images
showing the current tracks for each of the favorite series for the discord server you are in 
for this race week and the next race week.

### !removefavseries
This removes a single favorite from the saved favorite series for the discord server you are in.

## Leaderboard/Statistics Related
### !saveid <iRacing Client ID\>
Use this command to save your iRacing ID to your discord ID.
If you already have one saved this will overwrite it

### !savename <iRacing Name\>
Use this command to save your name and iRacing ID to your discord ID.
The name you submit must be exactly the same as your name on iRacing, including any numbers
If you already have one saved this will overwrite it

### !recentraces <iRacing Client ID \>
This gives detailed information on the last 10 races of the given user.
If no iRacing Client ID is provided, it will default to the saved ID of the user who called it.
If the user who called it has not saved their ID, then they must provide an ID when calling.

### !update
This will update the saved information for just the user who called the command.

### !updateserver
This will update the saved information for all users in the discord for use of the `!leaderboard` command.
All discords are automatically updated every hour, so often this is unnecessary to run.

**NOTE:** The iRacing API does not update frequently, so even if you finished a race recently and expect to see changes, 
it can take up to a day for those to come through on the bot.

### !leaderboard <category\> <type\>
This prints a leaderboard of all users with saved IDs(through the `!saveid` command) for the given category and type.
Category can be any of `road`, `oval`, `dirtroad`, and `dirtoval`, but it defaults to `road`.
Type is either `career` or `yearly`, and it defaults to career. `career` will show all time data, 
and `yearly` will only show data from the current year.

**NOTE:** This can be called with a category and no type, but if you want to call with a type, you need to pass a category.
For instance, I can call `!leaderboard oval`, but if I want the road leaderboard yearly I need to specify: `!leaderboard road yearly`, `!leaderboard yearly` is **NOT** valid.

### !iratings <category\>
This prints a graph of all saved user's iratings over the last 6 months. 
Category can be any of `road`, `oval`, `dirtroad`, and `dirtoval`, and defaults to `road`. 

### !careerstats <iRacing Client ID\>
This will give an overview of the career stats of the player with the given iRacing Client ID.
If an iRacing Client ID is not provided, then it will use the saved ID for the user who called the command.
If the user has not saved their ID, they must provide an iRacing Client ID.

### !yearlystats <iRacing Client ID\>
This will give an overview of the yearly stats of the player with the given iRacing Client ID.
If an iRacing Client ID is not provided, then it will use the saved ID for the user who called the command.
If the user has not saved their ID, they must provide an iRacing Client ID.

# Still Confused?

## Example usage

### Current Series Combos

Say I want to get the current series updates, and I typically race skip barber. To get that set up I would type `!allseries`. This will show me all of the active series right now.
From there I would run `!setfavseries 34` because that is the ID of the skip barber race series. Now that my favorite series have been set I can run `!currentseries` and it will show the skip barber series and the track that it is on. If you wanted more than just the skip barber race series, you could instead have run `!setfavseries` with a comma separated list of all the IDs of the series you want to track. Once you have set favorite series, you can add or remove one at a time with `!addfavseries` and `removefavseries`

### Leaderboard/Stats

Say I want a leaderboard of the people in my discord. First off, I would go to the iRacing website and navigate to `My Account`. From there once you login you should be able to see `Customer ID` in the top right next to your name. once you know your customer ID you can use `!saveid 499343` where you replace `499343` with your customer ID. Once the bot replies and says it saved your ID, you can run `!update` and it will update your data. Once you have your friends on the server also do the same, you can run `!leaderboard` and see all of your stats compared. The `!leaderboard` command also has more options, so you can read the specifics of that above. Also, once your ID is saved, you can run `!recentraces`, `!careerstats`, and `!yearlystats` to see just your data

iRacing Bot

A Discord bot to show iRacing stats and current series track combos

Votando em iRacing Bot

Quer nos ajudar?