Skip to content

About

CrossPad app registry — auto-generated index of available applications

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Repository files navigation

CrossPad App Registry

The app catalog of the CrossPad SDK, and the tools built around it:

  • registry.json: every published CrossPad app, rebuilt by CI from GitHub (see Registry contract).
  • crosspad_app_manager.py: CP Tools, the app manager (command line and full-screen menu). Each platform has a thin wrapper that downloads it from here: tools/app_manager.py in platform-idf, scripts/app_manager.py in crosspad-pc.
  • install/: the one-line installer for Windows, macOS and Linux.
  • template/: the app template that idf.py app-new and cptools new generate from.

Documentation

The CrossPad SDK docs are at https://crosspad.app/docs/:

Not on the site yet: docs/app-manager.md (what an app follows, backups, feature flags, the device check, profiles, the PC and Arduino wrappers, VS Code buttons).

Quickstart

The recommended setup is by hand, with Start here. The shortcut is one line that installs everything and opens CP Tools. It takes 15–30 minutes the first time; run it again any time and it repairs only what is missing.

Windows (PowerShell)

powershell -ExecutionPolicy Bypass -c "irm https://raw.githubusercontent.com/CrossPad/crosspad-apps/main/install/install.ps1 | iex"

macOS / Linux

curl -fsSL https://raw.githubusercontent.com/CrossPad/crosspad-apps/main/install/install.sh | bash

Step by step, with screenshots: install/README.md. Afterwards open CP Tools from the desktop shortcut (Windows) or type cptools.

Latest Updates

  • Arrange v0.43.1 — A Pitch sound that does not load at once is no longer reported at once: while the auto-freeze bounces, the first try can fail and the retry 2 s later loads it. Only when the retry fails too does the player read it, and a lack of memory reads "Pitch sound needs more memory: remove a track". Requires core 2.46.
  • Arrange v0.43.0 — A kit picked away from Arrange no longer changes the song behind the player's back. On the way back into Arrange a question comes first: Replace on T (the track plays the new kit) or New track (a kit track of its own with the new kit, the old track keeping its kit and freeze). Until then the old track plays its freeze. A kit picked from a track's seq view (CLIP EDIT) is still that track's. Requires core 2.45.
  • Arrange v0.42.2 — Muting or un-muting the Pitch track no longer stops the song. With the Pitch track armed, its M let go of the instrument and loaded it again on the un-mute, and each swap of the engines stopped the playback. A muted Pitch track now keeps its instrument; its notes stay silent while it is muted.
  • Arrange v0.42.1 — A kit track ARM is not on now freezes while another kit track is armed: the kits' engine went to it and was taken back by the armed track the next moment, before its kit came in, so in a full arrangement the freeze never started and the header blinked. The engine now stays on the track it went to freeze until its kit is in, as long as the player leaves the board alone (a kit that does not come in 30 s is tried again later). A frozen track's header keeps its snowflake and its name in one place and one font while the engine visits it, instead of showing LOADING and a longer, then shorter name.
  • Arrange v0.42.0 — Q on the context row, between SYNC and LOOP: the grid a REC or DUB snaps to (1/4, 1/8, 1/8T, 1/16, 1/16T, 1/32, free), the Sequencer's own setting, so a take is not a trip to the seq view first; the row's keys are a few pixels narrower for it. Each kit track plays and records with its own swing (core 2.43). A freeze or bounce shows in the box over the lanes again (FREEZING TRACK n, render x of y), not as a line on its header. The kits' engine leaves the armed track to freeze another kit track only once the player has let the board be for 5 s: under the fingers a freeze giving way to the pads swung it back and forth, loading one kit after the other and trying the freeze again and again. Requires core 2.43.
  • Arrange v0.41.0 — main's 0.29-0.40 (drag blocks, Export mix, Record this block again, loop region by finger, insert and delete bars, hold a header to mute, move and duplicate tracks, track colours, MIX peak hold, LOADING on a live header) on one kits' engine: no kit slots and no harvest. A kit track the engine does not play has its stale freeze stand in under its blocks; a mixdown hands the engine to each kit track still to freeze in turn. Requires core 2.42.

CrossPad Official

App Version Description Platforms Requires Repo
App Store 0.1.1 Browse, install, and manage CrossPad apps from the registry pc core >=1.70.0,<3.0.0, gui >=1.28.0,<3.0.0 CrossPad/crosspad-appstore
Arrange 0.43.1 Four audio tracks of bounced clips on a timeline esp-idf, pc core >=2.46.0,<3.0.0, gui >=2.0.0,<3.0.0 CrossPad/crosspad-arrange
DAW Control 0.5.0 DAW controller surface: pads play the DAW, the DAW lights the pads and fills the screen (FL Studio, Ableton Live, REAPER) esp-idf, pc core >=1.70.0,<3.0.0, gui >=1.28.0,<3.0.0 CrossPad/crosspad-dawcontrol
DOOM 0.1.0 DOOM (doomgeneric) on the pads, the encoder and the panel; the one app of the doom firmware kit pc, esp-idf core >=2.0.0,<3.0.0, gui >=2.0.0,<3.0.0 CrossPad/crosspad-doom
FX Pad 0.2.1 The board as a performance multi-effect: line 1/2, line 3/4, the mics and the computer through thirty-two effects in two banks the pads hold, an XY surface for their parameters; the one app of the fxpad firmware kit esp-idf core >=2.47.0,<3.0.0, gui >=2.0.0,<3.0.0 CrossPad/crosspad-fxpad
Instructions 0.3.0 Markdown-based instructions and help viewer esp-idf, arduino, pc core >=1.70.0,<3.0.0, gui >=1.28.0,<3.0.0 CrossPad/crosspad-instructions
Mixer 0.21.1 Audio mixer/router — dynamic IAudioNode channels, multi-output routing pc, esp-idf core >=2.42.0,<3.0.0, gui >=1.28.0,<3.0.0 CrossPad/crosspad-mixer
Pad Mixer 0.3.0 Sixteen faders, one per pad esp-idf, pc core >=2.22.0,<3.0.0, gui >=1.28.0,<3.0.0 CrossPad/crosspad-pad-mixer
Piano 0.1.2 Synth piano with parameter sliders, presets, octave control pc core >=1.70.0,<3.0.0, gui >=1.28.0,<3.0.0 CrossPad/crosspad-piano
Piano Tiles 0.1.0 Piano Tiles for the pads: tiles fall in four lanes, the pads show what comes, each tile plays the next note of a public-domain tune on a small piano synth; levels speed it up, best scores saved on the card; the one app of the pianotiles firmware kit pc, esp-idf core >=2.0.0,<3.0.0, gui >=2.0.0,<3.0.0 CrossPad/crosspad-pianotiles
Pitch Play 0.14.0 One sample or many, played chromatically on the pads and from a MIDI keyboard esp-idf core >=2.27.0,<3.0.0, gui >=2.0.0,<3.0.0 CrossPad/crosspad-pitchplay
Pong 0.1.0 Pong against the CPU over nine levels, or two players: encoder and pads as paddles, the pads light the court, square-wave effects; the one app of the pong firmware kit pc, esp-idf core >=2.0.0,<3.0.0, gui >=2.0.0,<3.0.0 CrossPad/crosspad-pong
Recorder 0.9.0 Record a sample from the mics, the line-in or the pads, and trim it to a loop esp-idf, pc core >=2.44.0,<3.0.0, gui >=1.28.0,<3.0.0 CrossPad/crosspad-recorder
Sampler 0.25.0 Sample player with 16 pads, waveform editing, kit management esp-idf, arduino core >=2.42.0,<3.0.0, gui >=2.13.0,<3.0.0 CrossPad/crosspad-sampler
SDR 0.1.1 The board's own Wi-Fi radio as a receiver (ESP-SDR): the 2.4 GHz band as a spectrum, a waterfall or an I/Q constellation on the panel, frequency, rate, gain, filter and averaging on the encoder; the one app of the sdr firmware kit esp-idf core >=2.0.0,<3.0.0, gui >=2.0.0,<3.0.0 CrossPad/crosspad-sdr
Sequencer 0.13.1 Record, loop and erase scenes on the pads esp-idf, pc core >=2.43.0,<3.0.0, gui >=2.0.0,<3.0.0 CrossPad/crosspad-pattern-seq
Serial Monitor 0.1.1 UART serial monitor with baud rate selection, auto-scroll, clear pc core >=1.70.0,<3.0.0, gui >=1.28.0,<3.0.0 CrossPad/crosspad-serial-monitor
Slicer 0.6.0 Chop a loop into slices -- by its hits, into equal parts, or live on the pads -- and save it as a kit esp-idf, pc core >=2.44.0,<3.0.0, gui >=2.13.0,<3.0.0 CrossPad/crosspad-slicer
Song 0.3.1 Arrange scenes on a timeline esp-idf, pc core >=1.70.0,<3.0.0, gui >=1.28.0,<3.0.0 CrossPad/crosspad-song
Synthesizer 0.1.0 Polyphonic synth with 3 oscillators, ADSR, filter, effects arduino core >=0.3.0, gui >=0.2.0 CrossPad/crosspad-synthesizer

20 official app(s)

Top 10 Community Apps

No community apps yet — add yours!

Registry contract

How an app gets into the catalog (walkthrough: Publish an app):

  1. Its repo has a crosspad-app.json at the root. A repo without a readable one is skipped.
  2. CrossPad org repo: it has the GitHub topic crosspad-app. Any other repo: it is public and listed in external-apps.json, added by pull request. CP Tools opens that pull request for you: Developer tools → Submit an app to the catalog.
  3. The next registry build lists it (see below).

crosspad-app.json

{
  "id": "my-app",
  "name": "My App",
  "version": "0.1.0",
  "description": "What it does",
  "platforms": ["esp-idf", "pc"],
  "category": "music",
  "icon": "my-icon.png",
  "component_path": "components/crosspad-my-app",
  "requires": { "crosspad-core": ">=0.3.0", "crosspad-gui": ">=0.2.0" },
  "changelog": ["0.1.0: Initial release"]
}
Field Meaning
id required The app's key in the catalog (idf.py app-install --app <id>). Without it the build uses the repo name minus crosspad-
name, description required Shown in CP Tools and the catalog
version required Semver x.y.z
platforms required Any of esp-idf, pc, arduino
category music, audio, tools or other (what new --category offers)
icon Icon file name
component_path Where the app goes in an ESP-IDF project
requires Minimum crosspad-core / crosspad-gui versions (a list means any version)
screenshot A path in the repo or a URL; CP Tools opens it from the app's page
changelog "x.y.z: what changed" entries; they feed Latest Updates above and are not copied into registry.json

"Required" is what CP Tools checks before it submits an app; the template fills all five.

external-apps.json

One entry per repo in repos. Only repo is needed; url defaults to https://github.com/<repo>.git and branch to the repo's default branch.

{ "repo": "you/crosspad-my-app", "url": "https://github.com/you/crosspad-my-app.git", "branch": "main" }

A pull request that adds an entry is merged when the repo is public and outside the CrossPad org (org repos use the topic), its crosspad-app.json has the required fields and a semver version, and its id is not already in the catalog: the catalog is keyed by id, and a later entry replaces an earlier one without a warning.

How the registry is built

build-registry.yml runs build_registry.py every 6 hours, when an app repo's release workflow sends app-released, on a push to main that changes build_registry.py or external-apps.json, and by hand (workflow_dispatch). It:

  1. finds the CrossPad org repos with the crosspad-app topic and adds the repos in external-apps.json;
  2. reads each repo's crosspad-app.json from its default branch (or the branch given);
  3. writes registry.json ({"version": 1, "apps": {"<id>": {name, version, description, repo, component_path, icon, category, platforms, requires, screenshot}}}), the three generated blocks of this README and COMMUNITY_APPS.md, and commits them as chore: update registry.json [automated].

diff_registry.py compares the old and new registry and writes the new apps, new platforms and version changes as workflow outputs. Clients read registry.json from main over plain HTTPS (no GitHub account) and keep a copy in app-registry.json in the project for an hour.

Do not edit between the <!-- …_START --> and <!-- …_END --> markers: the build rewrites them.

License

GPL-3.0-or-later — see LICENSE.

About

CrossPad app registry — auto-generated index of available applications

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages