Skip to content

CLAUDE.md

Latest commit

 

History

History
33 lines (23 loc) · 2.24 KB

CLAUDE.md

File metadata and controls

33 lines (23 loc) · 2.24 KB

AMY Development Notes

Releases

When creating a new release:

  1. Update the version in library.properties to match the release tag
  2. Create the GitHub release with a plain version tag (e.g. 1.2.3, NOT v1.2.3) — Arduino requires this format
  3. The Godot addon build workflow triggers automatically on tag push and attaches amy-godot-addon.zip to the release

Godot GDExtension

  • Local builds use setup_godot.sh which generates the SConstruct, C++ source, and GDScript wrapper inline
  • CI builds use the godot/ directory (SConstruct, src/, etc.) directly via .github/workflows/godot-addon.yml
  • amy_midi.c is excluded from the Godot build because it conflicts with platform stubs. Any new functions added to amy_midi.c (or other excluded files) that are called from core AMY code need stub implementations added in both:
    • godot/src/amy_platform_stubs.c (for CI builds)
    • The amy_platform_stubs.c section of setup_godot.sh (for local builds)
  • macOS builds produce a .framework bundle; the gh auth token needs workflow scope to push workflow file changes

Web REPL (tutorial & docs)

The live Python REPL at docs/tutorial.html runs MicroPython in the browser with the amy Python module frozen in. Updating it requires rebuilding MicroPython from the shorepine/tulipcc repo:

  1. In tulipcc, update the amy submodule to latest: cd tulipcc && git submodule update --remote amy
  2. Rebuild MicroPython: cd tulip/amyrepl && make clean && make
  3. Copy the output to amy's docs: cp build-standard/tulip/obj/micropython.mjs build-standard/tulip/obj/micropython.wasm <amy-repo>/docs/
  4. If the AMY C code or JS API also changed, rebuild those too: cd <amy-repo> && make web && make deploy-web

The docs/amy.js file is a concatenation of the Emscripten build (build/amy.js), src/amy_connector.js, and build/amy_api.generated.js. The JS API is auto-generated from amy/__init__.py by scripts/gen_amy_js_api.py.

GitHub Auth

  • The bwhitman account needs workflow scope on its token to push changes to .github/workflows/ files. Run gh auth refresh -h github.com -s workflow if pushes are rejected.
  • SSH pushes to shorepine/amy use the brianklay key by default; use HTTPS with gh auth token for bwhitman access.