The Plugins screen: what a card tells you, what Install does, how a plugin from elsewhere is pinned to the code the owner approved, and how to get yours listed.
Words, blocks and reading time for the page you are on. Updates as you type.
installed in the accent once it is on this device, or off while it is switched off.local only, or uses the network when its Network line names something.no numbers yet while the server has none for it, the last numbers it saw when offline, and numbers need the server before this device has heard from the server at all.The catalog is src/plugins/catalogue.ts, and it is data. Each entry is built to /plugins/<id>.js with its dependencies bundled in, and the service worker keeps every one, so the whole catalog installs offline. Translate and Summarize install offline too, but their first run downloads a runtime and a model (Translate, a model for each language pair), which needs the network and is kept in the browser’s cache, not by the service worker.
| You | What happens | What the server hears |
|---|---|---|
| Install | Twig imports the module and calls its default export. It runs now and at every launch. | The plugin’s id and nothing else: no account, no device, no graph. |
| Install, and it fails | It stays listed, switched on, with the error beside it; fixing the URL means removing it and adding it again. | Nothing: a plugin that did not load was not installed. |
| Switch off | Everything it registered is undone. It stays installed, in its place. | Nothing. |
| Switch on | It is imported and started again. | Nothing. |
| Remove | Switched off and taken off this device’s list. | Nothing. |
| Another device installs it | With Sync installed plugins on, this device installs it to match. | Nothing: only an install by hand is counted. |
| Delete local data | Every plugin is switched off, and Sync installed plugins turns off on this device; the list stays, so nothing has to be found again. | Nothing. |
| Line | Says | Left empty |
|---|---|---|
| Reads | What it looks at. | Not stated by its author, on a plugin listed by URL. |
| Changes | What it writes, adds or navigates to. | Not stated by its author, on a plugin listed by URL. |
| Network | What leaves the device, and where it goes. | Nothing leaves this device, and the card says local only. |
A plugin that lives somewhere else is listed from the office, the owner’s console at /office. Listing it pins it: from then on every device runs the exact bytes the owner approved, or nothing.
x-: at most 50 characters with the prefix. No built-in id may start with x-, so a future built-in can never take an added plugin’s place.| Rule | What it means |
|---|---|
| Listing id and hash | Installing from the card records which listing it is and the approved hash on the device’s entry, and in the synced list. The device finds it again after the office moves its URL, and can check it before it has the listing at all. |
| SHA-384, every start | The device fetches the module, hashes it, and imports those bytes and nothing else. It keeps a copy by hash, so the plugin also starts offline, checked again. |
| Nothing to check, no start | An entry with no approved hash does not start, and neither does one whose listing id the listing no longer has. |
| Other code at the URL | The plugin does not start, and its card says This plugin’s code changed since it was approved. |
| One bundled file | A relative import cannot resolve from the checked bytes. An import from an absolute URL is fetched as it is, and is not checked. |
| The same bytes for everyone | The module must serve every client the same file. A CDN that builds per browser (esm.sh, for one) cannot be pinned, and an address that redirects (an unversioned jsDelivr or unpkg link) is refused: list the versioned one. |
| 5 MB | A module over 5 MB is refused, whether its Content-Length says so or it is counted as it arrives. |
| Previous URLs | A URL the office moves a plugin away from stays with that plugin: devices that installed it there still find it, and no other plugin can be listed there. |
| Removal is a kill switch | Removing leaves a tombstone. Every device that has the plugin turns it off at its next look at the listing — at launch, on opening Plugins, or when its window comes back into view, at most once a minute — and says Removed from the marketplace by its owner. Its installs and ratings stay, it takes no new ones, and its name and URL stay taken. Restore brings it back, numbers and all, but a device that turned it off leaves it off until someone switches it on there. |
Code changed and the hash it found. The public listing carries that flag too, but devices do not act on it: they go on checking against the approved hash, and refusing anything else.| The office can | Built-in | Listed by URL |
|---|---|---|
| Hide: out of the marketplace, still working and listed on a device that has it | Yes | Yes |
| Feature: listed first | Yes | Yes |
| Reword the blurb and the three lines. Emptied on a built-in, a line goes back to the plugin’s own words | Yes | Yes |
| Change the URL or the version | No | Yes, pinning again |
| Remove, leaving a tombstone | No: hide it instead | Yes |
The office is for the accounts named in TWIG_ADMIN_EMAILS that are also on TWIG_ALLOWED_EMAILS. Until the first is set, every account on the second is an admin, so it has to be set before that list holds anyone but the owner. It is reached at /office, and from a row in Settings that only admins see; the server answers 401 without a sign-in and 403 to anyone else. The marketplace fetches the listing with the numbers and remembers it; a device that has never reached the server shows the catalog alone.
| Door | How | What you get |
|---|---|---|
| The catalog | A pull request: a directory under src/plugins/catalogue/ with an index.ts whose default export is the plugin, and one more entry in src/plugins/catalogue.ts with its name, kind, blurb and the three lines. | Built with every release, served from Twig’s own address, installable offline. Not pinned, because it is Twig’s own code. |
| The office | Publish one bundled ES module with a default export over https, allowed by CORS, the same bytes to every client, under 5 MB, at an address that does not redirect. Send the owner its URL, a name, the kind, the version, a blurb and the three lines. | A card like any other, pinned to the code the owner read. |
Ship a change at a new URL or version, or ask the owner to re-approve; until then devices keep refusing the new code. There is no review queue: listing is the owner’s choice, and the office can vouch for a plugin no more than the catalog can.
The field at the bottom of the screen takes any ES module served over https, or from this site. It is brought in with a dynamic import, so it has to be reachable, served as JavaScript, and allowed by CORS. Nothing added there is counted or rated; it is between you and wherever it came from. A module the office has listed is the exception: added from its card, at its URL, or at a URL the office moved it from, it is that card’s plugin, checked against its approved hash like one installed from the card. A built-in’s own path, /plugins/<id>.js, is that built-in’s card.