Config
Not sure what a config value means? You’re in the right place, here we’ll go over every config option available for zdiscord and what it means and expects. If you haven’t already, please read the setup guide in the read me first.
NOTE: All config values use strings (wrapped in " ") for their values. This is done for convar support.
Convars
If you don’t want to set config options within config.js you can set them through the server.cfg as convars. If a convar is listed under a config you can use it instead of setting the config as long as it’s placed above/before zdiscord is started/ensured or it wont be able to use them. **To use these convars, add a line to your server.cfg near the top with set convar_name "value". replace convar_name with the convar name you want to use.
General Configuration Settings
LanguageLocaleCode
[ Default: “en” | Convar: discord_lang ]
This determines which locale (translation) file is loaded from /locales so if the file that fits the language you want used is in that folder then use the 2 character name of the file. As of writing this ar, de, en, pl, tr and vn are available options.
Public Values
FiveMServerName
[ Replicated | Convar: discord_server_name ]
This is what you want your FiveM server to be called, this value is used in various places as an auto-fill like bot status and commands as well as translations when people are connecting to your server.
DiscordInviteLink
[ Replicated | Convar: discord_invite ]
A link to your discord server that will be given to users on connection problems to the FiveM server, used for discord presence links and some command replies.
FiveMServerIP
[ Replicated | Convar: discord_server_ip ]
DebugLogs
Turns on debug logging from discord.js for checking for errors
[ Replicated | Convar: discord_debug ]
Discord Bot Settings
EnableDiscordBot
[ Convar: discord_enable_bot]
This option deterrmins whether the bot actually connects to discord at all. if this is set to false the bot portions will not work at all. but log webhooks, presence updates and connection queue will continue though without priority
Discord Bot
DiscordBotToken
[ Convar: discord_token]
This is where you put your discord bot token generated from Discord Applications. It will look somewhat like ZDkx5NjQxjExNMzDM1D2U0O4.v9g7Wa.DK700Xi2LeVOC2NUuABgPt0ZyWR.
DO NOT Share this token with anyone, it’s a key to your bot and discord server which could be dangerous in the wrong hands.
DiscordGuildId
[ Convar: discord_guild_id ]
This is for your Discord Server id (Also called a Guild Id). You can get that by enabling developer mode in your discord client then right clicking your discord server icon and “copy id”. This is an important value, the bot will only listen to events done within this server.
Staff Chat
EnableStaffChatForwarding
[ Convar: discord_enable_staff_chat]
This set to “true” will enable the feature of forwarding chat from in game to discord and back in the channel configured in the next setting.
DiscordStaffChannelId
[ Convar: discord_staff_channel_id ]
This is the channel staff chat will be sent and be taken from to send to staff in game. this can only be 1 channel and some things might not look the same in game as they do in discord like emoji or @mentions but that’s normal.
AdditionalStaffChatRoleIds
if you have extra roles you’d like to access staff chat other than the default mod, admin and god roles configured below you can add other roles here and they’ll have access to see and toggle staff chat. Just make sure they can also see the DiscordStaffChannelId channel ;)
Whitelisting / Allowlisting
EnableWhitelistChecking
[ Convar: discord_enable_whitelist ]
This setting determines whether the bot should check if someone is in the discord and if they have a preset role defined under DiscordWhitelistRoleIds. Setting this to "true" wont let anyone into the server unless they:
- Have Discord open.
- Are in the Discord defined in DiscordGuildId.
- Have the whitelisted role in the discord
DiscordWhitelistRoleIds
[ Convar: discord_whitelist_roles ]
This is a comma separated list ("role1id, role2id, role3id") of role IDs that will be able to connect to the server if EnableWhitelistChecking is set to “true”. To get a role Id you enable developer mode in your discord client then either right click a role name from someone’s popup profile or right click the role name in the role settings and “copy id”.
Slash Commands / Discord Permissions
EnableDiscordSlashCommands
[ Convar: discord_enable_commands ]
If this is set to "true" the bot will register all it’s slash commands to the discord server and allow users with the correct roles to access them. if this is set to "false" all the commands will ignored and never registered.
DiscordModRoleId
[ Convar: discord_mod_role ]
This is a single discord role ID that will be permitted to use commands set to role "mod". this can only be a single role unlike DiscordWhitelistRoleIds. You can add other roles but you’ll have to follow the guide. You can get the role ID in the same way described under DiscordWhitelistRoleIds
DiscordAdminRoleId
[ Convar: discord_admin_role ]
This is a single discord role ID that will be permitted to use commands set to role "admin" OR "mod". Otherwise refer to DiscordModRoleId’s notes.
DiscordGodRoleId
[ Convar: discord_god_role ]
This is a single discord role ID that will be permitted to use all commands. Including "admin" and "mod". Otherwise refer to DiscordModRoleId’s notes.
Discord Bot Status
EnableBotStatusMessages
[ Convar: discord_enable_status ]
If this is set to "true" the bot will pick a random message from the BotStatusMessages config and display it as it’s status. (Example: “Playing FiveM”)
BotStatusMessages
The bot will pick a random message from this array every 30 seconds to set as it’s status if EnableBotStatusMessages is set to "true". you must have at least 1 of these if enabled. You can use {playercount}, {servername} or {invite} inside the status messages and when they’re shown they will replace those values with either the current number of players online, the server name set under FiveMServerName or invite set under DiscordInviteLink.
Ace Permissions
EnableAutoAcePermissions
[ Convar: discord_enable_ace_perms ]
If this is set to "true" it’ll enable a system of granting users Ace Permissions based on their role configured under AutoAcePermissions.
NOTE: This will only work if add_ace resource.zdiscord command allow is set in the server.cfg
AutoAcePermissions
If EnableAutoAcePermissions is set to "true" the configured ace permissions will be automatically given to users which have at least one of the matching roles. For example if you put "group.police": "DiscordPoliceRoleID", as one of the rows, if a user joined the server and had the DiscordPoliceRoleID in discord the bot will automatically set the group.police ace permission to them. On disconnect all ace permissions granted are removed.
By default the discord mod, admin and god roles are given group.mod, group.admin or group.god respectively.
Set a single role id with "example": "000000000000000000",. You can also have multiple discord roles checked for an Ace permission by using an array instead of a single roleId string like: "example2": [ "000000000000000000", "000000000000000000"],
NOTE: This will only work if add_ace resource.zdiscord command allow is set in the server.cfg
Other
saveScreenshotsToServer
[ Convar: discord_save_screenshots ]
If you want discord /screenshots to be saved locally to the server set this to "true" however if you just want the screenshots to be sent to discord when the command is used leave this as "false". Please note if you change this to true, it’s up to you to monitor your screenshots folder as images can be quite large and use a lot of space if they don’t get cleaned up regularly.
Webhook Logging Settings
EnableLoggingWebhooks
[ Convar: discord_enable_logging_webhooks ]
This setting enables the abilty to use the log export. if this is set to false the export will return false and not send the event.
LoggingWebhookName
[ Convar: discord_logging_name ]
This is the name to display in discord when the logs come through. Webhooks work slightly different from the normal bot and can have their own names or pictures set without issue, these “bots” however can’t read messages or show up in the user list, it’s just a one way message
LoggingAlertPingId
[ Convar: discord_logging_ping_id ]
This discord id will be pingged in the event a log is sent with true for pingRole. This can be used to give attention to an important log that a dedicated staff team might want to know about or deal with for example a monetary transaction over a certain amount might be suspicious and warrent a ping to this user or role. There can only be one id for this.
IMPORTANT NOTE: If you want to ping a user just put the ID, if you want to ping a role put a & in front of the role id**
LoggingWebhooks
This is the array of webhooks you setup to be used with the log system. it uses "key": "value", where key is the name (case sensitive) of the webhook for you to be able to call from the logging export as the first value