Docs

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

Developer API

Plugin SDK

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

Dashboard sections

Add your own box to the Dashboard.

Functions

`Section:render(tree)`

Show a new interface in this Dashboard section.

tree: UiNode

`Section:remove()`

Remove this section from the Dashboard.

`dashboard.section(spec)`

Needs ui.dashboard

Add a section to the Dashboard with an interface of your own: inputs, buttons, lists…

spec: SectionSpec

Returns Section

`dashboard.remove(id)`

Remove a Dashboard section you added.

id: string

Types

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

Windows

Open windows of your own.

The plugin itself

Its settings panel and what to do when it is turned off.

Dashboard sections

FunctionsCopy Anchor Link

Section:render(tree)Copy Anchor Link

Section:remove()Copy Anchor Link

dashboard.section(spec)Copy Anchor Link

dashboard.remove(id)Copy Anchor Link

TypesCopy Anchor Link

SectionSpecCopy Link