Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

LuauToolkit

A collection of various Luau-related libraries.

[!WARNING] LuauToolkit is deeply unstable and is far from production ready.

Structure

Modules

The library is split into the following:

ModuleDescription
bytecode[WIP] Module for working with Luau bytecode.[docs]
[src]
[examples]

Binaries

Some modules also have command line applications, accessible under the bin/ directory.

Examples

A series of examples can be found under the examples/ directory.

You can run an example with:

lune run examples/<path_to_example> [args]

# eg:
lune run examples/bytecode/strip chunk.luauc stripped.luauc

Documentation

Documentation can be found here.

Installation

To install luau_toolkit, copy the lib/ directory to wherever you'd like to install the library, and rename it to luau_toolkit.

Optionally, create an @luau_toolkit alias in your .luaurc file to make the library accessible with require("@luau_toolkit/<module>"):

{
    //...
    "aliases": {
        "luau_toolkit": "./path/to/library"
    }
    //...
}