Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

API

What a plugin can reach. The Omegga, Player, Plugin, and Types pages are generated from the declarations in src/plugin.ts, which is also what ships as omegga.d.ts for typescript plugins.

Omeggathe server: players, bricks, saves, chat, minigames
Playerone player: position, roles, paint, clipboard
Pluginwhat a plugin class implements, and its config, store, and metrics
Eventswhat omegga emits as the server runs
Typesthe shapes the above return
Log parsingreading console output omegga does not already parse

JSON RPC plugins reach the same functionality through method names rather than these interfaces; that page has its own table.

Save data is brs-js SaveData.