A shared Luau runtime for Geode mods
with many awesome features and tools.

LuauAPI

Heads up: LuauAPI is still in beta, so expect things to change. LuauAPI development will NOT support older versions of GD, Geode SDK, bindings, and dependencies.

Before you start

You are expected to already have:

• Basic Geode modding knowledge. Learn Geode SDK here.
• A working knowledge of Lua or Luau scripting.
• Experience using VS Code.

Optionally, you can learn these along the way.

Docs

Read the documentation index. It links getting started, reference, and contributor docs.

Start here if you are new:

• Overview
• Installation
• Editor setup
• Your first script
• Examples
• Lua module index
• LuauAPI example mod template
• LuauAPI mod guidelines

Join the Discord for help.

Example mod template

Start new projects from the LuauAPI example mod template. It already includes the LuauAPI dependency, Luau resources, editor config, and first script. See Installation for the Geode CLI and Download ZIP setup paths.

Example mod contributors

The local luauapi-example-mod/ copy is a Git submodule. Include it when cloning LuauAPI:

git clone --recurse-submodules https://github.com/ItMe12s/LuauAPI.git

For an existing clone:

git submodule update --init --recursive

Project

Special thanks to:

• Juniper (Testing, Debugging)
• Erymanthus (Testing, Debugging)
• YellowCat98 (Testing)

In-game:

• About
• Changelog
• Support

Licenses

• Catch2
• cgltf
• Dear ImGui
• {fmt}
• gd-imgui-cocos
• Geode SDK
• GLM
• Isocline
• IXWebSocket
• JetBrains Mono
• Luau
• mbedTLS
• stb