Skip to main content

Share your app

MnemoHub is one way out. The other is a link.

Anyone running Mnemosyne OS can install your cartridge from a public repository URL. No listing, no review, no waiting. You send the link, they paste it, the app reads your manifest and installs.

What your user does​

MnemoHub → Apps → "Add an external cartridge" → "A repository", paste the URL, then "Install".

Before anything is written to disk, the app downloads the repo, reads mnemo-plugin.json and shows the cartridge's name and version for confirmation.

Git is not required on their machine. The install is an HTTPS tarball.

The one free slot​

  • Without a license: one external cartridge, free.
  • With an active Engramm license: unlimited.

Two things to know:

  • Store apps never count. The limit is on side-loading, so anything installed from the signed catalog leaves the free slot untouched.
  • Both doors share the slot. A folder from disk and a repo URL spend the same one.

What your repo needs​

The same four rules as a store submission:

  1. mnemo-plugin.json at the repo root.
  2. entrypoints.renderer set to "index.html", relative. A http://localhost:5185/… entrypoint points at a dev server your user does not run.
  3. dist/ committed. The mnemo-plugin:// protocol serves dist/<file> first, and no build runs on your user's machine.
  4. base: './' in vite.config.ts. An absolute /assets/… path 404s under the custom protocol.

github.com, gitlab.com or bitbucket.org, over HTTPS. Anything else is refused before a byte is downloaded.

Shipping an update​

An install pulls the default branch as it stands. Push, and the next person gets it.

Bump version in mnemo-plugin.json on every change. It is the number your user sees at confirmation.

Making it easy to say yes​

A cartridge runs inside Mnemosyne OS, and the app says so at the confirmation step. The sandbox bounds it: no Node, no Electron, no filesystem, every capability behind a permission your user granted.

  • Ask for the minimum permissions. A cartridge that never declares vault:write is visibly harmless.
  • Keep the source readable in the repo people install from.
  • Write a README naming what the cartridge stores, and where.

When to use the store instead​

MnemoHub is for being found rather than sent: a listing, a category, an icon, and an install that costs your users nothing from their free slot. Signed, human reviewed, gated on an active Engramm license.

Both routes carry the same repo. The publish button is in Your first cartridge.