### Install Azul via npm Source: https://github.com/ransomwave/azul/blob/main/README.md Installs the Azul CLI globally using npm. Ensure Node.js is installed first. ```powershell npm install azul-sync -g ``` -------------------------------- ### Install Node.js on Linux Source: https://github.com/ransomwave/azul/blob/main/README.md Installs Node.js and npm on Linux using the apt package manager. ```powershell # Linux (using apt) sudo apt install nodejs npm ``` -------------------------------- ### Simple Script Sync Example Source: https://github.com/ransomwave/azul/wiki/Sync-details Illustrates the mapping of a single server script from Roblox Studio to its filesystem equivalent. ```text - Roblox: `ReplicatedStorage.Modules.MyServerScript` - Filesystem: `sync\ReplicatedStorage\Modules\MyServerScript.server.luau` ``` -------------------------------- ### Install Azul Globally Source: https://github.com/ransomwave/azul/blob/main/README.md Installs the built Azul project globally after manual build, making the 'azul' command available. ```powershell npm install -g . ``` -------------------------------- ### Install Node.js on Windows Source: https://github.com/ransomwave/azul/blob/main/README.md Installs the Node.js LTS version on Windows using the winget package manager. ```powershell # Windows (using winget) winget install OpenJS.NodeJS.LTS ``` -------------------------------- ### Install Azul Dependencies Source: https://github.com/ransomwave/azul/blob/main/README.md Installs project dependencies using npm after cloning the repository. ```powershell npm install ``` -------------------------------- ### Start a New Azul Sync Session Source: https://github.com/ransomwave/azul/wiki/Getting-started Run this command in your local folder to initiate a sync session with a Roblox Studio place. Ensure you have an empty folder and a place open in Studio. ```bash azul ``` -------------------------------- ### Install Node.js on macOS Source: https://github.com/ransomwave/azul/blob/main/README.md Installs Node.js on macOS using the Homebrew package manager. ```powershell # macOS (using Homebrew) brew install node ``` -------------------------------- ### Install and Push Dependencies with Azul Source: https://github.com/ransomwave/azul/blob/main/plugin/README.md Install local dependencies and push modified dependencies back to the plugin using Azul. This is for contributors wishing to modify plugin dependencies. ```powershell # Install dependencies rokit install wally install # After modifying dependencies, push the changes to the plugin azul push -s .\Packages -d ReplicatedFirst.AzulCompanionPlugin.Packages # Generate Wally package types # Note: wally-package-types will complain because Azul doesn't include Wally link files, ignore the warnings since it'll still work wally-package-types --sourcemap .\sourcemap.json .\sync\ReplicatedFirst\AzulCompanionPlugin\Packages\ ``` -------------------------------- ### Build Azul Project Source: https://github.com/ransomwave/azul/blob/main/README.md Builds the Azul project after installing dependencies, typically for manual installation. ```powershell npm run build ``` -------------------------------- ### Build Plugin with Azul Source: https://github.com/ransomwave/azul/blob/main/plugin/README.md Build the plugin directly from source code using Azul. Ensure you are in the plugin directory and have the plugin installed in Studio. ```powershell # Move into the plugin directory cd plugin # Build the plugin using the generated sourcemap azul build --from-sourcemap .\sourcemap.json ``` -------------------------------- ### Nested Script Sync Example Source: https://github.com/ransomwave/azul/wiki/Sync-details Shows how nested scripts in Roblox Studio are represented as folders and files in the filesystem sync. ```text - Roblox: `ServerScriptService.Game.ParentScript.NestedScript` - Filesystem: - `sync\ServerScriptService\Game\ParentScript.server.luau` - `sync\ServerScriptService\Game\ParentScript\NestedScript.server.luau` ``` -------------------------------- ### Main Azul Command Source: https://github.com/ransomwave/azul/wiki/Commands The primary command for interacting with Azul. Running it without arguments starts the Daemon. ```bash azul [command] [options] ``` -------------------------------- ### Clone Azul Repository Source: https://github.com/ransomwave/azul/blob/main/README.md Clones the Azul project repository from GitHub. This is part of the manual installation process. ```powershell git clone https://github.com/Ransomwave/azul.git ``` -------------------------------- ### Push Wally Packages with Azul Source: https://github.com/ransomwave/azul/wiki/Advanced-Azul-usage Push packages installed via Wally into your Roblox project using the `azul push` command. Rojo compatibility mode is required as Wally is Rojo-only. ```bash azul push -s Packages -d ReplicatedStorage.Packages --destructive --rojo ``` -------------------------------- ### Build an Existing Azul Project into Studio Source: https://github.com/ransomwave/azul/wiki/Getting-started Use this command to push an existing local Azul project into a Roblox Studio place. Open your local project folder and connect to Studio afterward. ```bash azul build ``` -------------------------------- ### Azul Build Command Source: https://github.com/ransomwave/azul/wiki/Commands Builds the Azul project in the current directory. Use `--from-sourcemap` to determine instance types from a sourcemap. ```bash azul build [options] ``` -------------------------------- ### Azul Pack Command Source: https://github.com/ransomwave/azul/wiki/Commands Serializes Studio instance properties into sourcemap.json for hermetic builds. Note that not all property types can be serialized. ```bash azul pack [options] ``` -------------------------------- ### Configure Wally Package Push Mapping Source: https://github.com/ransomwave/azul/wiki/Advanced-Azul-usage Define a push mapping in the per-place daemon configuration to automate pushing Wally packages. This allows running `azul push` without arguments. ```lua -- Example push mapping for Wally packages in the per-place daemon configuration pushMappings = { { source = "Packages", destination = { "ReplicatedStorage", "Packages" }, destructive = true, rojoMode = true, }, } ``` -------------------------------- ### Per-Place Daemon Configuration ModuleScript Source: https://github.com/ransomwave/azul/wiki/Advanced-Azul-usage Configure Azul daemon settings on a per-place basis by returning a table from this ModuleScript. This allows for different configurations across projects. ```lua -- ServerStorage/Azul/Config -- Returned table is sent to the Azul daemon when it connects. return { -- TCP port the daemon should be listening on (defaults to 8080 in the CLI config). port = 8080, -- Emit extra debug logs from the Studio plugin/daemon handshake. debugMode = false, -- When the daemon connects, delete files in the sync directory that are -- not mapped to any instances. Keeps the local mirror clean between sessions. deleteOrphansOnConnect = true, -- One or more push mappings: each maps a local folder into a DataModel path. pushMappings = { -- Push mapping 1; map "Packages" folder to "ReplicatedStorage.Packages": { -- Local folder to push (relative to the repo root where you run `azul push`). source = "Packages", -- Destination path segments inside Studio (dot-separated in UI becomes array here). destination = { "ReplicatedStorage", "Packages" }, -- If true, wipe all children under the destination before applying the push. destructive = true, -- Use Rojo compatibility mode when pushing. rojoMode = true, }, -- Push mapping 2; map "src/Server" folder to "ServerScriptService.Server": { source = "src/Server", destination = { "ServerScriptService", "Server" }, -- Keep existing children that aren't in this snapshot. destructive = false, }, }, } ``` -------------------------------- ### Azul Config Command Source: https://github.com/ransomwave/azul/wiki/Commands Opens the Azul configuration file in your default editor. Use the `--path` option to display the config file location. ```bash azul config [options] ``` -------------------------------- ### Configure Luau-LSP for Azul in VSCode Source: https://github.com/ransomwave/azul/blob/main/README.md Configures the Luau Language Server extension in VSCode's User Settings (JSON) for optimal Azul project development. Ensures IntelliSense and sourcemap support. ```json "luau-lsp.plugin.enabled": true, "luau-lsp.sourcemap.enabled": true, "luau-lsp.sourcemap.autogenerate": false, "luau-lsp.sourcemap.sourcemapFile": "sourcemap.json", "luau-lsp.sourcemap.includeNonScripts": true, ``` -------------------------------- ### Azul Push Command Source: https://github.com/ransomwave/azul/wiki/Commands Pushes files from a source folder to a destination in the Azul sync directory. Supports Rojo project compatibility mode. ```bash azul push [options] ``` -------------------------------- ### Update Azul Daemon Source: https://github.com/ransomwave/azul/wiki/Installation Use this command to update the Azul Daemon to the latest version globally via npm. ```powershell npm update -g azul-sync ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.