Guide - Settings

To configure the bot, a selection of different settings are available in the bot which you can change. This quick guide provides an in-depth look at all the different settings, what they do, and what they can be set to.

Settings

Settings are divided into multiple categories in this guide. The categories are roles, pings, and utility. Settings are saved on a per-Discord basis, so if you add the bot to multiple servers, you will need to configure the bot on all the different guilds you administrate.

Role Settings

The adminRole (Administrator role) and modRole (Moderator role) settings are used to control which users have access to certain commands. The Administrators can change settings for you whenever they want, and Moderators are able to retrieve some stats about the bot at will. While the Moderators role is currently underutilized, further abilities like the ability to purge the bot's messages will be added in the future.

By default, these settings are set to the @Administrator and @Moderator roles. These roles may not be available within your Discord server. If this is the case, the !settings command will display these settings as being set to "an invalid role". This also means that no user will be assigned the permissions that come with it for safety.

To change these settings to your own roles, you can simply use the !settings set adminRole @YourRole command. This will set the Administrator or Moderator role to the role of your choosing. You can check whether the setting was changed successfully at any time using !settings. If at any point you want to reset a setting to the default role, you are able to use the !settings reset adminRole command for both the Administrator role and the Moderator role.

Ping Settings

Note, available for Premium guilds only.

The events, status, news, and patches settings can be used to ping a certain channel when an event is about to start, when the Rockstar Games Service Status changes, when Rockstar publishes a new article, or when the game is updated and the patch notes are available. This means that you can have a #freeroam-events channel where a message gets posted by the bot 10 minutes before a certain event starts, or a #service-status channel that will be notified when the Rockstar servers are experiencing issues and when those are resolved.

By default, nothing will be pinged, so you'll need to manually change the settings before you'll start receiving pings. To set it up, use the !settings set events command. You can find the different options for all the ping settings in detail below.
Freeroam Events
!settings set events all #channel
Changes the settings to ping all Freeroam Events in the #channel channel without mentioning any role.
!settings set events all #channel @Freeroam-Events
Changes the settings to ping all Freeroam Events in the #channel channel, mentioning the @Freeroam-Events role.
!settings set events TR #channel
Changes the settings to ping only the Trade Route event in the #channel channel without mentioning any role.
!settings set events TR #channel @Trade-Route
Changes the settings to ping only the Trade Route event in the #channel channel, mentioning the @Role role.
Service Status
!settings set status #channel
Changes the settings to ping Rockstar Service status changes in the #channel channel without mentioning any role.
!settings set status #channel @Service-Status
Changes the settings to ping Rockstar Service status changes in the #channel channel, mentioning the @Service-Status role.
News
!settings set news #channel
Changes the settings to ping Newswire changes in the #channel channel without mentioning any role.
!settings set news #channel @News
Changes the settings to ping Newswire changes in the #channel channel, mentioning the @News role.
Patches
!settings set patches #channel
Changes the settings to ping Game Update changes in the #channel channel without mentioning any role.
!settings set patches #channel @Patches
Changes the settings to ping Game Update changes in the #channel channel, mentioning the @Patches role.
If at any point you decide you no longer want to receive pings in a channel, you can use the !settings remove events all #channel or !settings remove status #channel commands for these settings. This will will disable the bot pinging the channels.

Utility Settings

The utility settings, specifically language and prefix will allow you to tweak how the bot behaves. The language setting changes the language, and the prefix setting changes the command prefix for that Discord server. For details about the language setting, check out the "Basics" guide, and to change the prefix of the bot within your Discord server, use !settings set prefix ?, where ? is the prefix you want it to have. It can be as or short as you want.

If you want to reset these settings to their defaults, use the !settings reset prefix and !settings reset language to reset the settings back to ! and en respectively.