Welcome!

Thanks for supporting my iRacing Reports Discord Bot project.

To get the bot up and running in your Discord server you'll need to complete these steps:

  1. Connect your Patreon account with iRacing Reports
  2. Connect your Discord account with iRacing Reports
  3. Invite the iRacing Reports Discord Bot to your Discord server
  4. Create a role for the bot, and configure the required permissions
  5. Use the /subscribe command to use your sub on your server
  6. Use the "follow channel" feature to show development announces into your stats channel
  7. Add drivers to your team
  8. Configure server options

To begin the process, please open the following URL in a new tab:

https://iracingreports.com/accounts/login

I highly recommend joining our Discord server, you can contact us in there with bug reports, feature requests or any questions you might have. Click here to join us.


1) Connect your Patreon

For the iRacing Reports systems to know that you're a supporter and what tier you're on, you'll need to use a system called OAuth to connect your Patreon account with the iRacing Reports website. For more information about OAuth, you can read this excellent explanation on the Patreon support site: https://www.patreon.com/portal/start/oauth-explained

Click the CONNECT WITH PATREON button:

Connect with Patreon button

You'll enter the email address associated with your Patreon account and your password. Note, this information is sent to Patreon not us! You'll see that the URL is a patreon.com address.

Patreon login screen

You'll be informed of the information that will be shared with us, click the Allow button.

Patreon permissions

With this completed, you'll be returned to the iRacing Reports website and you should see the details of your Patreon account, along with what tier you're subscribed on and your payment status.


2) Connect your Discord

To link up your Patreon account with your Discord account, you'll have to do a similar process with Discord.

Click the CONNECT WITH DISCORD button:

Connect with Discord button

You can either login using the email address associated with Discord and your password, or use the QR Code Login feature.

Discord login screen

You'll be informed of the information that will be shared with us, click the Authorize button.

Discord authorization

With this completed, you'll be returned to the iRacing Reports website and you should now also see the details of your Discord account.


3) Invite the bot

If you have an invite to use, you'll be shown the INVITE BOT TO YOUR SERVER button. Click it!

Invite bot button

Select the server you want to invite the bot into, and click the Continue button.

Select server

Note If you've configured 2 factor authentication on your server, you'll need to enter an auth code from your authentication app.

You'll be shown a list of the permissions that will be granted to the bot. Click the Authorize button.

Bot permissions

With this completed, the bot will appear in your server!

Note: be sure that you've granted the @everyone role permission to Use Application Commands either in the entire server or in the channel(s) where you want the bot to be used.

Application commands permissions


4) Create a role and set permissions

Many teams / communities will limit the bot to only respond to commands in a single (or few) channels. We recommend creating a role for the bot and configuring the permissions.

For information on how to do this, please see Discord's documentation:

https://support.discord.com/hc/en-us/articles/206029707-Setting-Up-Permissions-FAQ

The permissions that the bot's role will require in channels where you want it to be able to respond to commands are:

  • View Channel
  • Send Messages
  • Send Messages in Threads
  • Create Public Threads
  • Embed Links
  • Attach Files
  • Add Reactions
  • Read Message History

5) Use your subscription on your server

In your server run the /subscribe command. This will link your iRacing Reports account to the server, so you can make use of all the admin commands to configure your team and options.


6) Follow the iRacing Reports announcements channels

To keep up to date with development of the bot and to see any announcements we make about the service, please join our Discord server and browse to the announcements channel and click the "Follow" button up the top of the screen. Do the same for the development-todo channel.

For more info on the "Follow" feature of Discord: https://support.discord.com/hc/en-us/articles/360028384531-Channel-Following-FAQ


7) Adding drivers to your team

Once you've got the bot all ready to go, you'll probably want to add drivers to your team. Drivers in the team list will automatically be highlighted in responses from the bot and announcements of their races can be enabled.

You will use the /manage_team add command to do this. You'll need to provide the driver name and color you'd like used for the highlights for this driver. There is also an option field to link this driver to a Discord user. Be sure to select the Discord user from the auto complete list. It needs to resolve out to the purple text version.

Below is an example of what a completely filled out command looks like:

Add driver example


8) Enable team race results announcements

If you'd like the results of your team drivers to be announced, you'll need to run the command /set_results_announce_channel in your Discord server in the channel where you want results announced.

Note: This command can be used with a series option to have the results of different series announced into different channels. Again, run the /set_results_announce_channel series:selected_series in your Discord server in the channel where you want results announced for the series you select.


9) Configure server options

Visiting https://iracingreports.com/accounts/login once you've done the above you'll see your server name displayed at the bottom of your User page. Clicking this will take you to the options page where you can configure various settings for the bot.

This includes further options available for the race announcement system, such as only announcing positive iRating results, or only results from a white list of series, etc.