Skip to content

Home Account Welcome to ForgeCast

Get started

Quick start Account & plans

Connect

Connect the desktop app Connect your YouTube channel Connect OBS

Stream and create

Using the app AI features and credits Widgets, overlays and themes The Editor Troubleshooting

Build on ForgeCast

Getting started plugin.json and permissions

Guides

Chat and streams Build an interface Data, timers and the internet Testing and debugging The sandbox and its limits Publish a plugin Sell a plugin

Examples and reference

Example plugins

Lua API reference

Chat Streams Notifications and dialogs Interface elements Windows Dashboard sections The plugin itself Storage, timers and data Talking to ForgeCast Overlays OBS AI Past streams Chat commands and tools Counters, queues, countdowns, leaderboards Data tools Plugin tools Speech, clipboard and the app More interface elements Money, events, goals, channel YouTube Hotkeys, buttons, lights The microphone Tips, services, Discord Channel points and viewers Your PC Internet Helpers

Plugin SDK Lua API reference

Streams

The streams being watched: viewers, likes and when they start and end.

Functions

`stream.list()`

Needs stream.read

The streams being watched (Developer mode can watch several at once).

Returns StreamState[]

`stream.state()`

Needs stream.read

Totals over all streams being watched.

Returns StreamTotals

`stream.on(event, handler)`

Needs stream.read

Listen for stream events (Event.StreamUpdate, StreamStart, StreamEnd, StreamAdded, StreamRemoved).

event: string
handler: fun(state: StreamState)

Returns integer id

`stream.off(id)`

Stop a handler made with stream.on.

id: integer

Returns boolean found

Types

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

Chat

Read chat, listen for it, and filter it before anyone sees it.

Notifications and dialogs

Pop-up notifications, messages, questions and your own dialogs.

On this page

Functions stream.list()stream.state()stream.on(event, handler)stream.off(id)Types