ficelloo / luaudebugger

Instrumentation Toolkit for Luau Scripts

About

Lua Debugger is an attempt at writing a Luau instrumentation toolkit , that reversers can use to deobsfucate and analyze malicious Luau code.

It's still a work in a progress and lacks a lot of features , but hey you gotta start somwhere :)

Note : I think that for now this project is windows only , since stuff like Dump Constants relies on hooking code that is specific to MSVC, maybe one day i will port it to linux ?

Images

Features

• Run Luau Code in a fully sandboxed environnement separated from your computer
• Technical Documentation of the various custom functions available in the environnement
• A notes tab where you can take note of anything that you see in the script and you want to remember

NEW (interessant stuff that u should checkout)

• New lua api parser here

TODO :

Roblox Simulator

• Very Urgent : Write a metatable generator
• Urgent : Rewrite python parser (50% Done)

Luau VM

• Add Documentation
• Log all actions happening
• Place hooks on lua C functions on the fly and inspect their values
• Add a bytecode viewer

Window

• Add a way to save/read the code to a file (using UntitledOpen)

Design Research

I'm currently attempting an architecture design through UML diagrams like nomnoml

Technologies used

• luau

• UntitledImGuiFramework

• RCMP

• ImGuiColorTextEdit

How to build ?

Video Tutorial (Recommended) : Coming soon

Getting the dependencies :

Download UntitledImGuiFramework through git :

git clone https://github.com/MadLadSquad/UntitledImGuiFramework.git --recursive

Then go into your directory and run chmod +x install.sh && ./install.sh with git bash, this will setup the base framework.

Then copy this repo into UntitledImGuiFramework/Projects and then cd into it and run submodule update --init --remote --merge --recursive, when you're done go follow the steps in Project Generation

Project generation :

Windows only for now.

Run generate.bat and then you can build the project normally just like any other cmake project.

Credits

@ElCapor - Main Developer

@Ficello - Gave me the idea of deobsfucating Luau code for fun

@Azateix - Very cool guy

@Madman10k - The creator of UntitledImGuiFramework , who kindly spend over 4 hours helping me with the project generation and setup, and still continues to help me