Skip to content

Configuration

Azul has two configuration layers:

  1. CLI user config (on your machine): default daemon behavior.
  2. Per-place config (inside Studio): project-specific overrides and push mappings.

To open your config in your default editor, run:

Terminal window
azul config

To print the path to your config file, run:

Terminal window
azul config --path
FieldTypeDescription
portnumberPort used for communication between the Desktop Daemon and Studio Plugin.
syncDirstringDirectory where the DataModel will be mirrored.
sourcemapPathstringPath for the generated sourcemap.json file.
scriptExtensionstringScript extension (.luau by default).
fileWatchDebouncenumberDelay used for local file watcher events.
deleteOrphansOnConnectbooleanDelete unmapped files on full snapshot.
suffixModuleScriptsbooleanWhether to suffix ModuleScripts with .module (e.g. Foo.module.luau).
checkForUpdatesbooleanWhether to check for updates on the NPM registry.
debugModebooleanEnable verbose daemon logs.
liveFsSync.enabledbooleanReplicate filesystem actions (create, delete) to Studio during live sync
liveFsSync.usePollingbooleanUse polling for file watching instead of native OS events.
liveFsSync.pollingIntervalnumberPolling interval in milliseconds.

Plugin settings are edited in the plugin UI in Studio.

Per-place daemon config (ServerStorage.Azul.Config)

Section titled “Per-place daemon config (ServerStorage.Azul.Config)”

This file can be generated through the plugin UI by scrolling down, and clicking on “Open Place Configuration”

See the dedicated Per-place Daemon Config page for more information on this feature.