Overview

This documents the sandboxed Lua 5.4 scripting API that runs inside a Lynx game menu. The first category is for people who install and run scripts. The rest is for people who write them.

A script is one Lua file Lynx runs inside the game process, next to the menu. It reads game state through a set of globals and draws over the game’s frame. The API is modelled on gamesense: there is no lynx table, the globals are just there.

Everything above Games is present in every game. Each game adds one namespace of its own; find yours under Games.