> For the complete documentation index, see [llms.txt](https://docs.autowall.fun/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.autowall.fun/readme.md).

# Developer Platform

## <i class="fa-terminal">:terminal:</i> Lua Scripting Docs

Documentation for the **actual, implemented** in-app Lua scripting API — not the aspirational spec. Every function on these pages exists in the running code today.

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4><i class="fa-book-open">:book-open:</i></h4></td><td><strong>Documentation</strong></td><td>Runtime, quick start, basic types, globals, common helpers, and the implementation roadmap.</td><td><a href="https://docs.autowall.fun/documentation/introduction">https://docs.autowall.fun/documentation/introduction</a></td></tr><tr><td><h4><i class="fa-cubes">:cubes:</i></h4></td><td><strong>Vars</strong></td><td>Function-level reference: UI, Color, Vector, Entity, ESP, Math, Events, Render.</td><td><a href="https://docs.autowall.fun/documentation/vars">https://docs.autowall.fun/documentation/vars</a></td></tr><tr><td><h4><i class="fa-clock-rotate-left">:clock-rotate-left:</i></h4></td><td><strong>Changelog</strong></td><td>What's changed in the API and its documentation.</td><td><a href="https://docs.autowall.fun/changelog/">https://docs.autowall.fun/changelog/</a></td></tr></tbody></table>

### <i class="fa-rocket">:rocket:</i> Get started in one minute

```lua
local enabled = ui.switch("Lua", "example", "main", "draw", true)

events.render:set(function()
    if not enabled:get() then return end

    local w, h = render.screen_size()
    render.text("verdana", { w * 0.5, h * 0.9 }, { 1, 1, 1, 1 }, "hello", "c")
end)
```

{% hint style="info" %}
New here? Start with [Quick Start](https://docs.autowall.fun/documentation/quick-start), then keep [Vars](https://docs.autowall.fun/documentation/vars) open while you write scripts.
{% endhint %}

### <i class="fa-layer-group">:layer-group:</i> What's covered

| Area                                     | Where                                                                |
| ---------------------------------------- | -------------------------------------------------------------------- |
| Runtime, event loop, diagnostics         | [Introduction](https://docs.autowall.fun/documentation/introduction) |
| First script, logging, error handling    | [Quick Start](https://docs.autowall.fun/documentation/quick-start)   |
| Positions, colors, nil-checking, vectors | [Basic Types](https://docs.autowall.fun/documentation/basic-types)   |
| Frame/timing info                        | [Globals](https://docs.autowall.fun/documentation/globals)           |
| Timestamps, device info                  | [Common](https://docs.autowall.fun/documentation/common)             |
| Players, origins, props                  | [Entity](https://docs.autowall.fun/documentation/vars/entity)        |
| update/render loop, patterns             | [Events](https://docs.autowall.fun/documentation/vars/events)        |
| Text, geometry, world-to-screen          | [Render](https://docs.autowall.fun/documentation/vars/render)        |
| Vector math                              | [Vector](https://docs.autowall.fun/documentation/vars/vector)        |
| Color objects                            | [Color](https://docs.autowall.fun/documentation/vars/color)          |
| Persistent switches/sliders/etc          | [UI](https://docs.autowall.fun/documentation/vars/ui)                |
| Screen-space overlays                    | [ESP](https://docs.autowall.fun/documentation/vars/esp)              |
| Math helpers                             | [Math](https://docs.autowall.fun/documentation/vars/math)            |

{% hint style="warning" %}
Something not listed here probably isn't implemented yet — check the [Roadmap](https://docs.autowall.fun/documentation/roadmap-not-implemented-yet) before assuming a function exists.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.autowall.fun/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
