Skip to content

README.md

Latest commit

 

History

History
99 lines (73 loc) · 5.15 KB

README.md

File metadata and controls

99 lines (73 loc) · 5.15 KB
Raw

LuauAPI documentation

Summary

This folder holds all LuauAPI docs. Pages are grouped by audience. Start with the section that matches your goal. Read Documentation style before you edit or add pages.

LuauAPI is in beta. Expect API and doc changes.

Getting started

For mod authors who depend on LuauAPI and run .luau scripts from a Geode mod.

Read LuauAPI mod guidelines before you ship.

Page Role
Example mod template Complete project for a new LuauAPI mod
Getting started Runtime basics and threading
Installation Dependency and platform setup
Editor setup Autocomplete and stubs
Your first script First runFile from C++

Reference

API reference for scripts and C++ hosts.

Page Role
globals Full Lua module index and core globals
type stubs geode.d.luau reference

Start at globals for the full Lua module index.

C++

Page Role
C++ API reference Run functions, threading, and integration
Native C++ registration Expose a mod's typed C++ functions and values to Luau
Limits and errors Caps, deadlines, and error strings

Contributor

For people who build LuauAPI from source or work on the runtime and codegen.

Page Role
Architecture Runtime layout
Building from source Build steps
C++ standard C++23 and Geode utils
Testing Test map

Internals:

Page Role
Bindings framework Binding layer
ImGui draw scheduler ImGui frame scheduling
Module system require and sandboxes
Runtime Lua runtime lifecycle
Crash sidecar Luau context at native faults
Release-hook safety Safe CCObject::release hook
Task scheduler Main-thread tasks

Codegen:

Page Role
Codegen Codegen overview
CCArray methods CCArray binding rules
ccCArray read-only fields ccCArray field rules
Recursive containers Recursive container codegen
Pair containers Pair container codegen
Platform parity Cross-platform stubs

Policy and style

Page Role
LuauAPI mod guidelines Mod author policy
Documentation style How to write docs

Related

Source

  • docs/
  • mod.json
  • include/LuauAPI.hpp
  • include/NativeRegistration.hpp
  • src/
  • tools/luau_codegen/