betavoidbase is in public beta. It runs, the API is PocketBase's and is not moving, and the version is still 0.x for everything around that.Help us get it to 1.0

Publish a plugin

Not built yet pb_plugins does not exist. There is no manifest format, no loader, and nothing to install into, so nothing listed as a plugin can be used.

Then why is the form open?

Because the loader is being designed now, and a format designed against imagined plugins is a format that fits none of the real ones. The submission asks what your plugin would need from voidbase: which hooks, which routes, which collections, whether it wants a screen in the admin panel, whether it needs background work. Those answers are the useful part, and they are worth more to us at this stage than a listing is to you.

Submitting also means you are told when the format lands, rather than finding out from a changelog.

The plugin submission form takes a public repository, which can be a README describing the idea. A submission is recorded rather than audited, because there is nothing yet to audit it against and inventing checks for a format we are about to change would only teach people to satisfy the wrong ones.

What is decided

  • Plugins live in a pb_plugins directory beside your hooks, the way installed things sit beside your own code everywhere else.
  • A plugin declares what it needs, and is installed and updated by name rather than copied in.
  • A plugin can add routes, hooks, collections and admin panel screens. That set is what makes the format hard and is why it is taking a while.
  • Core plugins ship with voidbase, official ones are ours and versioned with it, and anyone can publish their own through the marketplace.

What is not

  • The manifest: what it declares, and in what language.
  • Permissions. A plugin that can add routes and read collections is a plugin that can do damage, so what it has to ask for, and how that is checked against what it actually does, is the part that decides whether any of this is safe to use.
  • Versioning and compatibility: what happens when voidbase changes underneath a plugin.
  • Whether plugins run in the same isolate as your hooks, and what that means for a plugin's failures.

The roadmap carries the design as it stands, and the Discord is where the open questions above get argued about. If you have built a plugin system before and any of this looks wrong, that is the most useful thing you could tell us.

Found something wrong on this page?

Fix it yourself. The link below opens this file in GitHub's editor and forks the repository for you if you need one, and your change becomes a pull request without leaving the browser.