Game support

Limerence runs in more than one game (Bloxstrike, Rivals, and others). The api you get is built for whatever game you’re currently in, so some parts of it change from game to game. There are two kinds of namespace.

Shared vs game-specific

Shared namespaces are there in every game:

Namespace	What it’s for
api.ui	Building your menu.
api.utility	Little helpers.
api.bind	The user’s keybinds.
api.client	You (your local player). The common stuff is there in Bloxstrike, Rivals, Apocalypse Rising 2, and universal mode, and each game adds a few of its own extras. Phantom Forces and Overkill expose only the `onHit` / `onKill` signals.
api.players	Everyone else. There whenever the game has a player API (Bloxstrike, Rivals, Apocalypse Rising 2, universal mode). What each player handle gives you depends on the game.
api.legitbot	Aim assist / triggerbot, in games that have one.

Game-specific namespaces only show up in some games:

Namespace	Games
api.game	Every game has one, but what’s inside is totally different per game. Bloxstrike gives you bomb and hostage info, Rivals gives you match/environment/placeables, Apocalypse Rising 2 gives you world pings, squad, and zombies, Phantom Forces gives you match, rounds, dropped weapons, and grenades, Overkill gives you match, teams, matchmaking, and projectiles, Murderers vs Sheriffs Duels gives you match and team state.
api.ragebot	Bloxstrike, Rivals, and Apocalypse Rising 2.
api.world	Bloxstrike, Rivals, Overkill, Phantom Forces, Murderers vs Sheriffs Duels.
api.universal	Universal mode (any game without built-in support).
api.feature.autoloot	Apocalypse Rising 2.
api.feature.musichud	Every game.
api.feature.autopeek	Bloxstrike, Rivals, Overkill, Murderers vs Sheriffs Duels.
api.feature.antiaim	Bloxstrike.

api.feature groups per-feature namespaces. The table itself exists in every game; a sub-namespace is only there where its feature is, so check before using it: if api.feature.autoloot then ... end.

Universal mode

In a game Limerence has no built-in support for, it loads universal mode and api.getGame() returns "universal". You still get api.ui, api.utility, api.bind, api.client, api.players, and api.legitbot, plus api.universal for teaching universal mode where that game keeps characters, health, teams, and weapons.

Reading the docs

The call tables in the api.* pages are split by game so you can tell at a glance where something works:

All: works in every game (as long as that namespace exists in your game).
Bloxstrike: only when you’re in Bloxstrike.
Rivals: only when you’re in Rivals.
AR2: only when you’re in Apocalypse Rising 2.

The UI / control pages (Toggle, Slider, Colorpicker, and so on) aren’t tagged. Those work everywhere.

Writing scripts that work in any game

api.client and api.players share the same core, and then each game piles its own extras on top (for example, Rivals adds api.client.getEnvironmentId(), isInDuel(), and getDisplayElo()). If something is game-specific, it just isn’t there in other games. It won’t error, so check that a call exists before you use it, or branch on api.getGame():

if api.client.isInDuel and api.client.isInDuel() then
    -- Rivals-only path
end

if api.game.getBomb then
    -- Bloxstrike-only path
end

if api.getGame() == "rivals" then
    -- Rivals-only path
end

The type definitions are a superset across all games, so a field being in the type doesn’t guarantee it exists at runtime. Guard game-specific calls the same way.

Getting started

Concepts

Shared vs game-specific

Universal mode

Reading the docs

Writing scripts that work in any game

​Shared vs game-specific

​Universal mode

​Reading the docs

​Writing scripts that work in any game

Shared vs game-specific

Universal mode

Reading the docs

Writing scripts that work in any game