Configuration
Azul has two configuration layers:
- CLI user config (on your machine): default daemon behavior.
- Per-place config (inside Studio): project-specific overrides and push mappings.
CLI user config
Section titled “CLI user config”Use:
azul configto open your config file in your default editor, or:
azul config --pathto print its location.
Common fields:
| Field | Type | Description |
|---|---|---|
daemonPath | string | Path to the Desktop Daemon executable. |
port | number | Port used for communication between the Desktop Daemon and Studio Plugin. |
syncDir | string | Directory where the DataModel will be mirrored. |
sourcemapPath | string | Path for the generated sourcemap.json file. |
scriptExtension | string | Script extension (.luau by default). |
fileWatchDebounce | number | Delay used for local file watcher events. |
deleteOrphansOnConnect | boolean | Delete unmapped files on full snapshot. |
suffixModuleScripts | boolean | Suffix ModuleScripts with .module. |
checkForUpdates | boolean | Whether to check for updates on the NPM registry. |
debugMode | boolean | Enable verbose daemon logs. |
Plugin settings
Section titled “Plugin settings”Plugin settings are edited in the plugin UI in Studio.
Global plugin settings
Section titled “Global plugin settings”- Debug Mode: Extra plugin-side logging.
- Silent Mode: Reduces non-error plugin logs.
Global or project-scoped settings
Section titled “Global or project-scoped settings”- Scope: Apply as global defaults or per-place settings.
- WebSocket URL: Usually
ws://localhost:<port>and should match daemon port. - Service List + Service List Type: Include/exclude root services.
- Excluded Parents: Exclude paths (for example plugin-managed folders).
Per-place daemon config (ServerStorage.Azul.Config)
Section titled “Per-place daemon config (ServerStorage.Azul.Config)”For team workflows, you can store daemon overrides and pushMappings inside the place.
See Advanced Usage for a full example table and Lua config snippet.