Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 102 additions & 2 deletions THIRD_PARTY_NOTICES.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,111 @@ structure, not from their source.

---

## Formats and APIs read for the development features (after v1.7.0)

This section records research on formats, APIs and shapes, and says what that
research did and did not put in this repository. For the projects below, Studio
redistributes no source code and no captured project files; what exists in the
repository because of the reading is stated per entry. This section does not
describe the older Orca-derived data and slicer-written test files, which are
listed separately under "Orca-derived data and slicer-written fixtures already in
the repository". Licence identifiers are as reported by the GitHub repository API
on 2026-11-02 unless stated; they are recorded, not interpreted, and Studio makes
no legal conclusion from them. Studio is not affiliated with or endorsed by any of
these projects, and claims no contribution back to them.

### Creative-tool project formats (format only)

Read on 2026-11-01 to learn the shape of the 3MF each tool writes (member names,
XML element and attribute names, JSON keys). Pinned record, with the exact paths:
`backend/tests/fixtures/creative/PROVENANCE.md`; supported-format table:
`docs/internal/CREATIVE_COMPAT.md`.

| Tool | Source | Licence | Commit read | Path read |
|---|---|---|---|---|
| DitherForge | <https://github.com/rtwfroody/ditherforge> | MIT | `4d3552a434e8084d9b5fe573959a3493325be29f` | `internal/export3mf/export3mf.go`, `internal/export3mf/bambu.go` |
| Kromacut | <https://github.com/vycdev/Kromacut> | AGPL-3.0 | `94874755426ee7f33b3684a5544e7fab0e2e73f7` | `src/lib/export3mf.ts` |
| SindriCAD | <https://github.com/MakerViking/sindricad> | AGPL-3.0 | `8b2e9dc4f82fba58b39c206c993534c487cc1eab` | `sidecar/project3mf.py` |

What exists in this repository because of that reading: Studio's own readers, and
test archives generated at test time by Studio's own helper
(`backend/tests/fixtures/creative/zip_factory.py`). Those archives are synthetic
and are not captures of any tool's real output. The readers are fixture-tested
only. Other creative-compat research references (FOrcaSlicer, LixNix, FullSpectrum,
OrcaSlicer ImageMap) are listed with their evidence in `docs/internal/CREATIVE_COMPAT.md`.

### Lumina Layers (published API shapes only)

<https://github.com/lumina-layer-studio/Lumina-Layers> — GitHub reports
AGPL-3.0 (2026-11-02). An earlier Studio research note
(`docs/innovation-fund/PHASE1_POSITION.md`, a table measured 2026-08-23) recorded
"GPL-3.0"; the two differ and neither is a conclusion drawn here.

Studio's Lumina client sends requests to a service **you configure and run
yourself**, using the request and response shapes of the published Lumina Layers
API as recorded in a 2026-10-25 research bundle (read from the router source at
that time; the router is listed upstream today as `converter`). No Lumina code or
assets are redistributed. The test stand-in
(`backend/tests/mocks/lumina_server.py`) and its fixtures are hand-written from
those shapes; they are not captured from a Lumina service. The client is
mock-service-tested only: no real Lumina installation has been exercised.

### Accessory and host adapters (shapes in hand-written fixtures)

Fixtures are hand-written to published shapes and carry blob references in their
own `PROVENANCE.md` files under `backend/tests/fixtures/adapters/`. No device was
contacted and no code was copied.

| Project | Source | Licence (GitHub) |
|---|---|---|
| AFC-Klipper-Add-On | <https://github.com/AFCProject/AFC-Klipper-Add-On> | GPL-3.0 |
| BMCU-Klipper | <https://github.com/jarczakpawel/BMCU-Klipper> | GPL-3.0 |
| multiACE | <https://github.com/decay71/multiACE> | GPL-3.0 |
| Sidecar-Beta | <https://github.com/dcan999/Sidecar-Beta> | GitHub reports `NOASSERTION` (licence not identified); Studio copies nothing from it |
| Snapmaker u1-klipper (stock Moonraker shape) | <https://github.com/Snapmaker/u1-klipper> | GPL-3.0 |
| Snapmaker u1-moonraker (OctoPrint-compat shape) | <https://github.com/Snapmaker/u1-moonraker> | GPL-3.0 |
| SnapmakerU1-Extended-Firmware (SpoolLink shape) | <https://github.com/paxx12-snapmaker-u1/SnapmakerU1-Extended-Firmware> | GPL-3.0 |
| OctoPrint (documented version reply) | <https://github.com/OctoPrint/OctoPrint> | AGPL-3.0 |

### Snapmaker Orca source (setting facts only)

<https://github.com/Snapmaker/OrcaSlicer> (AGPL-3.0), read at commit
`b1831e5dcb464172de33783142425aafda834fbc`. What is redistributed is **facts and
names, not source**: `backend/snapstudio_core/data/u1_setting_scopes.json` (which
project settings are per-filament and which per-extruder, with prose evidence that
cites Orca file names) and `backend/snapstudio_core/orca_nonnullable.py` (a
generated list of option names plus a digest of that list, produced by
`tools/derive-orca-nonnullable.py`). No Orca source text, resources or profile
data is copied by these two files.

### Orca-derived data and slicer-written fixtures already in the repository

These existed before the work above and are documented in their own files; they
are listed here so this notice is read together with them. Studio makes no licence
determination about them here.

- `backend/snapstudio_core/data/templates/u1_base_project_settings.json`: project
settings captured from a real Snapmaker Orca project
(`backend/snapstudio_core/data/templates/PROVENANCE.md`).
- `backend/snapstudio_core/data/profiles/snapmaker_u1.json`: U1 reference profile
values exported from Snapmaker Orca's own reference project (see "U1 reference
profile values" below).
- Test fixtures written by slicers, described in
`backend/tests/fixtures/painted/PROVENANCE.md` (for example a Snapmaker Orca
2.3.5-authored and a Bambu Studio 02.08.02.61-authored project, and
PrusaSlicer 2.9.6 and OrcaSlicer 2.4.2 round-trips of Studio's own 20 mm cube) and
`backend/tests/fixtures/orca-object-overrides/`.

---

## Boundary kept

These projects were studied as **behaviour** — the published symptom a rule
addresses, and the file-format schema it operates on. No source code, resources
or profile data from any of them is present in this repository.
addresses, and the file-format schema it operates on. No source code from any of
them is present in this repository. The data files derived from them include
those described above (Snapmaker Orca setting facts, hand-written adapter
fixtures, Orca-derived data and slicer-written fixtures) and the factual
printer-profile data described under "Printer profile facts" below.

| Project | Licence | Why Studio must not copy from it |
|---|---|---|
Expand Down
79 changes: 79 additions & 0 deletions docs/demo/REPRODUCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Reproduce the Studio+ development-build demo

> **This is a development build, not the released v1.7.0.** The features shown here (Creative import and Prepare, workspace checkpoint with Passport, and the Lumina-compatible service client) live on development branches. They are not in the v1.7.0 installer, and nothing here is a release candidate. The UI footer and `desktop/package.json` still say "1.7.0" because no version bump was made on these branches.

Everything runs from source on your own machine, on loopback, with disposable synthetic files. No printer, no real Lumina service and no real project is involved or touched. Snapmaker Orca is never launched (the engine may read the bundled profile folders of an installed Orca, read-only).

## Evidence labels (what the demo does and does not show)
- **fixture-tested**: the creative-project readers are checked against synthetic archives built by Studio's own test helper from the tools' published output formats. They are not captured from real tool exports.
- **mock-service-tested**: the Lumina client and the read-only monitoring request are checked against hand-written loopback stand-ins.
- Not shown, not claimed: genuine tool exports, Snapmaker Orca opening or slicing, a real Lumina service, any physical U1 or other hardware.

## Source identity
- Product source for all three journeys: commit `22de80733f254c0a38fbca04986c154848e0bc69` (draft PR #144, branch `integ/demo-20261102`). That commit has no demo drivers.
- The drivers and this recipe are on the follow-up branch `docs/demo-repro-20261102` (a draft PR, not merged). Check out that branch: it adds only documentation, the driver scripts in `tools/demo/studio-plus/`, and `THIRD_PARTY_NOTICES.md` on top of the product commit. Check:
`git diff --stat 22de80733f254c0a38fbca04986c154848e0bc69 HEAD` lists only `docs/demo/`, `tools/demo/studio-plus/` and `THIRD_PARTY_NOTICES.md`.
- Inherited, unresolved: the review finding on PR #140 about `passport export -o` (a directory-swap race) is still open and is not addressed by this build.

## Prerequisites (tested versions; other versions untested)
| Item | Tested |
|---|---|
| OS | Windows 11 (the driver has Linux/Chromium code paths that are **not** tested) |
| Node.js / npm | 24.22.1 / 11.19.1 |
| Python | 3.13 (backend requires >= 3.13) |
| Browser | Microsoft Edge 156 (any Chromium-family browser via `EDGE_PATH`); used headless, driven over the DevTools protocol |
| Disk / network | a few hundred MB for `node_modules`; network only for `npm ci` and `pip install` |

## Install (about 3-5 minutes)
```bash
git clone https://github.com/DVOpenLabs/snapmaker-studio.git
cd snapmaker-studio
git checkout docs/demo-repro-20261102 # product source 22de807 + docs/tooling; see "Source identity"

# backend (virtual environment recommended)
python -m venv .venv # Windows: py -3.13 -m venv .venv
.venv/bin/python -m pip install -e backend # Windows: .venv\Scripts\python -m pip install -e backend

# desktop (Vite dev server dependencies)
cd desktop && npm ci && cd ..
```

## Run the automated journeys (recommended)
The driver generates the synthetic files in a throwaway folder, starts the engine, the Vite dev server, a headless browser and the stand-ins on ephemeral loopback ports, walks the three journeys through the real UI, saves screenshots and a results file, and then stops only the processes it started.
```bash
# PYTHON must be the interpreter that has the backend installed (a relative path is resolved from your current directory)
PYTHON="$PWD/.venv/bin/python" node tools/demo/studio-plus/run.mjs
# Windows (PowerShell):
# $env:PYTHON = "$PWD\.venv\Scripts\python.exe"; node tools/demo/studio-plus/run.mjs
```
Options: `run.mjs ac` or `run.mjs b` run one part; `DEMO_OUT=<folder>` chooses where screenshots and `results-*.json` go (default `<temp>/studio-demo-out`); `EDGE_PATH` selects the browser. The exit code is non-zero if any step failed or the page logged an error. The drivers are a smoke check of the outcomes listed below, not a full test suite; observed on-screen text is also recorded in `results-*.json`.

Expected result on the `docs/demo-repro-20261102` branch: Journeys A and C plus the sidebar sweep **18/18** steps, Journey B **12/12** steps, 0 page errors. (Recorded on one Windows machine; no clean-machine claim.)

## What the journeys show (expected on-screen wording)
**A. Prepare a supported creative project and see what changed.** Sidebar "Creative import", inspect `sample-kromacut.3mf`: "Looks like Kromacut", with "What Studio read", "Kept untouched", "Could not interpret" and "Original unchanged". "Prepare a U1 copy": "A new file was written" and "Export verification": Kept identical (5), Changed (1) `Metadata/project_settings.config`, Dropped (0), Added (0). The DitherForge Bambu-path sample prepares; the generic-path sample is refused with reasons and writes nothing; an unknown-origin file and a missing file are refused.
**B. Track artifact identity and preview recovery (read-only).** "Recovery" lists exactly the files that will be tracked (original and prepared copy) and why no sliced file is tracked; "Checkpoint this workspace" saves revision 1; "Sample data (not your workspace)" is a separate section. "Passport": "Use this job's files", "Build passport". After the original is replaced and the prepared copy deleted on disk, "Check the files again" marks the original "Invalidated / Bytes changed" and the prepared copy "Invalidated / File not found" because its declared parent changed. The recovery preview shows "changed" and "missing" labelled "Matched by filename only (unverified)". A missing file is a status; it is not byte-verified. Opening another project clears the old passport with a notice. Passport state lives in memory while the app is open, not across a restart. The monitoring stand-in sees only a read-only `GET`, and every file is unchanged after previews.
**C. A Lumina-compatible service you configure yourself, with an explicit format.** Sidebar "Lumina service": the banner says "Tested only against a synthetic stand-in service. No real Lumina installation has been exercised." The format starts on "Choose a format"; after "Check service" and choosing `png`, "Generate" saves a new file and shows its name, size and SHA-256, marked "(not verified)". A format the service did not produce, a non-local address, a stopped service and a missing image are all refused.

## Manual walk-through (no driver)
```bash
python -I tools/demo/studio-plus/make_samples.py <empty-folder> # synthetic inputs
python -I tools/demo/studio-plus/lumina_standin.py # prints {"url": "http://127.0.0.1:<port>"}; Ctrl+C to stop
# engine (POSIX shell syntax; run from <empty-folder>'s parent or any throwaway folder), with throwaway data folders
# and absolute paths: REPO is your checkout, PY the interpreter that has the backend installed
SNAPSTUDIO_DATA_DIR=<tmp>/data SNAPSTUDIO_ORCA_DATA_DIR=<tmp>/orca PYTHONPATH="$REPO/backend" "$PY" -m snapstudio_api # prints {"port":..., "token":...}
cd "$REPO/desktop" && npx --no-install vite --port <free port> --strictPort --host localhost
# open http://localhost:<vite port>/?api=<engine port>:<token>
```
Then follow journeys A, B and C above using the files in `<empty-folder>`. These commands mirror what the driver runs; the manual form has not been separately timed.

## Safety and cleanup
- All inputs are disposable synthetic files in a throwaway `demo-*` folder under your temp directory. The driver writes only there and to `DEMO_OUT`; it reads the repository's own code and dependencies (Vite may write its usual cache under `desktop/node_modules`), and the engine may read the bundled profile folders of a Snapmaker Orca installed on your machine, read-only (the driver never launches Orca). The original of each journey is replaced or deleted only inside the throwaway folder.
- The driver stops only the child processes it started and have not already exited (engine, Vite, stand-ins, headless browser), and removes its throwaway folder on normal completion and on SIGINT/SIGTERM (an early setup failure, such as no browser found, can leave the folder behind; it holds only synthetic data). Screenshots and results stay in `DEMO_OUT`, which you can delete. If you kill the driver forcibly, check for a leftover headless browser (it listens on a loopback debugging port).
- Studio keeps its usual rules in this build: it does not slice, never starts a print, writes new copies instead of modifying originals, and has no account or telemetry. The Lumina client sends one image to a service you configure and run; the Lumina client and Printer Hub only talk to addresses on your own network, and the Lumina client refuses non-local addresses.

## Remaining manual dependencies and limits
- Needs Node, Python 3.13 and a Chromium-family browser; network is needed only to install dependencies (`npm ci`, `pip install`). The driver starts Vite with `npx --no-install` and the browser with background networking disabled.
- Windows is the only tested OS; the Linux/macOS code paths in the driver (and SIGTERM cleanup of the Vite shell on Linux) are untested.
- The driver was written and run on one Windows machine and verified from a fresh checkout directory, not on a clean machine.
- Upstream credits and licence identifiers for the formats and APIs read are in `THIRD_PARTY_NOTICES.md`.
Loading
Loading