Skip to main content

CLI

Overview

A CLI command is a single, named game action that can be invoked by id with an explicit parameter list - for example, setting the current Zoi's mood, fast-forwarding the in-game clock, or spawning an object. Each command has a stable contract, so external code can drive the simulation safely without poking at internal data directly.

The inZOI CLI is a standalone integration layer, not bound to any single host language. The same command catalog is reachable from every embedded runtime that ships with the game - JavaScript inside UI Mods, Lua scripts, and other host environments - each via its own invoke API. UI Mods are just one common caller; the parameter contracts described on these pages apply unchanged everywhere else.

Pick a category below to see its commands. Each command has its own page with parameters and a usage example.

Categories

CategoryCommands
ambition3
appearance30
autonomy2
bag2
bio1
buff2
build13
building11
camera3
career10
character1
cleaning3
cli2
contacts1
currency3
curseforge5
data6
disaster1
emotion3
entity19
environment14
event2
facial2
fx1
gameplay4
gedcom1
graphics5
hope10
household6
illness1
interaction7
l10n1
life_and_death3
lua_module2
luamod1
marriage4
memory11
mod1
motion6
movement10
needs3
object1
optimization3
pregnancy_and_birth3
quality_of_life3
relationships9
schedule1
settings3
simulation5
site1
skill3
smartbuild12
social_event4
sound3
stat6
status_and_health2
system1
toast2
uimod12
uimod3d4
view4
visual6
weather1
world2
zoi2
zoi_group9
Total318

Calling a command

Every host runtime exposes its own invoke API, but the shape is always the same: pass a command id and a parameter object. The snippet below uses the JavaScript binding from a UI Mod - other hosts (Lua, etc.) provide an equivalent call.

// Example host: a UI Mod's JavaScript.
await window.inzoi.cli.execute('<command-id>', { /* params */ });