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) setting is used to control which users have access to certain commands. The Administrators can change settings for you whenever they want.

By default, the setting is set to the @Administrator role. Additionally, any user with the Administrator permission will be detected as an administrator of the bot. This role may not be available within your Discord server. If this is the case, the !settings command will display this setting 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 this setting to your own role, you can simply use the !settings set adminRole @YourRole command. This will set the Administrator 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 the Administrator role.

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.

Toggle Settings

The settings below can be used to customize the behavior of the bot. It allows you to toggle certain features of the bot on (1) or off (0), depending on your preference. To use these options, select the setting you want to change, then type either 0 or 1. An example would be !settings set forceLanguage 1, which would enable the forceLanguage setting.
!settings set forceLanguage <0/1>
If your server enforces a rule to only talk in a certain language, you can set this to 1 to force the bot to talk only in the language set using the language setting.
!settings set preferImage <0/1>
Premium guilds only. This setting allows you to ping Daily Challenges in image form instead of the regular text form.
!settings set showCommunities <0/1>
This setting allows you to disable external communities in the !links command in case you view these as advertisements.
!settings set showCreditLinks <0/1>
This setting allows you to disable external links in the !credits command in case you view these as advertisements.
!settings set showProviders <0/1>
Premium guilds only. This setting allows you to hide the providers in the different messages, moving them to the !credits command.
!settings set showSuggestions <0/1>
This setting allows you to disable suggestions above !find commands if you find them distrating and want to decrease the size of search result messages.

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.

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.
Daily Challenges
!settings set daily #channel
Changes the settings to ping whenever the new Daily Challenges are known in the #channel channel without mentioning any role.
!settings set daily #channel @Role
Changes the settings to ping whenever the new Daily Challenges are known in the #channel channel, mentioning the @Role role.
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 @Role
Changes the settings to ping all Freeroam Events in the #channel channel, mentioning the @Role 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 @Role
Changes the settings to ping only the Trade Route event in the #channel channel, mentioning the @Role role.
Madam Nazar
!settings set nazar #channel
Changes the settings to ping whenever the new Madam Nazar location is known in the #channel channel without mentioning any role.
!settings set nazar #channel @Role
Changes the settings to ping whenever the new Madam Nazar location is known in the #channel channel, mentioning the @Role 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 @Role
Changes the settings to ping Newswire changes 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 @Role
Changes the settings to ping Rockstar Service status changes in the #channel channel, mentioning the @Role 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 @Role
Changes the settings to ping Game Update changes in the #channel channel, mentioning the @Role role.
Weekly Collectibles Request
!settings set nazar #channel
Changes the settings to ping whenever the new Weekly Collectibles Request set is known in the #channel channel without mentioning any role.
!settings set nazar #channel @Role
Changes the settings to ping whenever the new Weekly Collectibles Request set is known in the #channel channel, mentioning the @Role role.