lune/README.md
2023-09-17 13:03:38 -05:00

2.2 KiB



A standalone Luau script runtime.

Write and run scripts, similar to runtimes for other languages such as Node / Deno, or Luvit for vanilla Lua.

Lune provides fully asynchronous APIs wherever possible, and is built in Rust 🦀 for optimal safety and correctness.

Features

  • 🌙 A strictly minimal but powerful interface that is easy to read and remember, just like Luau itself
  • 🧰 Fully featured APIs for the filesystem, networking, stdio, all included in the small (~4mb) executable
  • 📚 World-class documentation, on the web or directly in your editor, no network connection necessary
  • 🏡 A familiar scripting environment for Roblox developers, with an included 1-to-1 task scheduler port
  • ✏️ Optional built-in library for manipulating Roblox place & model files, and their instances

Non-goals

  • Making scripts short and terse - proper autocomplete / intellisense make scripting using Lune just as quick, and readability is important
  • Running full Roblox game scripts outside of Roblox - there is some compatibility, but Lune is meant for different purposes

Where do I start?

Head over to the Installation page to get started using Lune!