daniel543x/effectcraft
1
0 Fork 0
mirror of https://github.com/storytold/effectcraft.git synced 2026-11-06 02:20:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a439b1bb19051c339e46c59166f39fac25812406
effectcraft/examples/plugin-catalog/README.md
T
iseemhlyftaClaude Opus 5.5FredApps
 4e8398f8ca G8: Plug-in Library: install, preview and update community WebAssembly effects (#2524) 
* G8: plug-in library

Community Plug-in Library for WebAssembly effect plug-ins (#376): one
reviewed catalog (index.json), install / update / remove from Settings >
Plug-in Library (also Effect > Plug-in Library...), library.* commands,
start-up loading of installed packages with SHA-256 checks. Downloads go
through the system curl (https, GitHub hosts), as trained models do.

Preview before installing (library.preview): the release is downloaded,
checked like an install, and rendered in the sandbox on a built-in sample
frame at default settings (2 s at 12 fps) with a Before/After split, plus
the effect's parameters, "Open on GitHub" and an optional author video
link (catalog field preview.video). Authors need to do nothing for it.

Hardening: a module that fails to load leaves the installed copy alone,
Update All updates every package in one job, minApp also applies to an
explicit version, curl ignores ~/.curlrc and URL globbing, unique temp
files, percent-decoded file URLs. Plug-in effect slots grow from 64 to
256 with a clearer overflow error.

Docs: plugins.md "Plug-in Library", publishing-plugins.md (author guide
from zero to listed), gaps.md; examples/plugin-catalog is the starting
content of the catalog repository (schema, validation workflow).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* contributors: credit iseemhlyfta

* G8: plug-in library: doc comments on the library's functions

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* G8: plug-in catalog check: require one object with schema 1 and a packages array

An empty file or several JSON values passed jq empty, and with
SKIP_SCHEMA=1 nothing else checked the catalog's shape.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* G8: plug-in library: one preview texture set; catalog schema requires effects

The preview kept a texture set per package version previewed (about
6 MB each) for the whole session; it now keeps one, replaced when
another package is previewed. Releases in the catalog schema must list
at least one effect id, as the author guide says.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* G8: plug-in catalog schema: effect ids follow the manifest's id rules

Letters, digits, '.', '_' and '-', and not the reserved 'ec.' prefix,
so library.missing can match them.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* G8: refuse Plug-in Library jobs while automation file access is confined

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* G8: split the Plug-in Library page into toolbar, card, links and actions

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* G8: show Plug-in Library toasts without a Roto job; cache preview frame checks

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* G8: log Plug-in Library packages that fail to load at start-up

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* G8: check an update before replacing a loaded package; Update All past failures

- An update to a package that is already loaded is now compiled and its manifest checked
  (through the previewer, without registering it) before the new file is written and the old
  version's folder deleted. Before, a release with the right SHA-256 that didn't load replaced
  the working version and failed at the next start.
- Package ids that differ only in case, or end in a dot, would share one folder on Windows and
  macOS: the catalog keeps the first of them, and ids can't end in a dot (schema too).
- Update All: a package that can't be picked or installed no longer stops the others; the
  result names what was updated and what wasn't.
- Downloads: at most 5 redirects, and one that ends off GitHub's hosts is refused, as the module
  docs say.
- A job that panics no longer leaves the library busy; poisoned status locks are used, not
  dropped.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* G8: rustfmt the update test

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: FredApps <153173854+FredApps@users.noreply.github.com>
2026-11-05 05:51:17 +01:00

3.0 KiB
Raw Blame History

EffectCraft plug-ins

The community catalog of WebAssembly effect plug-ins for EffectCraft. The app's Plug-in Library (Settings ▸ Plug-in Library) reads index.json from this repository, then downloads, checks and installs the packages people pick. Plug-ins run in EffectCraft's sandbox: they can't read files, open the network or crash the app.

This repository holds only the catalog. Each plug-in's code and .wasm live in its author's repository, attached to a GitHub release.

Submit a plug-in

  1. Build your plug-in and attach the .wasm to a GitHub release. The full guide is Publishing plug-ins.
  2. Add one entry to the packages array of index.json. example-entry.json shows every field; schema.json is the exact format. To publish a new version, add a release to your package's versions rather than editing an old one.
  3. Check it locally: scripts/validate.sh (needs bash, jq, curl, sha256sum and Node; set EFFECTCRAFT_CLI to an effectcraft-cli build to also install it with the real loader).
  4. Open a pull request. CI runs the same script; a maintainer reviews the rest.

Review checklist (maintainers)

CI checks the format, unique ids, each download's size and SHA-256, and that EffectCraft installs and loads the package. Before merging, also check:

  • The id is new, stable and names the author (reverse domain style: io.github.user.name). Ids never change and are never reused.
  • repo is a public repository with the plug-in's source, and its licence is open (the license field matches it).
  • Every url is a release asset of that repository (not a branch file, which can change).
  • The release builds from the tagged source; spot-check large or obfuscated modules.
  • effects lists the effect ids the module registers, and they don't clash with another package's.
  • name, description and tags are accurate; no Adobe names, logos or assets.
  • preview.video, if given, is a short demo of the effect hosted on GitHub or a well-known video site.
  • A change to an existing package comes from its author (or with their agreement), and old releases keep their url and SHA-256.

Create this repository from the template

The template lives in EffectCraft at examples/plugin-catalog/.

  1. Create the empty public repository storytold/effectcraft-plugins (branch main, so the app's catalog URL https://raw.githubusercontent.com/storytold/effectcraft-plugins/main/index.json resolves).
  2. Copy README.md, index.json, example-entry.json, schema.json and scripts/ to its root, and validate.yml to .github/workflows/validate.yml.
  3. Keep scripts/validate.sh executable (git update-index --chmod=+x scripts/validate.sh).
  4. Protect main: require pull requests and the Validate check.
Reference in new issue View Git Blame Copy Permalink