Simple Luau Disassembler (.js)

Provides a function to produce a dump of Luau (0.620) instructions as a string

Supported Platforms

This library was created without the intent of being widely used, so currently the only supported platform is Windows (my personal machine).

If you need additional platform support, feel free to submit an issue on this repo and I'll get to it asap.

Example

Disassembling Scripts

This Javascript code

import disassembler from "simple-luau-disassembler";

const { disassemble } = disassembler;

disassemble("print'hi'");

produces this output

[__unnamed_function__]
GETIMPORT R0 1 [print]
LOADK R1 K2 ['hi']
CALL R0 1 0
RETURN R0 0

Disassembling Bytecode

import disassembler from "simple-luau-disassembler";

const { disassembleBytecode } = disassembler;

const bytecode = await readFile("path/to/your/binary/bytecode/file");

disassembleBytecode(bytecode);

[__unnamed_function__]
GETIMPORT R0 1 [print]
LOADK R1 K2 ['hello world']
CALL R0 1 0
RETURN R0 0

Disassembling Bytecode (Encoded)

Bytecode versions from the Roblox client have encoded instructions; to support this behavior, pass in the "roblox" flag into the second parameter of disassembleBytecode

import disassembler from "simple-luau-disassembler";

const { disassembleBytecode } = disassembler;

const bytecode = await readFile("path/to/roblox/encoded/bytecode/file");

disassembleBytecode(bytecode, "roblox");

[__unnamed_function__]
GETIMPORT R0 1 [print]
LOADK R1 K2 ['Hello world!']
CALL R0 1 0
RETURN R0 0

Build Instructions

After forking/cloning

cd simple-luau-disassembler.js

Install node-gyp

npm i -g node-gyp

Run node-gyp's configure command (any errors will help you find out what build tools you need, if you don't have them already)

node-gyp configure

After resolving errors, you should be able to run the build command just fine

node-gyp build

This will create a new build directory in which the binary .node file is located, which is what you're going to use when calling require or import