Skip to content

creator-alpha-release-issue.md

Latest commit

 

History

History
132 lines (116 loc) · 6.44 KB

creator-alpha-release-issue.md

File metadata and controls

132 lines (116 loc) · 6.44 KB
Raw

Creator Alpha Release Tracking Issue

Use this as the body for the GitHub tracking issue before tagging v0.4.0-alpha.3.

Goal

Ship the v0.4.0 distribution and accessibility alpha of Point & Click Engine: a local-first, Git-friendly 2D point-and-click editor/runtime that a creator can clone, run, inspect, modify, validate, migrate, export, and package without paid provider keys. Static web export is in scope; hosted web delivery, SDK publishing, and a full puzzle-AI promise remain out of scope.

Exit Criteria

  • pnpm install --frozen-lockfile succeeds from a clean checkout.
  • pnpm check passes with network access available for Electron Forge packaging.
  • pnpm audit --audit-level high passes for runtime and packaging dependencies.
  • pnpm test:e2e passes or any failure is explicitly documented before tagging.
  • pnpm validate:provenance:strict passes after a human records actual asset, workflow, and third-party redistribution decisions.
  • Candidate evidence records the exact commit, Node.js 22.17.0, pnpm 9.6.0, clean status, SHA-256 checksums, signing status, and packaged-preview result.
  • apps/starter-game/project validates as the minimal clean gameplay project with curated ComfyUI workflow preset fixtures.
  • apps/sample-game/project validates as the public demo project.
  • v1 migration dry-run, backup, staging, and rollback are covered by fixtures.
  • Save slots, autosave, checkpoints, and browser/Electron storage adapters are covered by runtime tests.
  • Flow diagnostics, puzzle dependencies, static web export, and accessibility smoke checks are covered by the candidate validation record.
  • pnpm --filter @pointclick/editor make produces and verifies the portable ZIP and Squirrel installer outputs.
  • The packaged Windows editor opens and previews the sample without the Vite dev server.
  • README, roadmap, release notes, troubleshooting, AI guide, Character Gym guide, and project format docs match the shipped behavior.
  • The release includes a current screenshot or GIF from docs/assets.
  • The release includes the deterministic Player, AI Studio, and Asset Studio screenshots from docs/assets.
  • No model weights, generated experiments, provider secrets, local absolute paths, caches, logs, or packaged output are committed.

Manual Smoke Test

Follow docs/release-checklist.md.

Record the result here before tagging:

No manual smoke item below is claimed complete by this draft. Check an item only after recording the real result in release evidence or the maintainer's manual smoke notes.

  • Blank project created.
  • Starter project created and validated.
  • Sample project opened.
  • Scene edit saved and previewed.
  • Player asset or animation pack setting changed and previewed.
  • Asset imported or dropped from an inspector.
  • Chroma cleanup saved as a processed PNG asset.
  • Mock prompt pack generated.
  • AI Studio Advanced scroll, Candidate Output, keyboard focus, and wheel/touchpad smoke completed.
  • LM Studio prompt pack generated, if LM Studio is installed.
  • ComfyUI preset installed, recipe saved, and text-to-image asset generated, if ComfyUI is installed.
  • ComfyUI chroma or inpaint workflow smoke-tested, if a compatible target is available.
  • Character Gym can preview a spritesheet target.
  • Build validation run from the editor.
  • Browser preview opened.
  • Packaged editor preview opened.
  • Keyboard, narrow-viewport, and preview-reopen reliability smoke completed.
  • Migration dry-run, backup, and rollback smoke completed.
  • Save slots, autosave, checkpoint, and storage-adapter smoke completed.
  • Flow diagnostics and puzzle dependency smoke completed.
  • Static web export opened without the development server.
  • Portable ZIP and Squirrel installer outputs reviewed.
  • Strict provenance gate passed with evidence; no review-required release input remains.
  • Candidate checksum and release-evidence artifacts reviewed.

Known Limitations To Mention

  • Windows is the primary packaged target.
  • Character Gym can preview and edit packs, but generated sprite-sheet consistency still needs stronger presets.
  • Flow authoring includes the built-in typed node graph, diagnostics, and dependency inspection; custom flow-node plugins remain out of scope.
  • Transparent PNG quality depends on the selected ComfyUI workflow or clean chroma cleanup.
  • Reference and mask image inputs require a compatible installed ComfyUI template or legacy API workflow; plain text-to-image paths do not consume image inputs.
  • OpenAI support requires API platform billing; ChatGPT subscriptions do not cover API calls.
  • Hosted demo, public website, and SDK publishing are later milestones; static web export is included in v0.4.0-alpha.3.
  • Cloud providers are experimental and opt-in; no provider account is required for the local-first authoring loop.

Release Artifacts

  • Source archive from GitHub release.
  • Windows packaged editor from apps/editor/out/PointClickStudio-win32-x64/.
  • Portable ZIP, Squirrel Setup.exe, RELEASES, and full .nupkg installer outputs from the Electron Forge make step.
  • Screenshot or GIF from docs/assets.
  • docs/assets/scene_editor.jpg — Scene editor authoring surface.
  • docs/assets/player.jpg — completed Player loop.
  • docs/assets/ai-studio-advanced.png — mock Advanced workspace with Candidate Output.
  • docs/assets/asset_studio.jpg — mock Asset Studio surface.
  • Link to docs/release-notes-creator-alpha.md.
  • Link to docs/release-checklist.md.
  • SHA-256 checksum file and release-evidence JSON from the release-candidate workflow. Candidate artifacts are unsigned unless a separate authorized signing decision says otherwise.

Risks

  • Packaging fetch failure: Electron Forge may need HTTPS access. Re-run pnpm check outside restricted sandboxes before blocking the release.
  • Dependency advisories: high or critical findings in runtime or packaging dependencies block the candidate; update the lockfile and rerun the full audit instead of suppressing the finding.
  • Provider confusion: local AI tools are optional. Keep mock provider paths working and call out that models/weights are user-installed.
  • Workflow mismatch: custom ComfyUI exports vary. State that only installed templates or compatible API workflows with expected loader nodes can use reference/mask inputs.
  • Stale demo asset: refresh or explicitly accept the checked-in screenshot before tagging.