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¶
| Category | Commands |
|---|---|
| ambition | 3 |
| appearance | 30 |
| autonomy | 2 |
| bag | 2 |
| bio | 1 |
| buff | 2 |
| build | 13 |
| building | 11 |
| camera | 3 |
| career | 10 |
| character | 1 |
| cleaning | 3 |
| cli | 2 |
| contacts | 1 |
| currency | 3 |
| curseforge | 5 |
| data | 6 |
| disaster | 1 |
| emotion | 3 |
| entity | 19 |
| environment | 14 |
| event | 2 |
| facial | 2 |
| fx | 1 |
| gameplay | 4 |
| gedcom | 1 |
| graphics | 5 |
| hope | 9 |
| household | 6 |
| illness | 1 |
| interaction | 7 |
| l10n | 1 |
| life_and_death | 3 |
| marriage | 4 |
| mod | 1 |
| motion | 6 |
| movement | 9 |
| needs | 3 |
| object | 1 |
| optimization | 3 |
| pregnancy_and_birth | 3 |
| quality_of_life | 3 |
| relationships | 9 |
| schedule | 1 |
| settings | 3 |
| simulation | 5 |
| site | 1 |
| skill | 3 |
| smartbuild | 12 |
| social_event | 4 |
| sound | 3 |
| stat | 6 |
| status_and_health | 2 |
| system | 1 |
| toast | 2 |
| uimod | 12 |
| view | 4 |
| visual | 6 |
| weather | 1 |
| world | 2 |
| zoi | 2 |
| zoi_group | 9 |
| Total | 298 |
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 */ });