The Hello World plugin demonstrates the Multiforum plugin lifecycle at the
channel scope. When a file-enabled channel activates the plugin it will log a
message and write a lightweight info flag every time downloadable content is
created or updated.
- Runs whenever a
downloadableFile.createdordownloadableFile.updatedevent fires for the channel. - Calls the host-provided
ctx.storeFlag()helper so moderators can see when the hook executed. - Requires no configuration or secrets.
Because this is a sample plugin there are no settings to configure. The plugin
manifest still ships a form schema (see plugin.json) that renders a short
description so administrators can preview how manifest-driven forms appear in
the Multiforum UI.
This repository is the source of truth for hello-world. Plugin releases are versioned with Git tags in the form v<plugin.json version>.
npm install
npm run cinpm run ci validates plugin.json, runs Vitest, builds TypeScript, and creates a release bundle under out/.
- Update
plugin.jsonandpackage.jsonto the same version. - Commit the change.
- Tag the commit with
v<version>. - Push the tag.
The Publish Release workflow builds hello-world-<version>.tgz, writes a SHA-256 checksum, and uploads both artifacts to the GitHub Release.
Use this source URL in the Multiforum plugin registry:
{
"sourceRepoUrl": "https://github.com/gennit-project/multiforum-plugin-hello-world",
"releaseNotesUrl": "https://github.com/gennit-project/multiforum-plugin-hello-world/releases/tag/v0.2.2"
}