Scarlett
Scarlett Configuration
Configure every major Scarlett config.js value, Discord ID, link, protection, and service setting.
General settings#
| Setting | What to enter | What it controls |
|---|---|---|
domain | https://YOUR_DOMAIN | Public domain used by features that construct website links. |
connectLink | https://cfx.re/join/YOUR_CODE | FiveM connect URL shown to users. |
TOKEN | YOUR_BOT_TOKEN | Private Discord bot token. |
clientID | YOUR_APPLICATION_ID | Discord Application ID used for command registration. |
footer | Your footer text | Footer displayed on supported embeds. |
BotName | Scarlett | Customer-facing bot name used by the application. |
serverName | Your Community | Community name displayed in status and embeds. |
maxPlayers | A number such as 64 | Configured FiveM capacity used by status output. |
PORT | An unused local port | Port used by Scarlett’s local HTTP service when enabled. |
authorizedUserIds | Array of Discord user IDs | Users authorized for specified legacy or protected actions. |
owners | Array of Discord user IDs | Product owner accounts. |
FiveM and internal services#
| Setting | What to enter | What it controls |
|---|---|---|
cfxServerCode | abc123 | The portion after cfx.re/join/ for the production server. |
cfxDevServerCode | A development join code or blank value | Optional development server connection. |
fivemServerIp | Reachable IP address or hostname | Host queried for FiveM status endpoints. |
fivemServerPort | Usually the configured FiveM port | Port used for status endpoint requests. |
scarlettApiCode | A long random secret | Authenticates compatible Scarlett API traffic; never expose it publicly. |
managerIp | Reachable Manager service host | Only required when the related Manager status integration is used. |
managerPort | Manager service port | Only required with the Manager status integration. |
Channels and roles#
| Setting | What to enter | What it controls |
|---|---|---|
statusChannelId | YOUR_CHANNEL_ID | Channel updated by the FiveM status system. |
escalationChannelId | YOUR_CHANNEL_ID | Destination for escalation workflows. |
banLogChannelId | YOUR_CHANNEL_ID | Ban logging destination. |
blacklistLoggingChannelId | YOUR_CHANNEL_ID | Blacklist log destination. |
gBanLoggingChannelId | YOUR_CHANNEL_ID | Global-ban log destination. |
guildLeaveLogChannelId | YOUR_CHANNEL_ID | Records guild departures. |
bypassRoleId | YOUR_ROLE_ID | Role allowed to bypass the corresponding protection. |
approveAndRevokeRoleIds | Array of role IDs | Roles authorized for approval and revocation actions. |
protectedRoleId | YOUR_ROLE_ID | Role protected by configured safeguards. |
memberRoleId | YOUR_ROLE_ID | Default verified/member role. |
rolestripAuthorizedRoles | Array of role IDs | Roles permitted to use role-strip workflows. |
altDetectionRoleId | YOUR_ROLE_ID | Role used by alternate-account detection workflow. |
altPingRoleId | YOUR_ROLE_ID | Role notified for alternate-account findings. |
escalationPingRoleId | YOUR_ROLE_ID | Role notified for escalations. |
Guild authorization and logging#
| Setting | What to enter | What it controls |
|---|---|---|
primaryGuildId | YOUR_GUILD_ID | Primary Discord server for product workflows. |
allowedGuilds | Array of numeric guild ID strings | Complete list of servers Scarlett may remain in. |
guildLogChannels | Object mapping guild IDs to channel IDs | Selects a logging channel for each authorized guild. |
Example
guildLogChannels: {
"YOUR_GUILD_ID": "YOUR_CHANNEL_ID",
"YOUR_SECOND_GUILD_ID": "YOUR_SECOND_CHANNEL_ID"
}Links, branding, and protection settings#
| Setting | What to enter | What it controls |
|---|---|---|
storeUrl | https://YOUR_DOMAIN/store | Store button or link. |
devOpsUrl | https://YOUR_DOMAIN/devops | Configured development or operations link. |
cadUrl | https://YOUR_DOMAIN/cad | CAD link. |
statusPageUrl | https://YOUR_DOMAIN/status | External status page. |
websiteUrl | https://YOUR_DOMAIN | Site button used by supported status output. |
logoUrl | Direct HTTPS image URL | Logo displayed by supported embeds. |
drakeUserId | A Discord user ID or disabled value | User-specific protection supported by the installed build. |
drake | Boolean | Enables the related protection only when intentionally configured. |
specialBotId | A Discord application user ID | Identifies the special bot used by a compatible protection. |
legacyRoleCommandUserIds | Array of user IDs | Limits supported legacy role commands. |
whitelistedChannels | Array of channel IDs | Channels exempted by compatible protection logic. |
Website links should normally begin with https://. Leave optional protection behavior disabled unless its required IDs and intended policy are understood.