addons (RPC & events)

Addon-to-addon communication separate from events (HTTP). Main process routes requests and event subscriptions between workers.

addons.request(targetAddonId, method, params?)

Call a handler registered in another enabled, running addon.

const res = await addons.request('other_addon', 'getChannelId', { platform: 'example' });
if (res.success) {
  console.log(res.result);
}

Returns { success: true, result? } or { success: false, message? }.

addons.onRequest(method, handler)

Expose a method to other addons.

addons.onRequest('getChannelId', async ({ fromAddonId, params }) => {
  console.log('Request from', fromAddonId);
  return { channelId: '12345' };
});

Handler receives { fromAddonId, params } and returns the response payload.

addons.offRequest(method)

Remove a previously registered handler.

addons.emit(event, data?)

Publish an event to every addon currently subscribed to this event on this addon. Delivery is fire-and-forget (handlers do not reply).

await addons.emit('streamOnline', { title: 'Live now' });

Returns { success: true, delivered } (delivered is how many running subscribers were notified) or { success: false, message? }.

addons.subscribe(sourceAddonId, event, handler)

Subscribe to events from another installed addon. The source may be disabled or not running yet; events are delivered when it emits while running.

const sub = await addons.subscribe('twitch', 'streamOnline', ({ fromAddonId, data }) => {
  console.log('Event from', fromAddonId, data);
});
if (sub.success) {
  // later: sub.Destroy();
}

Handler receives { fromAddonId, data }. Returns { success: true, id, Destroy } or { success: false, message? }.

Call Destroy() to unsubscribe. Multiple subscriptions to the same source+event are allowed.

addons.getInfo(addonIds?)

Read manifest and enabled status for installed addons. No extra permission.

Omit addonIds to return every installed addon. Pass an array of ids to query specific addons. Unknown ids are included with missing: true and enabled: false.

const all = await addons.getInfo();
if (all.success) {
  for (const addon of all.addons) {
    console.log(addon.id, addon.enabled, addon.manifest?.version);
  }
}

const pair = await addons.getInfo(['twitch', 'other_addon']);

Each entry: { id, enabled, manifest, missing }. manifest is the parsed manifest.json or null when files are missing.

Manifest dependencies

Use depends_on: ["other_addon"] in manifest.json when your addon requires another addon to be installed and enabled before activation.

When to use RPC vs events