Lua API reference
Every function, argument and type a ForgeCast plugin can use.
This reference is written from the same file your editor reads (forgecast.d.lua), so it is always the API of the app you downloaded. The same text appears in the app under Plugins → SDK & reference.
Functions that need a permission show it as a badge; list it in your plugin.json.
| Page | What is in it | Functions |
|---|---|---|
| Chat | Read chat, listen for it, and filter it before anyone sees it. | 8 |
| Streams | The streams being watched: viewers, likes and when they start and end. | 4 |
| Notifications and dialogs | Pop-up notifications, messages, questions and your own dialogs. | 7 |
| Interface elements | The building blocks of every window, Dashboard section, settings panel and dialog. | 23 |
| Windows | Open windows of your own. | 8 |
| Dashboard sections | Add your own box to the Dashboard. | 4 |
| The plugin itself | Its settings panel and what to do when it is turned off. | 3 |
| Storage, timers and data | Keep data, run things later, write to the console, read and write JSON. | 18 |
| Talking to ForgeCast | Sounds, alerts, the app's version, links, and messages between plugins. | 7 |
| Overlays | Put your plugin's own values (a timer, a score, a queue) into the streamer's overlays. | 20 |
| OBS | See OBS's scenes and audio, switch scenes, mute inputs, show or hide sources, and hear what changes. | 19 |
| AI | Ask ForgeCast's AI, paid with the streamer's credits. | 7 |
| Past streams | The streams recorded on this PC and the week's numbers. | 5 |
| Chat commands and tools | Chat commands with cooldowns and roles, rate limits, waiting for a viewer's answer, emotes. | 12 |
| Counters, queues, countdowns, leaderboards | Ready-made pieces that save themselves, draw their own Dashboard controls and fill your overlays. | 35 |
| Data tools | Tables in storage, CSV, hashes and signatures, QR codes, redacting private details, time and schedules. | 28 |
| Plugin tools | Keeping state through reloads, updates, optional permissions, secrets, settings, calls between plugins, libraries, assets, translations, metrics and tests. | 23 |
| Speech, clipboard and the app | Speak out loud, copy text, add a page, Ctrl+K commands, chat menu items, name badges, charts, tabs and pickers. | 25 |
| More interface elements | Grids, stats, timers, markdown, menus, kanban boards, ratings and the other building blocks for rich pages. | 41 |
| Money, events, goals, channel | Amounts in the streamer's currency, the app's events, goals shared with overlays, and the channel's videos and schedule. | 15 |
| YouTube | Chat as the channel, run polls, moderate the live chat, change the stream's title and read how the stream is doing. | 13 |
| Hotkeys, buttons, lights | Global hotkeys, buttons on the phone remote and the Stream Deck, smart lights, Home Assistant and MIDI controllers. | 18 |
| The microphone | Voice commands and live captions, with Windows' own speech recognition. | 4 |
| Tips, services, Discord | Tips from Ko-fi, Streamlabs and StreamElements, the streamer's Spotify and Google, and their Discord server. | 8 |
| Channel points and viewers | One points wallet for the channel, redeems, predictions, and the viewers who keep coming back. | 24 |
| Your PC | The PC's numbers, battery and temperature, whether you are away, the game you play and the music that is playing. | 16 |
| Internet | Call websites and APIs over https. | 3 |
| Helpers | Small functions for text, lists and time. | 12 |
Downloads
forgecast.d.lua: the whole API, annotated for the Lua language server. ForgeCast writes it into every plugin's.forgecast/folder for you.plugin.schema.json: a JSON schema forplugin.json, for completion and validation in VS Code.