Skip to content
ForgeCastDocs
Plugin SDKLua API reference

Talking to ForgeCast

Sounds, alerts, the app's version, links, and messages between plugins.

Functions

sounds.play(name)

Needs sounds

Play a sound from the Sound Library by its name (capital letters don't matter). Get sounds under Sound Library -> Find sounds, or upload your own. If there is no sound with that name, ForgeCast says so in a message.

  • name: string

alerts.show(spec)

Needs alerts

Show one of your alerts, as if it had happened on stream.

app.info()

Which ForgeCast is running: its version, the platform, and the plugin API number.

Returns AppInfo

app.open_url(url)

Open a web address in the browser (https only). Needs "app.open_url".

  • url: string

bus.emit(name, data)

Needs bus

Send a message to your other plugins.

  • name: string
  • data: any, optional

bus.on(name, handler)

Needs bus

Listen for messages from other plugins: handler gets { from = "plugin-id", data = … }.

  • name: string
  • handler: fun(msg: { from: string, data: any })

Returns integer id

bus.off(id)

Stop a handler made with bus.on.

  • id: integer

Returns boolean found

Types

Open a type to see its fields; type names above link here.

Storage, timers and data

Keep data, run things later, write to the console, read and write JSON.

Overlays

Put your plugin's own values (a timer, a score, a queue) into the streamer's overlays.

On this page

Functionssounds.play(name)alerts.show(spec)app.info()app.open_url(url)bus.emit(name, data)bus.on(name, handler)bus.off(id)Types