# README

## Lune 🌙

[![Current Lune library version](https://img.shields.io/crates/v/lune.svg?label=Version) ](https://crates.io/crates/lune)[![CI status](https://shields.io/endpoint?url=https://badges.readysetplay.io/workflow/filiptibell/lune/ci.yaml) ](https://github.com/filiptibell/lune/actions)[![Release status](https://shields.io/endpoint?url=https://badges.readysetplay.io/workflow/filiptibell/lune/release.yaml) ](https://github.com/filiptibell/lune/actions)[![Current Lune library version](https://img.shields.io/github/license/filiptibell/lune.svg?label=License\&color=informational)](https://github.com/filiptibell/lune/blob/main/LICENSE.txt)

***

A standalone [Luau](https://luau-lang.org) script runtime.

Write and run scripts, similar to runtimes for other languages such as [Node](https://nodejs.org) / [Deno](https://deno.land), or [Luvit](https://luvit.io) 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 (\~3mb) 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](https://lune.gitbook.io/lune/home/installation) page to get started using Lune!


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://lune.gitbook.io/lune/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.