> ## Documentation Index
> Fetch the complete documentation index at: https://luau.limerence.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# Luau Scripts API

> Reference for Luau scripts and the api table.

Drop a `.luau` file into `limerence.biz/luaus/` and Limerence will run it for you. Your script runs once when it loads, gets an `api` table to work with, and can add menu controls, react to game events, and override built-in feature settings.

<CardGroup cols={2}>
  <Card title="Quick start" icon="rocket" href="/quick-start">
    Tab, widgets, saved values, and unload.
  </Card>

  <Card title="Game support" icon="gamepad" href="/game-support">
    Which namespaces exist per game, and how to write portable scripts.
  </Card>
</CardGroup>

## API sections

<CardGroup cols={2}>
  <Card title="API" icon="cube" href="/api/overview">
    The `api` table: `name`, `getGame`, `onUnload`, `ui`, `utility`, `bind`, `legitbot`, `ragebot`, `world`, `universal`, `feature`, `client`, `players`, `game`.
  </Card>

  <Card title="UI" icon="layer-group" href="/ui/overview">
    Tabs, sections, widgets, and handles.
  </Card>

  <Card title="Utility" icon="wrench" href="/utility/overview">
    `connect`, the asset index, `loadArchive`, and the config-loaded signal.
  </Card>

  <Card title="Bind" icon="keyboard" href="/bind/overview">
    Keybinds the user attached to UI elements.
  </Card>

  <Card title="Legitbot" icon="crosshairs" href="/legitbot/overview">
    Targeting, triggerbot, and influence hooks.
  </Card>

  <Card title="Ragebot" icon="bolt" href="/ragebot/overview">
    Automatic ragebot fire. Bloxstrike, Rivals, and Apocalypse Rising 2.
  </Card>

  <Card title="World" icon="earth-americas" href="/world/overview">
    World state. Bloxstrike, Rivals, Overkill, Phantom Forces, and Murderers vs Sheriffs Duels.
  </Card>

  <Card title="Universal" icon="globe" href="/universal/overview">
    Teach universal mode about a game without built-in support: characters, health, teams, weapons, hits, and NPC targets.
  </Card>

  <Card title="Feature" icon="puzzle-piece" href="/feature/overview">
    Per-feature namespaces: Auto Loot (AR2), Music HUD (every game), Auto Peek (Bloxstrike, Rivals, Overkill, MvSD), Anti Aim (Bloxstrike).
  </Card>

  <Card title="Client" icon="user" href="/client/overview">
    Your local player: shared core plus Bloxstrike, Rivals, and AR2 extras.
  </Card>

  <Card title="Players" icon="users" href="/players/overview">
    State for every other player in the match.
  </Card>

  <Card title="Game" icon="dice" href="/game/overview">
    Match state: bomb/hostages (Bloxstrike), match/placeables (Rivals), world pings (AR2), rounds (Phantom Forces), teams/matchmaking (Overkill), match/team (Murderers vs Sheriffs Duels).
  </Card>

  <Card title="Overrides" icon="bolt" href="/overrides/overview">
    Force a control's value without changing what the menu shows.
  </Card>

  <Card title="Types" icon="brackets-curly" href="/reference/types">
    Luau export types.
  </Card>
</CardGroup>

Anything you save lives at `luau.{api.name}.{key}`. Look up any control with [api.ui.find](/ui/overview#find).