Skip to content

Repository files navigation

faderpunk-community-apps

Community-submitted apps for Faderpunk — unofficial, unmaintained by the core team, and without guarantees.

Faderpunk firmware with FPApp support can install these apps individually from the Configurator. Installing an app does not replace the firmware.

The repository keeps app source, manual entries, and the catalogue together, plus the small build and review tools needed to keep them trustworthy. See CONTRIBUTING.md for the submission format and rules.

Browse what each community app does before building anything: the community manual — same look as the official manual, built from this repo's catalog.

Layout

  • apps/<name>.rs — one file per app, same pattern as official Faderpunk apps.
  • manual-tab.json — one entry per app, matching the same ManualAppData shape the official configurator uses for its manual tab, stored as data (JSON) rather than .tsx source — never executable code. Validated against manual-tab.schema.json.
  • apps-catalog.json — one entry per app (appId, module, author), validated against apps-catalog.schema.json. Its appId links to the matching manual-tab.json entry.

Community app IDs start at 100 (official apps use 1–99) and are permanent once assigned.

Build installable apps

Clone this repository and Faderpunk next to one another, then build every catalogued app:

make fpapps

The .fpapp files are written to build/fpapps/. Each package includes the app, its manual, setup notes, and Configurator metadata. A package's compatibility with a given firmware build is decided by an ABI contract, not by matching revisions — a package keeps working across firmware updates that don't break the FPApp ABI, so there's no need to rebuild after every update.

If the repositories are not siblings, provide the Faderpunk checkout path:

make fpapps FADERPUNK_DIR=/path/to/faderpunk

Connect Faderpunk normally, open Apps, scroll to Installed Apps, and install a package in one of the available slots. The installed app then appears in the normal app catalogue above and can be added to a layout.

Status

Private for now — not yet open to public PRs, though the mechanical review gate is live: .github/workflows/pr-scope.yml runs on every PR (scope, API boundary, panic/unsafe rules, catalog + manual-tab validation, and a real FPApp build of each touched app, the same make fpapps the downloads site runs). The AI first-pass review step isn't wired up yet — advisory only, not a merge gate, per CONTRIBUTING.md.

See apps-catalog.json for the current catalogue.

About

No description, website, or topics provided.

Resources

Contributing

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages