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

Internet

Call websites and APIs over https.

Functions

`http.request(spec, callback)`

Needs network

Make a request. callback is called later with the answer.

spec: HttpRequest
callback: fun(res: HttpResponse), optional

Returns integer id

`http.get(url, opts, callback)`

Needs network

Fetch an https address. callback is called later with the answer.

Name

Type

Returns integer id

`http.post(url, body, opts, callback)`

A table body is sent as JSON.

Name

Type

Returns integer id

Types

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

Your PC

The PC's numbers, battery and temperature, whether you are away, the game you play and the music that is playing.

Helpers

Small functions for text, lists and time.

On this page

Functions http.request(spec, callback)http.get(url, opts, callback)http.post(url, body, opts, callback)Types