For the complete documentation index, see llms.txt. This page is also available as Markdown.

Configuration Reference

Explanation of the Street Signs configuration options.

Street Signs uses config.lua for customer-facing configuration.

Core Settings

Config.PermissionMode

Controls how Street Signs checks access for creating, editing, deleting, and admin tools.

Available options:

  • ace

  • standalone

  • qb

  • esx

Config.DefaultTheme

Sets the default color theme used when a new sign is created.

Example:

Config.DefaultTheme = 'amber'

Config.EnabledPacks

Turns built-in sign packs on or off.

Default values:

Pack summary:

  • base: Core built-in signs

  • billboard: Billboard-style displays

  • street: Street and warning sign options

  • vehicles: Vehicle-mounted board options

Config.EnableFloatingTextPreview

If enabled, Street Signs can show floating preview text when the normal display mode is not being used.

Interaction and Display Settings

Config.InteractionDistance

How close a player must be to interact with a nearby sign.

Default:

Config.MaxLinesPerSign

Maximum number of text lines the script will allow on a sign.

Default:

Config.DefaultLineMaxLength

Default character limit used for individual sign lines.

Default:

CAD Settings

Config.CAD.enabled

Enables or disables Sonoran CAD related support.

Config.CAD.syncOnStartup

Controls whether CAD-related sign synchronization actions should happen during startup.

Config.CAD.shareIconCatalog

Used for icon-related workflows when applicable.

Config.CAD.allowRemoteGridUpdates

Allows remote grid-style updates when the related workflow is in use.

Config.CAD.allowRemoteImageUpdates

Allows remote image-style updates when the related workflow is in use.

Default block:

Power Integration Settings

Config.Power.enabled

Turns power integration support on or off.

Config.Power.mode

Selects the expected power integration mode.

Default block:

Webhook Settings

Config.Webhooks.enabled

Master toggle for Discord webhook support.

Config.Webhooks.username

Default webhook username for Street Signs posts.

Config.Webhooks.avatarUrl

Default avatar image URL for webhook messages.

Config.Webhooks.signChanges

Controls webhook messages for sign create, update, and delete events.

Important fields:

  • url

  • username

  • avatarUrl

  • color

Config.Webhooks.bannedWordAlerts

Controls webhook messages for blocked banned-word attempts.

Important fields:

  • url

  • username

  • avatarUrl

  • color

  • mentionRoleIds

Default block:

Auto Update Settings

Config.Updater.EnableAutoUpdate

Enables the updater flow.

Default:

If you turn auto-update on, make sure the helper resource is installed and the required command ACE permissions are granted. See FAQ and Troubleshooting.

Permissions Configuration

Config.AcePermissions

Used when Config.PermissionMode = 'ace'.

Config.QBJobs

Used when Config.PermissionMode = 'qb'.

The value can be:

  • A minimum grade number

  • A list of exact allowed grades

Example:

This means:

  • police = 3: police grade 3 or higher

  • dot = {0, 2}: only DOT grades 0 or 2

  • admin = 0: admin grade 0 or higher

Config.ESXJobs

Used when Config.PermissionMode = 'esx'.

Example:

Config.StandaloneAllowed

Used when Config.PermissionMode = 'standalone'.

Add allowed player identifiers here:

Content Moderation

Config.BannedWords

This list blocks sign content that matches banned phrases or words.

Use this section to adjust moderation rules for your community.

Important note:

Street Signs uses substring matching, so broad or short entries may block more than you expect. Review changes carefully before using the script on a live server.

Built-In Defaults You Normally Do Not Need To Change

Street Signs also applies built-in defaults for its controller URL, display pipeline, and some internal behavior. Most customers should leave those alone and focus on the documented config.lua options above.

Last updated

Was this helpful?