any2orca-profiles 0.0.0-stage → 0.1.0

package/NOTICE

@@ -0,0 +1,13 @@
+any2orca-profiles: third-party data attribution
+
+This is not legal advice; see LICENSE for the terms that apply to this package.
+
+The profile catalog (templates/ and the generated data/) is derived from preset
+data published by each supported printer vendor's own OrcaSlicer-family fork,
+today Snapmaker Orca (github.com/Snapmaker/OrcaSlicer), which is
+AGPL-3.0-or-later. That provenance is why this package is AGPL-3.0-or-later.
+data/index.json names the upstream release the catalog tracks.
+
+"Snapmaker," "OrcaSlicer," and other printer and slicer names used in this
+package are trademarks of their respective owners. any2orca is an independent
+project and is not affiliated with, endorsed by, or sponsored by any of them.

package/README.md

@@ -1,3 +1,50 @@
-# Temporary Holding Version
+# any2orca-profiles
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The printer profile catalog for [any2orca](https://www.npmjs.com/package/any2orca): data only, no code. It holds the Snapmaker U1 profiles, tracking Snapmaker Orca's own presets (`data/index.json` says which release).
+
+```
+data/index.json            versions, printers, profiles, retired profile ids, filament names
+data/profiles/<id>.json    one self-contained file per profile
+```
+
+`any2orca` installs this package and its CLI uses it automatically. In a browser, copy `data/` into your site's static files and point `fetchProfileSource()` or the Web Worker's `profilesUrl` at it.
+
+## The format
+
+Both files are JSON with `"schema": 1`, and `any2orca` checks them when it loads them (`ProfileIndexSchema` and `ProfileFileSchema` in the library): a catalog with a missing or malformed field is refused with a message, never half used.
+
+**`data/index.json`**
+
+| Field | What it holds |
+|---|---|
+| `dataVersion` | This catalog's version, the package version. |
+| `slicer` | The release the catalog follows: `name`, `version`, and `application`, the value converted files carry (it ends with the version). |
+| `source` | Where the profiles were generated from: `repository`, release `tag` and `commit`. |
+| `defaultProfileId` | The profile used when nothing matches the file. |
+| `printers` | One entry per nozzle size: `id`, `displayName`, `nozzleDiameter`, `highFlowSupported`. |
+| `profiles` | One entry per profile: `id`, `printerId`, `displayName`, `nozzleDiameter`, `layerHeight`, `autoSelectable` (false for a profile only chosen by hand) and `highFlowSpeeds`. |
+| `retired` | Old profile ids that still convert: `id`, the `successorId` used instead, and the old `displayName`. |
+| `filamentNames` | The filament presets Snapmaker installs per nozzle size, for the Snapmaker and Generic naming options. |
+
+**`data/profiles/<id>.json`**: `id` and `displayName`; `printer` (its `id`, `printableArea`, `extruderClearanceRadius`, `highFlowSupported` and the stock `machineSettings`); `baselineProjectSettings`, the profile's stock print settings; `filamentShape`, the layout filament settings are written in; and `highFlowOverrides`, the speeds the profile uses with high-flow hotends (empty when it has none).
+
+To try your own profiles, edit a copy of these files and point `--profiles-dir`, `dirProfileSource()` or the web app's `profiles/` folder at it.
+
+## Where the data comes from
+
+The profiles are Snapmaker's own stock U1 presets at the Snapmaker Orca release named in `data/index.json` (`source`: repository, release tag and commit). `data/index.json` also lists the filament presets Snapmaker installs for each nozzle size, which the Snapmaker and Generic filament naming options use, so they only ever write a preset Snapmaker Orca has. The maintainers update the catalog when Snapmaker publishes a new release.
+
+## Changing the data
+
+`data/` is built from `templates/` (the settings files) and `catalog.json` (which templates make up which profile, plus retired ids). To change a profile, edit those and rebuild (`high_flow.json` and `filament_names.json` are generated by the maintainers from Snapmaker's release; open an issue for those instead):
+
+```sh
+npm run generate -w any2orca-profiles   # rebuild data/
+npm test -w any2orca-profiles           # fails if data/ is out of date
+```
+
+If a value looks wrong compared with Snapmaker's own preset, please open an issue.
+
+## License
+
+AGPL-3.0-or-later, because the data is derived from Snapmaker Orca's AGPL presets. Shipping it unmodified alongside your own app is fine; if you modify the data and serve it, publish your modified data. See `NOTICE`. any2orca is an independent project, not affiliated with, endorsed by, or sponsored by Snapmaker, OrcaSlicer or any printer, slicer or filament maker.