ctx.notify

ctx.notify (PluginNotifier) shows a toast or plays a sound. You describe what to show and which sound to play, and the shell renders it.

await ctx.notify.toast({
  type: "warning",
  title: "Gate required",
  message: "Please enter your departure gate.",
  durationMs: 8000,
});

await ctx.notify.playSound("attention");
await ctx.notify.playCustomSound("assets/DepGateAlert.wav");

When to use it: to surface a passive heads-up that needs no response. If you need an answer back from the pilot, use ctx.dialog or ctx.prompt instead.

`toast()`

Show a non-blocking toast notification in the shell UI.

await ctx.notify.toast({
  type: "info" | "success" | "warning" | "error",
  title: string,
  message: string,
  durationMs?: number, // defaults to the shell's global setting
  id?: string,         // deduplicate repeated toasts
});

`playSound(name)`

Play one of the shell’s built-in semantic sounds. name is a BuiltInSound:

Value	Description
`"attention"`	A neutral chime to draw the pilot’s eye
`"success"`	Positive completion tone
`"error"`	Negative alert tone

await ctx.notify.playSound("attention");

Obeys the user’s notification-sound setting — if the pilot has sounds off, the call resolves silently.

`playCustomSound(assetPath)`

Play a sound file bundled inside your plugin. assetPath is relative to the plugin root (e.g. "assets/DepGateAlert.wav"). Requirements:

The file must live under assets/ in your plugin directory — anything under assets/ is shipped with the plugin bundle automatically.
Allowed file types: wav, mp3, ogg, m4a, aac.
Obeys the user’s notification-sound setting.

export default createPlugin({
  async onStart(ctx) {
    await ctx.notify.playSound("attention");
    await ctx.notify.playCustomSound("assets/DepGateAlert.wav");
  },
});

`sound(name)` deprecated

sound() is deprecated — use playSound() instead. Legacy names (alert/warning/chime) now map onto a real bundled file rather than silently failing, so existing calls continue to work. New plugins should use playSound(name: BuiltInSound).

// Old — still works, but prefer playSound()
await ctx.notify.sound("warning"); // "alert" | "warning" | "error" | "success" | "chime"

Getting Started

Plugin Basics

UI Module

Background Module

Deploy

Type Reference

`toast()`

`playSound(name)`

`playCustomSound(assetPath)`

`sound(name)` deprecated

​toast()

​playSound(name)

​playCustomSound(assetPath)

​sound(name) deprecated

`toast()`

`playSound(name)`

`playCustomSound(assetPath)`

`sound(name)` deprecated