Configuration

Configure Azul to your liking!

Daemon

Azul ships with built-in defaults, then loads a user config file from your OS config directory at startup.

You can use azul config to open the config the config file in your OS default editor/app:

Setting	Type	Default	Description
port	Number	8080	Port used for communication between the Desktop Daemon and Studio Plugin.
syncDir	String	./sync	Directory where the DataModel will be mirrored.
sourcemapPath	String	./sourcemap.json	Path to the generated sourcemap.json file. This file maps synced instances to their corresponding files in the sync directory.
scriptExtension	String	.luau	File extension to use when syncing scripts. Can be set to the older .lua if you prefer.
deleteOrphansOnConnect	Boolean	true	Whether to delete unmapped files in the sync directory after a new connection/full snapshot. These files are those that don't correspond to any instance in the DataModel. They could be leftovers from previous syncs or files created manually in the sync directory.
debugMode	Boolean	false	Enable or disable debug logging. When enabled, Azul will print detailed logs about its operations, which can be helpful for troubleshooting issues.
suffixModuleScripts	Boolean	false	Whether to suffix ModuleScripts with .module before the file extension (e.g. MyModule.module.luau).

The config file itself can be found at the following locations:

• Windows: %APPDATA%/azul/config.json
• macOS: ~/Library/Application Support/azul/config.json
• Linux: $XDG_CONFIG_HOME/azul/config.json (or ~/.config/azul/config.json if XDG_CONFIG_HOME is not set)

Plugin

The plugin's settings can be edited from the GUI or by editing AzulSync.luau:

The following settings are always "Global":

• Debug Mode: Enable or disable debug logging.
• Silent Mode: Suppress all Plugin print statements except for errors.

The following settings can be set to a "Global" or "Project" scope:

• Scope: Whether settings should be global (applies to all projects) or per-project (applies only to the currently opened Place).
• Websocket URL: Port used for communication between the Desktop Daemon and Studio Plugin. (ws://localhost:yourport)
• Service List: List of services to include/exclude based on the selected List Type.
  • Service List Type`: Whether the service list is treated as a whitelist or blacklist.
• Excluded Parents: Parents to exclude from syncing (i.e. ServerStorage.RecPlugins, a Folder managed by an external plugin you don't want to sync).