Getting Started

Install kairo

Add the kairo behavior pack to your world. It acts as the communication hub between all your addons.

Download kairo from GitHub Releases.

Using kairo-router

Add kairo-router to your addon to start communicating with other addons.

Installation

pnpm add @kairo-js/router

Declare your APIs in the startup event

All API registrations and hook declarations must happen inside router.beforeEvents.startup.

import { router } from '@kairo-js/router'

router.beforeEvents.startup.subscribe((ev) => {
  // Register an API your addon provides
  ev.api.register<{ playerId: string }, { balance: number }>(
    'economy/getBalance',
    async ({ playerId }) => ({ balance: 100 }),
  )
})

Call other addons' APIs

// fire-and-forget
router.send('economy-addon', 'onTransaction', { amount: 50 })

// await result
const result = await router.request<{ balance: number }>(
  'economy-addon',
  'getBalance',
  { playerId: '...' },
)

if ('cancelled' in result) {
  console.log(result.reason)
} else {
  console.log(result.balance)
}

For the full API, see the kairo-router API Reference.