Appearance
Modules
This page lists module IDs currently documented for public API state queries.
Module IDs are case-insensitive in requests, but integrations should use the exact casing shown here.
| Module ID | Description |
|---|---|
Printer | Schematic Printer state, Printer runtime details, Printer settings, and server disable support. |
Minimap | Minimap module state. |
EasyPlace | Easy Place module state and server disable support. |
BestAdjust | Best Adjust module state and server disable support. |
TabList | Tab list ordering state and server restriction support. A virtual module, see Tab List. |
Only query modules listed on this page. Orbit may add more queryable modules later as the public API expands.
Module Extra Fields
Printer
Printer module objects include an extra object with read-only runtime details:
| Field | Type | Meaning |
|---|---|---|
printingEnabled | boolean | true when the Printer module is enabled and the internal Schematica printer loop is enabled. |
isPrinting | boolean | true when printingEnabled is true and Printer successfully placed a block in the last second. |
Use printingEnabled to know whether Printer is currently allowed to run. Use isPrinting as a live activity signal; it can be false while Printer is enabled if there is no loaded schematic, no block was placed recently, or Printer is waiting for delay, inventory, or placement conditions.
Server-Controllable Modules
Servers can disable and re-enable only the modules listed here.
| Module ID | Behavior |
|---|---|
Printer | Disables Schematic Printer for the current server session. |
EasyPlace | Disables Easy Place for the current server session. |
BestAdjust | Disables Best Adjust for the current server session. |
Server-Controllable Settings
Servers can restrict only the settings listed here.
| Module ID | Setting ID | Setting name | Behavior |
|---|---|---|---|
Printer | print360 | 360 Printer | Prevents 360-degree Printer placement while restricted. |
Printer | liquidPrinter | Liquid Printer | Prevents automatic liquid (bucket) placement while restricted. |
Printer | midairPlacement | Midair Placement | Forces adjacent-only placement while restricted: Printer will not click an empty target cell that has no solid neighbor, so blocks cannot be placed floating in midair. |
Minimap | playerRadar | Player Radar | Prevents player radar entries from being shown while restricted. |
TabList | orbitPlayersFirst | Orbit Players First | Keeps the default tab list order while restricted: Orbit Client does not move Orbit players to the top. |
Restrictions never modify the player's stored settings. The player's own values apply again when the restriction is removed or the player leaves the server.
Midair Placement
midairPlacement is a virtual setting over the player's Place Adjacent printer toggle — there is no toggle named "Midair Placement" in the client UI:
value: truemeans the player currently allows midair placement (theirPlace Adjacenttoggle is off).effectiveValuereports whether midair placement can actually happen right now.- While
midairPlacementis restricted, Printer behaves as ifPlace Adjacentis enabled. The player can still change thePlace Adjacenttoggle, but placements only happen against adjacent solid blocks until the restriction is lifted.
Tab List
TabList is a virtual module: the tab list is always on and players cannot turn it off, so it is always enabled and cannot be disabled with module.disable (module_not_supported). Its one setting can be restricted.
json
{
"id": "TabList",
"name": "Tab List",
"enabled": true,
"serverDisabled": false,
"settings": [
{
"id": "orbitPlayersFirst",
"name": "Orbit Players First",
"type": "boolean",
"value": true,
"serverControllable": true,
"serverDisabled": false,
"effectiveValue": true
}
]
}Orbit Players First
By default Orbit Client reorders the tab list: Orbit staff, then Orbit partners, then other Orbit Client players are listed above everyone else, each group keeping the default order within itself.
valueis alwaystrue: there is no player toggle for this ordering.effectiveValuereports whether Orbit is currently reordering the tab list.- While
orbitPlayersFirstis restricted, the tab list keeps Minecraft's default order, so the sorting your server sets up (for example with scoreboard teams) is shown as-is. Orbit logos next to Orbit players' names are still shown.
Restrict it after receiving the client's hello:
json
{
"v": 1,
"op": "setting.disable",
"moduleId": "TabList",
"settingId": "orbitPlayersFirst"
}Like every restriction, it clears when the player disconnects, so send it again on every join. The tab list can show Orbit's ordering for a moment between the join and your restriction arriving.