Publish a plugin
Share your plugin in the marketplace from the app, what is packed into it, and how new versions work.
Finished plugins can go in the plugin marketplace, where other streamers install them from the app with Plugins → Marketplace. Plugins, both publishing and installing, are part of Pro and Ultimate (plans).
Get it ready
Check plugin.json (fields): the id is the plugin's address in the marketplace and can't be changed later, the name and description are what people read, and permissions lists only what it uses (why that matters). A homepage, if you give one, must start with https://.
Publish
Open Plugins in the app and press Publish on your plugin's card. You can add a line about what changed. The plugin appears in the marketplace straight away.
Publish a new version
Raise version in plugin.json (1.0.0 to 1.0.1 or 1.1.0) and press Publish again. A version that isn't higher than the published one is refused, and so is a pre-release of it (1.0.0-beta comes before 1.0.0). The marketplace shows the new version straight away.
What is packed
Everything in the plugin's folder, with these limits:
| Rule | Detail |
|---|---|
| File types | Only .lua, .json, .md and .txt files. |
| Left out | Anything whose name starts with a dot, files or folders: .forgecast/, .vscode/, .luarc.json. Those are your editor's, not the plugin's. |
| Size | At most 64 files and 1 MB in all. |
| Paths | Folders at most 4 deep (lib/ui/parts/list.lua), names of letters, digits, ., _ and -. Names Windows reserves (con, nul, aux, prn, com1, lpt1 and so on) can't be used. |
The app checks all of this before it sends anything and tells you what to fix.
Who made it
| Badge | Meaning |
|---|---|
| ForgeCast with a verified check | Made and looked after by the ForgeCast team. Only ForgeCast staff can publish these, or new versions of them. |
| Community | Made by a creator like you. ForgeCast doesn't check these plugins, so the app shows a warning before anyone installs one. |
The id belongs to whoever published it first: nobody else can publish under it, even after the plugin is removed.
Taking it down
A plugin you published can be taken out of the marketplace again. Nobody new can find or install it then; people who already have it keep their copy. ForgeCast can also hide or remove a plugin that breaks the rules.
Treat what you publish as public
Anyone with the plan can download your files and read them. Never put passwords, tokens or other secrets in a plugin.