Skip to content

Max package 0.3.0: reference pages, help patches, examples, built-in ring - #48

Merged
zeyuyang42 merged 8 commits into
mainfrom
max-package-polish
Oct 16, 2026
Merged

zeyuyang42 merged 8 commits into
mainfrom
max-package-polish

Conversation

@zeyuyang42

Copy link
Copy Markdown
Collaborator

Summary

The remaining Max package work before the max-v0.3.0 tag, in six commits:

  • Reference pages for all four objects in maxmsp/docs/ (hand-written; Min-API generation switched off for zerr.disperser~ with MIN_FLAGS), installed into the package by CMake.
  • Help patches rewritten with one-line intros, worked examples and use tips; maxmsp/README.md object reference says the same as the pages (non-normalised features, 2048-sample window, trigger pulses must touch 1.0, full active/traj/topo rules, root = "and", max = "or", disperser mono-inlet rule).
  • Examples: five complete patches (full-chain-quad, spectral-centroid-panning, spectral-flatness-breath, zerr-cross-jump, custom-layout + my-room-6.yaml) with a README; placeholders removed; sig~ 1 on the gain inlet dropped after Envelopes: gain inlet reads 1 when nothing is connected #47.
  • Overview restyled in Max; loads the examples from a menu.
  • Built-in layout of zerr.envelopes~ is now the regular ring of ring_8.yaml, labelled built-in ring; circulation_8.yaml no longer ships next to the help patches.
  • Logo media: white (help) and grey (overview) transparent variants in maxmsp/media/.
  • The three dated design docs in docs/design/ are tracked now; release-process.md links one.

Release notes (docs/releases/max-v0.3.0.md) cover the above.

Test plan

  • cmake --install maxmsp/build stages docs/, examples/, media/, no circulation_8.yaml, no placeholder patches
  • All patch JSON validated; help patches and examples re-saved by Max 9.2
  • After merge: ./build.sh -c maxmsp && ./build.sh core && ./build.sh -p maxmsp, bang each object in its help patch (version 0.3.0), open the five examples, then max-v0.3.0-rc1 dry run

🤖 Generated with Claude Code

zeyuyang42 and others added 8 commits October 17, 2026 01:34
…ed with the code

Four reference pages in maxmsp/docs/ (zerr.features~, zerr.envelopes~, zerr.combinator~,
zerr.disperser~), Min-API generation switched off for zerr.disperser~ so Max never overwrites
its page. The four help patches are rewritten around one-line intros, worked examples and use
tips; the README's object reference says the same as the pages: features are not normalised
and update once per vector over 2048 samples, trigger pulses must touch 1.0 exactly, the full
active/traj/topo rules, combinator root as "and" and max as "or", the disperser's mono-inlet
rule. Release checklist gains the reference-page item.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…s them

maxmsp/examples/ ships full-chain-quad (two features, combinator in root mode, quad_4),
spectral-centroid-panning, spectral-flatness-breath, zerr-cross-jump (ports of the Pd
examples) and custom-layout with its own my-room-6.yaml, plus a README. The three placeholder
patches are gone. The overview patcher was restyled in Max and loads the examples from a menu.
CMake installs docs/ and examples/ into the package and stops copying .yaml from help/.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
zerr.envelopes~ without a layout argument now uses eight speakers at 45-degree steps, the same
positions as misc/ring_8.yaml, and labels it "built-in ring" in the console. The irregular
studio ring circulation_8.yaml no longer ships next to the help patches; the envelopes help
patch uses the built-in ring and ring_8 from misc/. Release notes updated.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
maxmsp/media/ holds zerr-logo-white-transparent.png (256 px, help patches) and
zerr-logo-grey-transparent.png (full size, overview) instead of the single black copy;
make-logo-variants.sh writes both.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
The Max health-check plan (linked from release-process.md), the paper gap audit and the Package
Manager audit were untracked on one machine only.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Since #47 the gain inlet of zerr.envelopes~ reads 1 when nothing is connected, so the examples
no longer need to drive it.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@zeyuyang42
zeyuyang42 merged commit aeaa2bd into main Oct 16, 2026
8 checks passed
@zeyuyang42
zeyuyang42 deleted the max-package-polish branch October 16, 2026 23:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant