https://github.com/atrexus/unluau

A decompiler for Luau (Roblox's Lua based programming language: https://luau-lang.org/).
https://github.com/atrexus/unluau

csharp luau luau-decompiler luau-vm roblox

Last synced: about 21 hours ago
JSON representation

A decompiler for Luau (Roblox's Lua based programming language: https://luau-lang.org/).

• Host: GitHub
• URL: https://github.com/atrexus/unluau
• Owner: atrexus
• License: apache-2.0
• Created: 2022-09-26T22:30:01.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-07T05:40:43.000Z (2 months ago)
• Last Synced: 2024-11-05T19:20:31.163Z (8 days ago)
• Topics: csharp, luau, luau-decompiler, luau-vm, roblox
• Language: C#
• Homepage:
• Size: 527 KB
• Stars: 79
• Watchers: 5
• Forks: 19
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Unluau ![Workflow](https://github.com/valencefun/unluau/actions/workflows/dotnet.yml/badge.svg) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

A decompiler for Roblox's Lua based programming language (Luau https://luau-lang.org/). The Unluau project consists of two different .NET namespaces: ``Unluau`` (the main decompiler) and ``Unluau.CLI`` the command line interface for the decompiler. As of right now, Unluau is the most powerful Luau decompiler availible to the public, supporting most of Luau's opcodes and language features. With Unluau you can take a compiled Luau script and restore it to an accurate representation of what the original script may have been.

Unluau is still in early alpha and is receiving updates frequently. You can download and run any of the alpha versions in the [releases](https://github.com/valencefun/UnluauNET/releases) tab.

> **Disclamer:** Unluau is still in very early alpha so the decompiler is not flawless. There will most definitely be bugs that you will encounter when decompiling complex scripts. We are currently working on [v2.0.0-beta](https://github.com/atrexus/unluau/tree/v2.0.0-beta) and will no longer maintain the old alpha versions.

## Usage

After downloading the latest version in the [releases](https://github.com/valencefun/UnluauNET/releases) tab, you can refer to the manuals below to familiarize yourself with the different binaries availible to you.

* [Unluau CLI](docs/cli.md)

## Contributing

If you would like to implement a feature or fix a bug that we haven't gotten around to fixing, feel free to send a pull request and we will review it immediately. If you would like to contribute but don't know where to start, check out some of the known issues [here](https://github.com/valencefun/unluau/issues). We are passionate about open source learning and strongly suggest you get involved!