Skip to content

Installation

Ludi is distributed through LuaRocks.

Terminal window
luarocks install ludi

The per-project install works like node_modules: rocks land in a local lua_modules directory instead of the system tree.

Prebuilt binary rocks are published for Linux and macOS (Lua 5.4, 5.5 and LuaJIT), so no Rust toolchain is needed.

On platforms without a prebuilt rock, LuaRocks falls back to building from source, which requires Rust installed.

  • Lua 5.1+ or LuaJIT (Lua 5.5 recommended)
  • LuaRocks 3.x
  • Rust (only when building from source)

If require("ludi") isn’t found after installing, load the LuaRocks paths into your shell:

Terminal window
eval "$(luarocks path)"