Skip to content

Installation

LuneBlox is one executable named luneblox. It has no installer and no runtime dependencies.

Rokit is the toolchain manager most Roblox projects use. From your project directory:

Terminal window
rokit add XopoIII/LuneBlox luneblox

Check that it runs:

Terminal window
luneblox --version

Releases are published to GitHub only. Nothing goes to crates.io.

Each release carries one zip file per target, named luneblox-<version>-<os>-<arch>.zip:

Target Archive for 0.11.3
Linux x86_64 luneblox-0.11.3-linux-x86_64.zip
Linux aarch64 luneblox-0.11.3-linux-aarch64.zip
macOS x86_64 luneblox-0.11.3-macos-x86_64.zip
macOS aarch64 luneblox-0.11.3-macos-aarch64.zip
Windows x86_64 luneblox-0.11.3-windows-x86_64.zip
Windows aarch64 luneblox-0.11.3-windows-aarch64.zip

The archive holds the binary, luneblox (luneblox.exe on Windows), and LICENSE.txt. Unzip it and put the binary in a directory on your PATH.

The release also carries SHA256SUMS.txt, with the SHA-256 checksum of each archive. To check a download, run this in the directory that holds it:

Terminal window
sha256sum --check --ignore-missing SHA256SUMS.txt

Building needs a Rust toolchain with Cargo and a C++ compiler: Luau’s C++ sources are compiled as part of the build.

  1. Clone the repository. The build uses the copy of Luau’s sources in vendor/luau0-src, so a checkout of the whole repository is required.

    Terminal window
    git clone https://github.com/XopoIII/LuneBlox.git
    cd LuneBlox
  2. Build the release binary:

    Terminal window
    cargo build --release
  3. The binary is target/release/luneblox (luneblox.exe on Windows). Copy it to a directory on your PATH.

The command is luneblox, not lune, so it installs next to an upstream Lune rather than in its place. Both can be on the same PATH and in the same rokit.toml.

The two runtimes share only the things that make scripts portable: the script folders (lune and .lune) and the @lune/* library names. See Migrating from Lune.

LuneBlox writes nothing until you use a command that needs to:

What Written by Location
Type definitions luneblox setup ~/.luneblox/.typedefs/<version>/
Base executables for other targets luneblox build --target target/ inside the cache directory
REPL history luneblox repl .luneblox_history inside the state directory

The cache and state directories depend on the platform and can be moved with LUNEBLOX_CACHE and LUNEBLOX_STATE. Directories lists every location and the order they are chosen in.

Run a first script in the quick start, then set up completion and type checking in Editor setup.