Skip to main content
Every script gets one api table. You can read its fields but not replace them. Limerence runs in more than one game, so which namespaces exist (and which calls live inside them) depends on where you are. See Game support before writing scripts meant to run in more than one game.

​
Members

​
string
required
Your script’s filename, without the .luau extension. Anything you save uses this as a prefix: luau.{api.name}.{key}.
​
table
required
Tabs, sections, widgets. UI overview.
​
function
required
The game you’re running in, as a lowercase name. See getGame below.
​
table
required
Signal connect, the asset index, archives, and the config-loaded signal. Utility.
​
table
required
Keybinds the user set on UI elements. Bind.
​
table
required
Aim / triggerbot state and hooks. Legitbot.
​
table
Automatic ragebot fire. Bloxstrike, Rivals, and Apocalypse Rising 2. Ragebot.
​
table
Bloxstrike, Rivals, Overkill, Phantom Forces, and Murderers vs Sheriffs Duels. World.
​
table
Universal mode only (any game without built-in support). Teach universal mode where characters, health, teams, and weapons live, report your hits and shots, and register NPC targets. Universal.
​
table
required
Groups per-feature namespaces. The table itself exists in every game; a sub-namespace is only present where its feature is, so check before using it: if api.feature.autoloot then ... end.
  • feature.autoloot: watch and shape Auto Loot. Apocalypse Rising 2 only. Auto Loot.
  • feature.musichud: every game. Music HUD.
  • feature.autopeek: drive Auto Peek. Bloxstrike, Rivals, Overkill, Murderers vs Sheriffs Duels. Auto Peek.
  • feature.antiaim: set the direction others see you facing. Bloxstrike. Anti Aim.
​
table
deprecated
Deprecated alias for api.feature.autoloot. Auto Loot.
​
table
required
Your local player: shared core plus per-game extras. Shared calls exist in Bloxstrike, Rivals, Apocalypse Rising 2, and universal mode; Phantom Forces and Overkill expose only the onHit / onKill signals. Client.
​
table
Every other player in the match. Present when the game has a player API (Bloxstrike, Rivals, Apocalypse Rising 2, universal mode). Players.
​
table
required
Match state. Contents differ per game (Bloxstrike: bomb and hostage; Rivals: match/environment/placeables; Apocalypse Rising 2: world pings/squad/zombies; Phantom Forces: match/rounds/dropped weapons/grenades; Overkill: match/teams/matchmaking/projectiles; Murderers vs Sheriffs Duels: match and team state). Game.
​
function
required
Run a callback once when the script unloads. See onUnload below.

​
getGame

The game you’re running in, as a lowercase name: "bloxstrike", "rivals", "apocalypse rising 2", "phantom forces", "overkill", "murderers vs sheriffs duels", or "operation one". In a game without built-in support it returns "universal". See Universal.

​
onUnload

Run your callback once when the script unloads (manual unload, file delete, or reload). Use this for anything auto-cleanup doesn’t handle, like stopping a listener you created with OnChange or OnUpdate.

UI

Utility

Bind

Legitbot

Ragebot

World

Universal

Feature

Client

Players

Game

Types