Skip to content

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 IDDescription
PrinterSchematic Printer state, Printer runtime details, Printer settings, and server disable support.
MinimapMinimap module state.
EasyPlaceEasy Place module state and server disable support.
BestAdjustBest Adjust module state and server disable support.
TabListTab 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:

FieldTypeMeaning
printingEnabledbooleantrue when the Printer module is enabled and the internal Schematica printer loop is enabled.
isPrintingbooleantrue 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 IDBehavior
PrinterDisables Schematic Printer for the current server session.
EasyPlaceDisables Easy Place for the current server session.
BestAdjustDisables Best Adjust for the current server session.

Server-Controllable Settings ​

Servers can restrict only the settings listed here.

Module IDSetting IDSetting nameBehavior
Printerprint360360 PrinterPrevents 360-degree Printer placement while restricted.
PrinterliquidPrinterLiquid PrinterPrevents automatic liquid (bucket) placement while restricted.
PrintermidairPlacementMidair PlacementForces 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.
MinimapplayerRadarPlayer RadarPrevents player radar entries from being shown while restricted.
TabListorbitPlayersFirstOrbit Players FirstKeeps 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: true means the player currently allows midair placement (their Place Adjacent toggle is off).
  • effectiveValue reports whether midair placement can actually happen right now.
  • While midairPlacement is restricted, Printer behaves as if Place Adjacent is enabled. The player can still change the Place Adjacent toggle, 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.

  • value is always true: there is no player toggle for this ordering.
  • effectiveValue reports whether Orbit is currently reordering the tab list.
  • While orbitPlayersFirst is 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.

Orbit Client API Documentation