Setting up the Discord Bot

To implement a personalized Discord Bot to your server you need a Widget ID. To learn how to create a widget and obtain the ID read this article first. Hold on to this ID for later.

> To begin the process, CLICK THIS LINK.

In Discord, you'll see a popup that asks you to select which server you wish to add the bot to. 

Select a Server and click on the blue "Authorize" button in the bottom right of the pop-up. 

A captcha will then appear asking you to verify you are a human.

An "Authorized" pop-up will let you know everything went smoothly.

By default, the ReadyUp bot can be accessed from any channel. To limit the bot to specific channels, assign it a Discord Role that limits which channels it can View and Send Messages in.

Exit out of this pop-up and navigate to the server in which you installed the bot. To begin managing the bot, type

/readyup 

in a channel.

There are three configurable settings for the bot:

1. set_widget_id - Enter the Widget ID that you would like the bot to pull events from. If this is not configured, ALL events on ReadyUp will be available rather than just the events within the Widget.
   
   Example: /readyup set_widget_id: 555555x5-x5x5-5x5x-xxxx5555 
   
   To remove a Widget ID entirely, use the command /readyup remove_widget_id.
2. sync_events - Set this to "True" or "False". True will allow the bot to automatically sync the events filtered by your configured widget ID into Discord's native event system. False will disable automatic event syncing and remove any Discord event listings that the bot created.
   
   Event sync is enabled by default and will begin syncing events once you've set your widget ID via the /readyup set_widget_id command.
   
   Example: /readyup sync_events: True
3. respond_in_channel - Set this to "True" or "False". True will allow the bot to respond to queries directly in the channel in which the query was made. False will instead have the bot send a DM to the user with the results. If not configured the default option is False.
   Example: /readyup respond_in_channel: True

Best Practices

1. Link the bot to your widget so it only displays events that are relevant to your community. Feel free to make multiple widgets to best fit the needs of multiple servers if your community is segregated by different games.
2. If you want users to interact with the bot we recommend leaving the "Respond in Channel" setting as "False". However, if you instead want to use it solely as a way to publish events to your discord server then set the functionality to "True". If you want to publish events to discord and allow your users to interact with the bot then set the functionality to "True" but in this scenario we recommend limiting the channels in which the bot can respond so that your server does not become cluttered with events.