Skip to content

Production interior authoring and interactive Three.js delivery plugin for img2.

Release public img2interior package with free-use terms

hoainhof2c3667bb6d3
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 0000000..856373e
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+custom: ['https://img2threejs.io/donate.html']
\ No newline at end of file
diff --git a/.npmignore b/.npmignore
new file mode 100644
index 0000000..d3ac696
--- /dev/null
+++ b/.npmignore
@@ -0,0 +1,16 @@
+_img2_local.py
+__pycache__/
+*.pyc
+*.pyo
+node_modules/
+dist/
+.venv/
+.venv-blender/
+.venv-images/
+.img2/
+.env
+.env.*
+!.env.example
+*.pem
+*.key
+.DS_Store
\ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 19dc250..3d50f94 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,18 +1,29 @@
# Changelog
-## 0.3.0 — Unreleased
+## 0.3.1 — 2026-10-19
+
+### Distribution
+
+- **Install documentation correction.** The img2 0.4.0 harness `add npm:@img2threejs/img2interior@<version> --yes` flow is broken against npm 10/11 — it expects a nested `info.dist.integrity` from `npm view`, but npm 10/11 return a flat `dist.integrity`, so the harness `add` command refuses the package. The bug is in the img2 harness, not in this package. The documented supported install path is now a two-step flow: `npm install --prefix "$HOME/.local/share/img2interior" @img2threejs/[email protected]` (the real distribution and tracking event) followed by `npx --yes @img2threejs/[email protected] add --link "$HOME/.local/share/img2interior/node_modules/@img2threejs/img2interior" --yes` (the host registration step). The package ships no lifecycle scripts, so `npm install` performs only a fetch and a directory copy. README and `reference/installation.md` describe the two-step path; the `add npm:` flow is recorded as broken and **must not** be advertised as working. Update by re-running the `npm install --prefix` command against the new version — the host link points at the installed prefix, so the consumer's next launch sees the new bytes. Do not pass `--force`, do not run a global install, and do not delete the prefix while a host link still points inside it. Source clone and supplied archive paths remain supported via `add --link` only. Bump SKILL metadata to `0.3.1`; root `package.json` and `plugin.json` version bumps belong to the maintainer.
+
+## 0.3.0 — 2026-10-19
### Licensing
-- Use one primary **Proprietary — All rights reserved** license in `LICENSE`, requiring prior written authorization rather than granting automatic evaluation, internal, commercial or redistribution rights. Simplify the README and skill metadata to point to that policy.
-- Move the exact separately licensed component scope and earlier-grant notices into `THIRD_PARTY_NOTICES.md`; retain `licenses/Apache-2.0.txt` unchanged. Require all three files in source archives and future npm payloads. This reorganization neither revokes existing Apache-2.0 rights nor certifies exclusive ownership or Blender GPL compliance for the entire distribution.
-- Keep plugin/skill metadata at 0.3.0 for this unreleased licensing revision. No npm package, release tag, scene behavior or visual-quality upgrade is introduced.
+- Replace the no-permission proprietary notice with the **img2 Interior Free Use, Restricted Commercialization License 1.0**: allow free use/modification, commercial project work, paid client output delivery, viewer/runtime code accompanying outputs, and free noncommercial sharing with notices. Require prior written permission to sell/repackage the tool or provide paid hosted/API access to its authoring/generation workflow. Label it source-available, not OSI-approved open source; align README, skill metadata and installation guidance.
+- Move the exact separately licensed component scope and earlier-grant notices into `THIRD_PARTY_NOTICES.md`; retain `licenses/Apache-2.0.txt` unchanged. Require all three files in source archives and the npm package. This reorganization neither revokes existing Apache-2.0 rights nor certifies exclusive ownership or Blender GPL compliance for the entire distribution.
+
+### Distribution
+
+- Replace private-distribution plans: published as **`@img2threejs/[email protected]`** with `npm publish --access public`. The public npm package and the public `img2threejs/img2interior` GitHub repository ship the same project; no authenticated npm login or `--allow-any-source` flag is required for consumers (the package lives in the default-trusted `@img2threejs` scope). README, `reference/installation.md` and `docs/showcase/README.md` describe the public install flow, public source access, the actual hosted [live demo](https://img2threejs.io/living-room/), the four support links (Ko-fi, donate page, PayPal, Binance Pay), and the public npm download / package metadata endpoints plus their limits. Maintainer checklist now uses `npm publish --access public`, an explicit public tarball review and a public-consumer registration check (`add npm:@img2threejs/img2interior@<version> --yes`) instead of an authenticated-read check.
+- Add a discoverable showcase/support reference in `SKILL.md` so the live demo, the bundled gallery, and the support links are reachable from the agent skill itself without changing behavior.
### Documentation
-- Redesign the README as a package landing page with a complete, room-independent copy-and-use prompt, explicit setup/delivery expectations, and actual Oak / Linen living-room reference/native/browser previews. Label the original research study's relationship to the extracted recipe and its limits; no fresh scene-quality result is claimed.
-- Choose private npm payload distribution instead of a public wrapper requiring GitHub source access. Document restricted package metadata, account/access requirements, actual tarball and authenticated-consumer checks, and publication status; no npm package or catalog entry is published.
-- Include the small offline showcase gallery and both optimized previews in source archives. Use immutable public-media image URLs for the npm-facing README without exposing plugin code, scene files, full-resolution references or private production reports.
+- Redesign the README as a package landing page with a complete, room-independent copy-and-use prompt, explicit setup/delivery expectations, and actual Oak / Linen living-room reference/native/browser previews. Link the actual hosted [live demo](https://img2threejs.io/living-room/) prominently in the top navigation, the showcase heading and the gallery footer; keep the static screenshots but label them as captured frames from the live page rather than as the only available view. Distinguish the native Blender comparison image from the archived viewer capture.
+- Include the small offline showcase gallery and both optimized previews in source archives. Use immutable public-media image URLs for the npm-facing README without exposing plugin code, scene files, or full-resolution references.
+
+No scene behavior, reconstruction-quality result, or visual-quality upgrade is introduced by this revision; only the license text, public-distribution plumbing, and the documentation supporting both change.
## 0.2.0 — 2026-10-18
@@ -55,6 +66,6 @@
- Fix valid intake evidence rejection through workspace path aliases (including macOS `/var` versus `/private/var`) by comparing resolved identity/content while retaining lexical pins for symlink-retarget detection.
- Add a failing-before/passing-after directory-alias regression; keep source/evidence freshness and confinement checks intact.
- Correct capability examples/probes to specify both typed-edge endpoints, not a named plugin with an unspecified `null → null` query.
-- Verify 47 behavior regressions, official installation in Claude/Codex/OpenCode sandboxes with zero doctor findings, and real showcase audit/state/gate replay including rejection/revision and stale-input counterexamples. See [VERIFICATION.md](VERIFICATION.md) for scope and limits.
+- Verify 47 behavior regressions, official installation in Claude/Codex/OpenCode sandboxes with zero doctor findings, and real showcase audit/state/gate replay including rejection/revision and stale-input counterexamples.
0.1.0 was verified as a local source release. Repository hosting is separate from npm/catalog publication; no room-generation or physical-phone certification is implied.
diff --git a/LICENSE b/LICENSE
index 6af5451..44a48ed 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,34 +1,95 @@
-img2 Interior — Proprietary License
-Copyright 2026 hoainho. All rights reserved.
-License identifier: LicenseRef-img2-Interior-Proprietary
+img2 Interior — Free Use, Restricted Commercialization License 1.0
+Copyright 2026 hoainho.
+License identifier: LicenseRef-img2-Interior-Free-Use-Restricted-Commercialization-1.0
-1. Scope
+1. Scope and preserved rights
-These terms apply to the original portions of img2 Interior that the copyright
-holder is entitled to license on proprietary terms. Separately licensed
+These terms apply only to the original portions of img2 Interior that the
+copyright holder is entitled to license under these terms (the "Software"),
+including covered code, skills, scripts and documentation. Separately licensed
components and previously granted rights are expressly excluded, as identified
in THIRD_PARTY_NOTICES.md. Their applicable license terms remain controlling;
this license does not revoke, restrict, or replace them.
-2. No permission without written authorization
+This is a source-available license with commercialization restrictions, not an
+OSI-approved open-source license.
-This notice grants no permission to use, reproduce, modify, create derivative
-works of, distribute, sublicense, sell, or otherwise exploit the proprietary
-portions, except where permitted by applicable law or rights you already hold.
-Any other permission requires a separate written agreement from the copyright
-holder specifying the permitted use. No evaluation, internal-use, commercial,
-modification, or redistribution license is granted automatically.
+2. Free use and modification
-GitHub access, npm access, downloading, installation, or payment alone does not
-supply that authorization. No ownership, patent, or trademark rights are granted
-by this notice. Request authorization through https://github.com/img2threejs.
+Subject to these terms, the copyright holder grants you a worldwide,
+non-exclusive, royalty-free license to use, copy and modify the Software for
+personal, educational, research, internal business and commercial project work.
+No separate permission or license fee is required for those uses. You may
+charge for your own design, authoring or consulting work and resulting outputs,
+including work performed for clients, subject to sections 3 and 4.
-3. Disclaimer
+You may redistribute the Software, unchanged or modified, free of charge for
+noncommercial sharing, provided you include this license,
+THIRD_PARTY_NOTICES.md and all applicable copyright and component-license
+notices, identify your modifications, and apply these terms to covered portions.
+Recipients receive the same permissions directly from the copyright holder.
+You may not relicense covered portions to remove these restrictions.
-TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THE PROPRIETARY PORTIONS ARE
-PROVIDED "AS IS", WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
+3. Commercialization of the Software requires permission
+
+Without the copyright holder's prior written permission, you may not, directly
+or through another party:
+
+- Sell, rent, license for a fee, or otherwise charge for access to or
+ distribution of the Software or a modified or rebranded version.
+- Bundle, embed or redistribute the Software as part of a commercial software
+ product, plugin, skill pack, template pack or other paid offering, except for
+ the output delivery expressly permitted by section 4.
+- Offer a paid hosted, API, SaaS or managed service that gives customers access
+ to the Software's authoring or generation workflow, including access bundled
+ with another paid service.
+
+Making modifications, changing the name, retaining attribution, or disclosing
+source code does not waive these restrictions. Using the Software yourself or
+within your organization to produce client deliverables is permitted; selling
+customers access to the Software or its workflow is not.
+
+Request commercial permission through https://github.com/img2threejs. Repository
+or package access, installation, a platform subscription, or payment to another
+party alone does not constitute that permission. Any separate written
+agreement controls only to the extent of the rights it expressly grants.
+
+4. Outputs and client delivery
+
+This license does not claim ownership of your inputs or original outputs,
+including scene data, models, renders, images and artwork. You may use, sell
+and deliver them commercially without a separate Software license fee.
+
+You may also copy, modify and distribute the Software's viewer/runtime code
+solely as part of a deliverable that displays or interacts with those outputs,
+including paid client deliverables. Include this license and applicable
+component notices for copied code. This exception does not permit selling a
+standalone viewer toolkit, redistributing the authoring tools as a commercial
+product, or providing customers access to the authoring/generation workflow.
+
+Other copied Software remains subject to sections 2 and 3. Third-party code,
+assets and reference images retain their own terms; this output permission
+does not grant rights you do not otherwise hold in those materials.
+
+5. Reserved rights
+
+Rights not expressly granted are reserved. No ownership or trademark rights
+are transferred. You may not imply the copyright holder endorses your version,
+product or service. Rights available under applicable law or separately
+licensed components remain unaffected.
+
+6. Termination
+
+Permissions under this license terminate if you violate its terms. Termination
+does not revoke rights independently available under a component license,
+an earlier grant, a separate agreement or applicable law.
+
+7. Disclaimer
+
+TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THE SOFTWARE IS PROVIDED
+"AS IS", WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT.
THE COPYRIGHT HOLDER IS NOT LIABLE FOR CLAIMS, DAMAGES, OR OTHER LIABILITY
-ARISING FROM THOSE PORTIONS OR THEIR USE, EXCEPT WHERE APPLICABLE LAW OR A
-SEPARATE WRITTEN AGREEMENT REQUIRES OTHERWISE. SEPARATELY LICENSED COMPONENTS
-HAVE THE DISCLAIMERS AND LIABILITY TERMS OF THEIR RESPECTIVE LICENSES.
+ARISING FROM THE SOFTWARE OR ITS USE, EXCEPT WHERE APPLICABLE LAW OR A SEPARATE
+WRITTEN AGREEMENT REQUIRES OTHERWISE. SEPARATELY LICENSED COMPONENTS HAVE THE
+DISCLAIMERS AND LIABILITY TERMS OF THEIR RESPECTIVE LICENSES.
diff --git a/README.md b/README.md
index 2b76de6..a930c6f 100644
--- a/README.md
+++ b/README.md
@@ -6,30 +6,36 @@ An agent-operated interior reconstruction skill for **Claude Code, Codex and Ope
Not a pretrained image-to-mesh model or a one-click fidelity guarantee. The workflow depends on scene-specific authoring and visual review.
-[Showcase](#showcase) · [Copy-and-use prompt](#copy-and-use-prompt) · [What you get](#what-you-get) · [Installation](#installation) · [Guides](#guides)
+[Live demo](https://img2threejs.io/living-room/) · [Showcase](#showcase) · [Copy-and-use prompt](#copy-and-use-prompt) · [What you get](#what-you-get) · [Installation](#installation) · [Support](#support)
-> **Availability:** source version 0.3.0; **not yet published to npm**. Private npm payload distribution is planned for authorized users. The implementation stays private; only the approved showcase previews are public.
+> **Package:** `@img2threejs/[email protected]`; **public npm distribution**. **Source:** [img2threejs/img2interior](https://github.com/img2threejs/img2interior), the same project published to npm. Install with `npm install` + official img2 harness `add --link`, or from the public source — see [installation](reference/installation.md).
+
+[![npm](https://img.shields.io/npm/v/@img2threejs/img2interior.svg)](https://www.npmjs.com/package/@img2threejs/img2interior) [![npm downloads/month](https://img.shields.io/npm/dm/@img2threejs/img2interior.svg?label=downloads)](https://www.npmjs.com/package/@img2threejs/img2interior)
## Showcase
-### Oak / Linen — Living Room
+### Oak / Linen — Living Room — **[Try the live demo](https://img2threejs.io/living-room/)**
+
+The comparison image below is the AI-generated design reference and an actual **native Blender render** of the opened packed master — it is *not* a browser frame. Click the image to open the original at full size.
[![Side-by-side living-room comparison: an AI-generated reference on the left and the actual authored Blender render on the right.](https://raw.githubusercontent.com/img2threejs/img2interior-media/375e6af7ab526d7c0c10be91b0e72f2757391ec7/living-room-comparison.webp)](https://raw.githubusercontent.com/img2threejs/img2interior-media/375e6af7ab526d7c0c10be91b0e72f2757391ec7/living-room-comparison.webp)
-**Left: design reference. Right: reconstruction.** The reference is AI-generated, not a photograph or measured survey. The result is an actual render of the reopened Blender deliverable, not a retouched reference or an image plane standing in for a room. Open the image for the larger comparison.
+**Left: design reference. Right: reconstruction.** The reference is AI-generated, not a photograph or measured survey. The result is an actual render of the reopened Blender deliverable, not a retouched reference or an image plane standing in for a room.
+
+The **[live demo](https://img2threejs.io/living-room/)** is the same authored scene running in a hosted Three.js viewer — camera views, wireframe, curtain controls, sofa finishes and downloads. The screenshot below is an archived capture of that browser project, while the comparison image above is the native Blender deliverable; the live page is interactive.
This is the **original Oak / Linen living-room research study** from which the packaged recipe and workflow lessons were extracted. It used scene-specific Blender/Python authoring and viewer integration, not a fresh run of the packaged 0.3.0 skill or the prompt below. Framing, proportions, fabric folds and lighting still differ from the reference; this is not a universal fidelity benchmark.
<details>
-<summary><strong>See the browser viewer</strong> — camera views, wireframe, curtain controls, sofa finishes and downloads</summary>
+<summary><strong>Archived browser screenshot</strong> — same viewer as the live demo, captured frame rather than interactive page</summary>
-[![Actual browser screenshot of the living-room reconstruction, with source comparison, camera views, wireframe, curtain controls, sofa finishes and native/portable download links.](https://raw.githubusercontent.com/img2threejs/img2interior-media/375e6af7ab526d7c0c10be91b0e72f2757391ec7/living-room-viewer.webp)](https://raw.githubusercontent.com/img2threejs/img2interior-media/375e6af7ab526d7c0c10be91b0e72f2757391ec7/living-room-viewer.webp)
+[![Archived browser screenshot of the living-room reconstruction, with source comparison, camera views, wireframe, curtain controls, sofa finishes and native/portable download links.](https://raw.githubusercontent.com/img2threejs/img2interior-media/375e6af7ab526d7c0c10be91b0e72f2757391ec7/living-room-viewer.webp)](https://img2threejs.io/living-room/)
-A **static screenshot of the working Three.js project**, not a hosted live demo. Its controls are not interactive inside this README. Indirect lighting is baked; curtain movement does not produce fully dynamic global illumination. The portable GLB is a separate static product, not a copy of every browser behavior.
+This is a **static capture of the working Three.js project**; the live, interactive page lives at **[img2threejs.io/living-room/](https://img2threejs.io/living-room/)**. Indirect lighting is baked; curtain movement does not produce fully dynamic global illumination. The portable GLB is a separate static product, not a copy of every browser behavior.
</details>
-[Public preview gallery](https://github.com/img2threejs/img2interior-media) · [Bundled gallery and limitations](docs/showcase/README.md)
+[Live demo](https://img2threejs.io/living-room/) · [Public preview gallery](https://github.com/img2threejs/img2interior-media) · [Bundled gallery and limitations](docs/showcase/README.md)
## Copy-and-use prompt
@@ -110,40 +116,45 @@ The handoff also includes the scene specification and Python builder, source/ass
| Native authoring | Separate Python 3.11 environment with `bpy==4.3.0` and `numpy==1.26.4` |
| Image tools / preview | Separate environment from `requirements-surfaces.txt`; a WebGL-capable browser |
-The harness registers the skill; it does not install bpy or create the finished app. The agent follows the bundled [environment setup](reference/production-runbook.md#2-prepare-project-local-environments) and preflight before authoring. Compatible Blender wheels must exist for your platform. Obtain written authorization for the proprietary portions before installing or using them.
+The harness registers the skill; it does not install bpy or create the finished app. The agent follows the bundled [environment setup](reference/production-runbook.md#2-prepare-project-local-environments) and preflight before authoring. Compatible Blender wheels must exist for your platform. Installation and use are free under the [license](LICENSE), including commercial project work; commercializing the tool itself requires prior written permission.
-### Available now: private source or supplied source archive
+### Public npm install (preferred)
-For the Git method, you need read access to `img2threejs/img2interior` and authenticated Git credentials. These commands register the skill with local agent hosts, so they change local harness/host configuration. Keep the checkout in a persistent location. If you already have a compatible harness, skip its `install` command; if you already have the checkout, do not clone over it.
+Install `@img2threejs/[email protected]` from the public npm registry into a dedicated, persistent prefix, then register it with the official img2 harness via `add --link`. `npm install` is the real distribution and tracking event; `add --link` is the host registration step. The package has no lifecycle scripts, so `npm install` performs only a fetch and a directory copy.
```sh
-git clone https://github.com/img2threejs/img2interior.git "$HOME/img2interior"
+npm install --prefix "$HOME/.local/share/img2interior" @img2threejs/[email protected]
npx --yes @img2threejs/[email protected] install --yes
-npx --yes @img2threejs/[email protected] add --link "$HOME/img2interior" --yes
+npx --yes @img2threejs/[email protected] add --link "$HOME/.local/share/img2interior/node_modules/@img2threejs/img2interior" --yes
npx --yes @img2threejs/[email protected] doctor --json
npx --yes @img2threejs/[email protected] sync --check
```
-Restart the agent session, open your project and use the prompt above. The registry ID is **`interior`**; the agent-facing skill is **`img2-interior`**. An authorized source archive uses the same `add --link` flow after extraction. See [installation and removal](reference/installation.md) for archive paths, updates and cleanup.
+Skip the `install --yes` step if a compatible harness already exists on this host; the `add --link` flow alone is sufficient then. Keep the dedicated prefix in place at `$HOME/.local/share/img2interior` — future `npm install --prefix "$HOME/.local/share/img2interior" @img2threejs/img2interior@<version>` commands update the live link without moving it. Do not pass `--force`, do not run a global install, and do not delete the prefix while a host link still points inside it.
-### Planned: private npm payload
+Restart the agent session, open your project and use the prompt above. The registry ID is **`interior`**; the agent-facing skill is **`img2-interior`**. To install from a Git clone or supplied source archive (pre-publication, an exact commit, or working without npm connectivity), follow [install from public source](reference/installation.md#install-from-public-source-or-supplied-archive). To remove and update, see [installation and removal](reference/installation.md).
-The intended npm package will contain the **skill implementation and bundled guides**, not a public installer that still fetches private GitHub source. Authorized consumers will need npm authentication and package read access, rather than GitHub source access. Package readers can inspect downloaded code; private distribution is access control, not code encryption.
+> **Why this two-step path?** The img2 0.4.0 harness `add npm:@img2threejs/img2interior@<version> --yes` flow expects `npm view` to return a nested `info.dist.integrity`, but npm 10/11 return a flat `dist.integrity`; `add` therefore refuses the package rather than registering it. Real consumers use `npm install` to fetch the public package into a dedicated prefix, then `add --link` that installed copy. The `add npm:` transport bug lives in the img2 harness, not in this package; until the harness ships a fix, the documented supported install path is the two-step flow above.
-**No npm package name/version or install command is advertised yet.** The package, access policy and consumer installation must be verified before those instructions go live. Installing an arbitrary npm package also does not register a skill automatically; registration uses the official img2 harness. Maintainers: follow the [private npm release checklist](reference/installation.md#private-npm-release-checklist).
+### Package and download metrics
+
+- **Package:** [`@img2threejs/img2interior`](https://www.npmjs.com/package/@img2threejs/img2interior), version `0.3.1`, published with `--access public`.
+- **Download counts** (last month, daily series, custom date ranges) and **package metadata** come from the documented public npm registry API — see [download metrics](reference/installation.md#download-metrics) for the exact endpoints and their limits. The version + downloads badges at the top of this README resolve through that same API; they reflect real registry values, not local instrumentation, and lag the registry by roughly one day.
+
+`npm install` is the source of the download counts that the badge shows; `add --link` is local-only registration and is not tracked by the npm registry.
## Guides
-Detailed guides are **bundled with the installed skill**; ask the agent to read them there. Their GitHub links require separate repository access. The public previews do not require that access.
+Detailed guides are **bundled with the installed skill**; ask the agent to read them there. The GitHub repository and the public npm package ship the same project, so the links below point at the public GitHub repo. The live demo above and the bundled preview gallery need no extra access.
| Guide | Start here when… |
| --- | --- |
-| [Installation and release](reference/installation.md) | Installing, updating, removing, or preparing the private npm payload |
+| [Installation and release](reference/installation.md) | Installing from npm or source, updating, removing, or preparing a new public release |
| [Production runbook](reference/production-runbook.md) · [Agent entry point](SKILL.md) | Running or resuming the complete reconstruction |
| [Scene contract](reference/scene-contract.md) | Understanding editable scene inputs and the Blender builder |
| [Resources](reference/resources.md) · [Materials](reference/materials.md) | Selecting assets, recording rights, and preparing PBR surfaces |
| [Bake / export](reference/bake-export.md) · [Viewer](reference/viewer-integration.md) | Understanding the native/runtime/portable split |
-| [Delivery](reference/delivery.md) · [Verification record](VERIFICATION.md) | Checking consumer evidence and the scope of previous verification |
+| [Delivery](reference/delivery.md) | Handing off and inspecting the final native/runtime/portable products |
| [Changelog](CHANGELOG.md) · [Maintainer checks](reference/installation.md#maintainer-checks) | Reviewing changes or validating a contribution |
## Limits to understand
@@ -154,16 +165,31 @@ Detailed guides are **bundled with the installed skill**; ask the agent to read
- **Interaction is scoped.** Optional rail-mounted curtains use a position-based approximation, not a general cloth solver.
- **Performance is scene-dependent.** Desktop or narrow-viewport captures do not certify physical phones, arbitrary hardware or production network performance.
-## Support and contributions
+## Support
+
+If this skill saved you time, consider supporting continued work via the same payment channels used by the broader img2threejs project:
-Repository members can use [issues](https://github.com/img2threejs/img2interior/issues) for reproducible bugs. Include plugin/harness versions, OS, the command, expected/actual behavior and a minimal reproduction. Remove credentials, private references, client assets and identifying paths. Package access alone does not grant access to private GitHub issues; npm-only consumers should ask their package administrator to forward reports to the maintainer.
+- Ko-fi: [ko-fi.com/O8A625YLSR](https://ko-fi.com/O8A625YLSR)
+- Donate page (VietQR / MoMo / PayPal / Binance Pay): [img2threejs.io/donate.html](https://img2threejs.io/donate.html)
+- Direct PayPal: [paypal.com/paypalme/NguyenHoai545](https://www.paypal.com/paypalme/NguyenHoai545)
+- Direct Binance Pay: [app.binance.com/uni-qr/Trcs9shL](https://app.binance.com/uni-qr/Trcs9shL)
-Report security-sensitive information privately to the repository owner; read the bundled [security policy](SECURITY.md) before executing authored Python or consuming external resources. Paid generation, uploads, public deployment and redistribution need their own authorization.
+Supporting this project is not required to install or use the skill; the [license](#license) covers all permitted free use without it.
-Contributions to proprietary portions require prior written authorization and agreed terms. Keep generated projects, dependencies and private evidence out of commits; the approved documentation previews are the explicit exception. Describe the behavior changed and checks exercised. Separately licensed components retain their own terms; see [component notices](THIRD_PARTY_NOTICES.md) and [maintainer checks](reference/installation.md#maintainer-checks).
+## Contributions
+
+Use [GitHub issues](https://github.com/img2threejs/img2interior/issues) for reproducible bugs and pull requests for fixes. Include plugin/harness versions, OS, the command, expected/actual behavior and a minimal reproduction. Remove credentials, private references, client assets and identifying paths before posting.
+
+Report security-sensitive information privately to the repository owner; read the bundled [security policy](SECURITY.md) before executing authored Python or consuming external resources. Paid generation, private-image uploads, public deployment and redistribution of third-party content need the relevant authorization; sharing this tool follows the [license](LICENSE).
+
+Keep generated projects, dependencies and private evidence out of commits; the approved documentation previews are the explicit exception. Describe the behavior changed and checks exercised. Modifications and free noncommercial sharing are permitted under the [license](LICENSE); agree contribution terms with the maintainer before submission. Separately licensed components retain their own terms; see [component notices](THIRD_PARTY_NOTICES.md) and [maintainer checks](reference/installation.md#maintainer-checks).
## License
-**Proprietary — All rights reserved.** The [primary license](LICENSE) grants no automatic permission to use, modify or redistribute the proprietary portions. Obtain written authorization from the copyright holder; GitHub/npm access or payment alone is not a usage license.
+**Free to use, including commercial project work; commercialization of the tool requires permission.** The [img2 Interior Free Use, Restricted Commercialization License 1.0](LICENSE) permits use, modification, paid client work and commercial delivery of your outputs without a license fee. It also permits free noncommercial sharing with the license and notices preserved.
+
+You must obtain the copyright holder's **prior written permission** to sell or rebrand and resell the tool, bundle it into a commercial software product, or offer paid hosted/API access to its authoring or generation workflow. Attribution or publishing your modified source does not replace permission. Request it through [img2threejs](https://github.com/img2threejs).
+
+Your original scenes, models, renders and artwork remain yours. Viewer/runtime code may accompany paid output deliverables under the license's output exception; it may not be sold as a standalone toolkit without permission. Third-party content retains its own terms.
-[Component notices and prior grants](THIRD_PARTY_NOTICES.md) preserve separately licensed material, including existing Apache-2.0 rights. They do not make the whole product open source, and the proprietary license does not override them. Third-party content and your artwork retain their respective rights.
+This is **source-available**, not OSI-approved open source. [Component notices and prior grants](THIRD_PARTY_NOTICES.md) preserve separately licensed material, including existing Apache-2.0 rights and their commercial permissions; the new restrictions do not override those grants.
diff --git a/SKILL.md b/SKILL.md
index af45038..80e05a2 100644
--- a/SKILL.md
+++ b/SKILL.md
@@ -1,15 +1,19 @@
---
name: img2-interior
description: Builds image-led interiors through Blender/Python, PBR, render-and-repair, bake/export and an interactive Three.js viewer; verifies native/runtime/portable delivery with img2.
-license: Proprietary. See LICENSE and THIRD_PARTY_NOTICES.md.
-version: 0.3.0
+license: LicenseRef-img2-Interior-Free-Use-Restricted-Commercialization-1.0. See LICENSE and THIRD_PARTY_NOTICES.md.
+version: 0.3.1
---
# Image → authored interior → working delivery
Accept one supplied room image and one assignment. Continue through analysis, implementation, visual repair, interactive runtime and delivery; do not return only a plan, ask the user to supply JSON, or stop after a Blender file/build. This is a skill for an image-capable coding agent, not a deterministic neural image-to-mesh service.
-Set `SKILL_DIR` to this installed directory and work in the user's project, never the plugin checkout. Install through the official img2 harness; see [installation](reference/installation.md). Preserve unrelated user files. No global installs, publishing or paid-service requests by default.
+Set `SKILL_DIR` to this installed directory and work in the user's project, never the plugin checkout. Install through the official img2 harness; see [installation](reference/installation.md). The public npm package is `@img2threejs/img2interior`; the public source lives at `img2threejs/img2interior` on GitHub. Preserve unrelated user files. No global installs, publishing or paid-service requests by default.
+
+## Showcase and support (discoverable reference)
+
+The bundled [showcase gallery](docs/showcase/README.md) is the same authored scene published at the [live demo](https://img2threejs.io/living-room/). It is inspiration for what a finished delivery looks like, not a benchmark for every room. The skill is maintained alongside the parent img2threejs project; supporting the parent via [Ko-fi](https://ko-fi.com/O8A625YLSR), the [donate page](https://img2threejs.io/donate.html), [PayPal](https://www.paypal.com/paypalme/NguyenHoai545) or [Binance Pay](https://app.binance.com/uni-qr/Trcs9shL) helps fund continued work, but is not required to install or use this skill.
## Start from the actual image
diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.md
index d9d0dcd..5444038 100644
--- a/THIRD_PARTY_NOTICES.md
+++ b/THIRD_PARTY_NOTICES.md
@@ -1,10 +1,10 @@
# Component licenses and prior grants
-The primary product license is the [img2 Interior Proprietary License](LICENSE). This file identifies portions and rights excluded from its restrictions; it is not a choice of alternative licenses for the entire product. These notices include author-owned material retained under an earlier license, not only third-party dependencies.
+The primary product license is the [img2 Interior Free Use, Restricted Commercialization License 1.0](LICENSE). This file identifies portions and rights excluded from its restrictions; it is not a choice of alternative licenses for the entire product. These notices include author-owned material retained under an earlier license, not only third-party dependencies.
## Apache-2.0 components
-The following repository-relative paths remain under Apache License, Version 2.0, rather than the proprietary terms:
+The following repository-relative paths remain under Apache License, Version 2.0, rather than the primary license's commercialization restrictions:
- `authoring/` and all its contents
- `recipes/` and all its contents
@@ -14,11 +14,11 @@ The following repository-relative paths remain under Apache License, Version 2.0
- `tests/test_authoring.py`
- `requirements-authoring.txt`
-Their retained copyright notice is **Copyright 2026 hoainho**. The complete license and copyright notice are in [licenses/Apache-2.0.txt](licenses/Apache-2.0.txt). Preserve the license and applicable notices when redistributing these portions. The proprietary license does not limit the rights granted for these components.
+Their retained copyright notice is **Copyright 2026 hoainho**. The complete license and copyright notice are in [licenses/Apache-2.0.txt](licenses/Apache-2.0.txt). Preserve the license and applicable notices when redistributing these portions. The primary license does not limit the rights granted for these components, including commercial use and redistribution under Apache-2.0.
## Previously licensed material
-Earlier revisions, including the 0.2.0 source through commit `2dceef978d2fd696ea4d1f531049389d3b666eed`, were provided under Apache-2.0. Already granted rights remain effective, including rights to earlier material reused in later revisions. Consult the license supplied with the applicable revision; proprietary terms do not retroactively turn those grants into exclusive rights.
+Earlier revisions, including the 0.2.0 source through commit `2dceef978d2fd696ea4d1f531049389d3b666eed`, were provided under Apache-2.0. Already granted rights remain effective, including rights to earlier material reused in later revisions. Consult the license supplied with the applicable revision; the primary license's restrictions do not retroactively remove those grants.
Apache-2.0's [copyright grant, section 2](https://www.apache.org/licenses/LICENSE-2.0.txt), is perpetual and irrevocable, subject to the license's terms. A private repository, private npm package or changed license label does not withdraw that grant.
@@ -26,11 +26,11 @@ Apache-2.0's [copyright grant, section 2](https://www.apache.org/licenses/LICENS
Apache-2.0 is compatible with GPLv3, not GPLv2-only. Blender and its Python API retain their own license requirements. [Blender's published licensing guidance](https://www.blender.org/about/license/#add-ons) requires distributed Python API scripts to be shared under a GPL-compliant license and distinguishes software from artwork.
-Neither `LICENSE` nor this file creates a GPL exception or certifies a combined distribution's compliance. Review Blender binaries, Python API integrations and combined distributions before release; obtain qualified legal advice where the boundary is uncertain. Do not apply the proprietary restrictions to rights that must remain available under an applicable component license.
+Neither `LICENSE` nor this file creates a GPL exception or certifies a combined distribution's compliance. Review Blender binaries, Python API integrations and combined distributions before release; obtain qualified legal advice where the boundary is uncertain. Do not apply the primary license's restrictions to rights that must remain available under an applicable component license.
## External dependencies and resources
-Third-party code, dependencies, assets and their required notices retain their respective licenses. The img2 harness, Blender/bpy, Three.js, build tools, Python packages and acquired resources are not made proprietary by the product license. Preserve required licenses and notices in any distribution that includes them. A dependency's permissive license and a resource provider's API terms are separate questions.
+Third-party code, dependencies, assets and their required notices retain their respective licenses. The img2 harness, Blender/bpy, Three.js, build tools, Python packages and acquired resources are not relicensed by the product license. Preserve required licenses and notices in any distribution that includes them. A dependency's permissive license and a resource provider's API terms are separate questions.
## User inputs and artwork
diff --git a/VERIFICATION.md b/VERIFICATION.md
deleted file mode 100644
index a764f69..0000000
--- a/VERIFICATION.md
+++ /dev/null
@@ -1,77 +0,0 @@
-# Verification — 0.2.0
-
-Observed on 2026-10-18, macOS 14.5 arm64. Executed environments: Python 3.12.15 with NumPy 2.5.4/Pillow 12.3.0 for image tools; Python 3.11.10 with bpy 4.3.0/NumPy 1.26.4 for native production; Node 20.18.1; Three.js 0.180.0, Vite 6.4.1 and glTF Validator 2.0.0-dev.3.10. The compatibility harness is img2 0.4.0, core API 1, source revision `95c722b524118eb6dde74c1f47bff7dd1c18aef3`.
-
-Evidence is retained in external authored workspaces under `.img2/artifacts/interior/production/`. Images, downloaded resources, generated models, private host settings and machine bootstrap paths are not part of the source release. These are mechanism/consumer checks, not a final-quality reconstruction or physical-phone certification.
-
-## Integrated behavior and installation
-
-- Current source: **80 Python tests passed, no skips**, in 16.755 seconds, including actual bpy packed-image, weighted-sheen, repeated-bake identity and asymmetric UV1/native transport regressions.
-- Current viewer: **13 Node behavior tests passed, no skips**, in 842.301 ms. These exercise actual geometry/numerics, material-point and hem binding, input ownership/cancellation, sleeping/reduced motion, bounded navigation, manifest boundaries and decoded lightmap orientation.
-- Both official source CLI and npm-published img2 0.4.0 entrypoints passed `scripts/verify_install.py`: install → link → doctor → sync → typed capability → update check → removal, across isolated Claude Code, Codex and OpenCode configurations. Each doctor reported **0 failures and 0 warnings**. Existing host configuration/source checkout were preserved; no real host account was installed or rewritten.
-
-Reproduction commands, with the compatible interpreters/dependencies selected:
-
-```sh
-IMG2_HARNESS_SOURCE="$HARNESS" IMG2_BLENDER_PYTHON="$BLENDER_PYTHON" python3 -m unittest discover -s tests -v
-VIEWER_ROOT="$W" node --test tests/viewer/*.test.mjs
-python3 scripts/verify_install.py --harness-source "$HARNESS"
-```
-
-## Cold live-resource production
-
-The source-hash-guarded Oak/Linen recipe ran in a fresh external workspace. Live Poly Haven API discovery/files/acquisition downloaded **48 files, 82,059,982 bytes**, covering 12 selected assets: five models, five scans and two HDRIs. Publisher MD5/size and local SHA receipts were recorded. Model/texture/HDRI inputs were not copied from the old showcase outputs.
-
-Actual preparation, native geometry, source render and all five two-pass/OIDN atlas groups completed. The labelled eight-sample smoke used these atlas resolutions: architecture 256, textiles 1024, furniture 512, garden 2048, details 512. The final sequential five-group/probe/export command completed in 1031.32 seconds; this is an observed workload duration, not a model/worker benchmark.
-
-A prior uniform 2K/4K CPU bake exceeded its 1800-second runner deadline and is **not** counted as successful. Small budgets also triggered real subpixel-UV rejection. UV-only measurements selected working per-group budgets; geometry was not deleted and the pixel-area/gutter guards were not weakened.
-
-Independent Blender processes reopened/rendered the packed master and portable GLB. The actual scene has **208 meshes, 661,342 triangles and 18 components**; its browser loaded all five atlases and real PBR resources with no captured page errors. Actual source/native/portable contact sheet, lateral render and textile render were generated and inspected. They show coarse composition and consumer appearance, not a renewed high-resolution likeness grade.
-
-| Cold product | Bytes | SHA256 |
-|---|---:|---|
-| Runtime GLB | 106,828,728 | `77c8a4f7ef0a4d2d227bd306255c27f4bfde137fbfe8577d2d3a8c753d8e72e1` |
-| Portable GLB | 25,557,016 | `116463d44dd0b81835c645c041a129b8ea672921639b18261ae06a39fb5923f9` |
-
-Both GLBs passed actual Khronos validation with **0 errors and 0 warnings**; informational unused-attribute messages remain in the receipts. The portable has five embedded images and 35 unlit materials; two glass/emission exceptions remain physically approximate. Its UV1 texture coordinates were independently inspected. Current named-material audit passed, and the delivery audit hashed all **12** manifest-discovered source/runtime/portable/native/sidecar products.
-
-## Fresh independent scene and causal material repair
-
-The separate asymmetric studio was authored outside the plugin: **34 meshes, 10,832 triangles, nine components, four atlases**. It is deliberately not a reconstruction of the supplied Oak/Linen image. It exercised draft → bake → probe → export, real image dye, packed-image refresh, invalidation, regeneration, viewer and independent native/portable reopening.
-
-- External 32×32 albedo changed from SHA `2fc6f37a08d526538e6b693925c024e77509c1b875bf4de3bb5af9eddbf95094` to `f59860df30e2a3e3a624fbdb103135c6ed2aec16321e7e8da67a6b12665bb6fc`.
-- After refresh, export actually rejected the stale probe. With a newly captured probe but no rebake, it separately rejected dirty atlases. Full regeneration then succeeded.
-- Exported repaired GLB albedo was decoded and compared against the real PNG: **maximum 8-bit channel error 0**. Canonical oriented triangle/transform/POSITION/NORMAL/TANGENT/UV0 digest stayed `02c7483966e6af72d23ee76ec290ffce8b74612878741128d5ca360d6aaea87f`; UV1 was excluded because repacking is allowed.
-- Actual repeated export initially failed because names grew from `PackedCloth__textiles` to `PackedCloth__textiles__textiles`. The permanent native regression fails before the repair and passes afterward. Reusing prepared materials/UV0 mappings preserves all ten studio material names; artist roughness 0.72 survives repeated preparation/export. Production case policy targets were migrated to stable names.
-- The repaired runtime/portable again passed Khronos with zero errors/warnings. Independent consumers rendered both products. Actual UI-triggered downloads matched the current portable and packed native bytes by SHA, not merely filename.
-
-## Native ↔ browser transport calibration
-
-The actual asymmetric UV1/native reimport, emissive-cardinal equirectangular probe and lossless float EXR checks passed. A separate zero-specular/black-probe/no-sun fixture used rotated UV1 and the real EXR decoder, PI convention and production shader.
-
-Its browser drawing buffer and native expected image were both **256×192 at DPR 1**, with matching projection and no image realignment. Normalized sRGB absolute error: all-pixel mean **0.00364147**; interior mean **0.00311741**, p95 **0.00784314**. The interior mask is expected nonblack pixels >0.02, eroded two pixels, 28,616 pixels. It passed the declared mean ≤0.01/p95 ≤0.02 tolerances. An intentionally vertically flipped negative control had interior mean **0.11207560**. Native, actual browser and amplified-difference images were inspected. This is transport calibration, not image likeness or a complete browser specular-probe certification.
-
-## Real browser interaction and lifecycle
-
-On the original studio generation, frame-paced low/mid/high cloth grips measured held-point errors **1.24–2.16 mm**; actual hem picking measured **0.094 mm**. Headers and camera pose/projection stayed unchanged during those grips, including wheel ownership, and wheel navigation resumed after release. Evidence retains transient timing rather than claiming every unpaced sample is converged.
-
-Visible controls exercised source/3D, wireframe restoration, finishes, keyboard/reset/bounds, coverage/open/close and wind. Actual capture loss and source-mode changes cancelled grabs; settled wind-off and reduced-motion scenes stopped requesting frames. A real manifest 404 and real `WEBGL_lose_context` event each produced error UI and recovered through Retry. A 390-pixel viewport had no horizontal document overflow; actual offscreen scrolling paused frames and returning resumed them.
-
-After the final albedo repair, a fresh persistent browser tab loaded the regenerated assets, changed the actual finish, switched source/3D and downloaded both products with matching bytes. Live reference images were fully loaded; computed heading sizes were 54.72/32 px. The static design detector's two missing-src and flat-heading warnings do not describe this live surface; its Arial preference warning was not treated as a functional defect. Vite's genuine **>500 kB chunk warning** remains (676.47 kB minified JS, 180.32 kB gzip).
-
-The cold room also exercised a real rear-panel body grip/release: both header errors 0, camera unchanged, moving held-point lag **15.884 mm**. That is a different workload from the small studio, not a universal sub-3-mm claim.
-
-## Eight reviews and three blocking gates
-
-Current repaired studio products passed material and delivery audits, immutable receipt snapshotting, all eight ordered reviews and the installed SDK gate runner. The run deliberately rejected materials, refused a downstream acceptance, explicitly revised, then completed; **11 history events** remain. `interior-materials`, `interior-delivery` and `interior-workflow` each passed with exit 0.
-
-All attestations explicitly identify this as a controlled release-mechanism fixture, **not image-likeness or final-artwork approval**. Review identity is an attestation, not cryptographic reviewer authentication. Regression coverage separately exercises changed source/policy/assets/receipts, symlink/path escapes, stale evidence and dependent-stage invalidation.
-
-## Source packaging and limits
-
-Build with `python3 scripts/package_plugin.py --output /absolute/release-directory`; `--output` is a directory. Extract the ZIP into a fresh location and run the behavior/official-install checks against that extracted checkout. Keep `SHA256SUMS` outside the source document rather than embedding an archive checksum in the files it hashes. The packager excludes Git metadata, dependencies/builds, environments, generated bootstraps, credentials, workspace state and generated image/model assets; fixed timestamps/modes support reproducible source ZIPs.
-
-- Smoke resolutions/eight samples do not establish final texture density, denoising quality, glass fidelity, full-resolution realism or a mobile asset budget. The cold runtime is about 107 MB; it is not a phone-performance baseline.
-- GI/probe/portable appearance remain static during runtime cloth/finish changes. Native estimates are not measured geometry/material truth; cloth is the documented rail/PBD approximation, not FEM.
-- Hidden-document browser pausing, actual multitouch/touchcancel on physical devices and physical-phone performance were not certified. An old heavily instrumented tab stalled image decode after reload; identical final assets completed in a fresh persistent tab without errors. No asset/shader workaround was added for that retained-context observation.
-- Local source/runtime evidence does not claim a completed GitHub Actions run, public deployment, npm publication or catalog registration. Repository hosting/visibility are separate publication checks; keep the requested source repository private.
diff --git a/docs/showcase/README.md b/docs/showcase/README.md
index 1b05828..3ebda2b 100644
--- a/docs/showcase/README.md
+++ b/docs/showcase/README.md
@@ -1,6 +1,6 @@
# Showcase — Oak / Linen Living Room
-These previews are bundled with the skill so authorized package readers can open them locally without GitHub source access. Open this file in a Markdown viewer or ask the agent to open the adjacent WebP images. The landing-page README uses the identical images from the separately authorized [public media repository](https://github.com/img2threejs/img2interior-media).
+These previews are bundled with the skill so anyone with the public package or public source can open them locally. Open this file in a Markdown viewer or ask the agent to open the adjacent WebP images. The landing-page README uses the identical images from the separately hosted [public media repository](https://github.com/img2threejs/img2interior-media). An actual interactive viewer of the same authored scene is hosted at [img2threejs.io/living-room/](https://img2threejs.io/living-room/); the README links to that live demo. The first image below is the **native Blender render** (reference + reconstruction) and the second is an **archived screenshot of the browser viewer** — they are different products, both included for offline review.
## Reference → editable native scene
@@ -12,7 +12,7 @@ These previews are bundled with the skill so authorized package readers can open
![Archived Three.js screenshot of the authored living room, reference comparison, camera views, wireframe, curtain controls, sofa finishes and model/native download links.](living-room-viewer.webp)
-This is a static capture of the actual project, not a public live demo or an interactive image. Visible download controls refer to that project; no Blender/GLB downloads are published with this gallery.
+This is an **archived browser screenshot** of the working Three.js project — not a public live demo and not the native render (the first image above is the native comparison; this one is the browser view). Visible download controls refer to that project; no Blender/GLB downloads are published with this gallery. The live, interactive version of the same viewer lives at [img2threejs.io/living-room/](https://img2threejs.io/living-room/).
## What this example establishes
@@ -28,4 +28,4 @@ The case is intentionally source-specific. Its recipe is guarded by the original
- The original study is a large research payload, not a lightweight deployment benchmark. Desktop and emulated narrow-viewport captures do not certify physical phones, arbitrary hardware or production networks.
- Example-specific counts, material settings and acceptance measurements are not universal quality thresholds. Passing structural/export checks does not establish visual fidelity for a new image.
-Only two optimized documentation images are bundled here. Full-resolution references, native/GLB assets, textures, private paths and production reports remain outside the package. Plugin access and third-party content retain their respective terms; see the [license](../../LICENSE). Public previews grant no rights to unpublished implementation or scene assets.
+Only two optimized documentation images are bundled here. Full-resolution references, native/GLB assets, textures and production reports remain outside the package; they are not required to read this skill. Third-party content retains its own terms; see the [license](../../LICENSE). Public previews grant no rights to any user's project assets.
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..5ea176f
--- /dev/null
+++ b/package.json
@@ -0,0 +1,86 @@
+{
+ "name": "@img2threejs/img2interior",
+ "version": "0.3.1",
+ "description": "Agent-operated image/reference analysis, Poly Haven acquisition, Blender/Python authoring and PBR, render/repair, bake/export, Three.js interaction and verified native/runtime/portable delivery.",
+ "license": "SEE LICENSE IN LICENSE",
+ "author": {
+ "name": "hoainho"
+ },
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/img2threejs/img2interior.git"
+ },
+ "bugs": {
+ "url": "https://github.com/img2threejs/img2interior/issues"
+ },
+ "homepage": "https://img2threejs.io/living-room/",
+ "publishConfig": {
+ "access": "public",
+ "registry": "https://registry.npmjs.org/"
+ },
+ "funding": [
+ {
+ "type": "ko-fi",
+ "url": "https://ko-fi.com/O8A625YLSR"
+ },
+ {
+ "type": "other",
+ "url": "https://img2threejs.io/donate.html"
+ }
+ ],
+ "keywords": [
+ "img2",
+ "img2-interior",
+ "img2threejs",
+ "interior",
+ "blender",
+ "pbr",
+ "three.js",
+ "threejs",
+ "scene",
+ "agent",
+ "skill"
+ ],
+ "engines": {
+ "node": "^18.0.0 || ^20.0.0 || >=22.0.0"
+ },
+ "files": [
+ "plugin.json",
+ "steps.json",
+ "gates.json",
+ "SKILL.md",
+ "README.md",
+ "LICENSE",
+ "THIRD_PARTY_NOTICES.md",
+ "licenses/Apache-2.0.txt",
+ "SECURITY.md",
+ "CHANGELOG.md",
+ "requirements.txt",
+ "requirements-authoring.txt",
+ "requirements-surfaces.txt",
+ "package.json",
+ "tools/**",
+ "authoring/**",
+ "resources_lib/**",
+ "runtime/**",
+ "recipes/**",
+ "reference/**",
+ "examples/**",
+ "docs/showcase/**",
+ "!**/_img2_local.py",
+ "!**/__pycache__/**",
+ "!**/*.pyc",
+ "!**/*.pyo",
+ "!**/node_modules/**",
+ "!**/dist/**",
+ "!**/.img2/**",
+ "!**/.venv/**",
+ "!**/.venv-blender/**",
+ "!**/.venv-images/**",
+ "!**/.env",
+ "!**/.env.*",
+ "!**/*.pem",
+ "!**/*.key",
+ "!**/.DS_Store"
+ ]
+}
\ No newline at end of file
diff --git a/plugin.json b/plugin.json
index 796c7e8..59a7943 100644
--- a/plugin.json
+++ b/plugin.json
@@ -1,7 +1,7 @@
{
"schema": 1,
"name": "interior",
- "version": "0.3.0",
+ "version": "0.3.1",
"description": "Agent-operated image/reference analysis, Poly Haven acquisition, Blender/Python authoring and PBR, render/repair, bake/export, Three.js interaction and verified native/runtime/portable delivery.",
"capabilities": [{"from": "image", "to": "interior-scene-candidate"}],
"requires": {"harness": ">=0.4.0", "coreApi": 1}
diff --git a/reference/delivery.md b/reference/delivery.md
index 0a01a01..987b422 100644
--- a/reference/delivery.md
+++ b/reference/delivery.md
@@ -34,6 +34,6 @@ The showcase is heavy research output, not a mobile-performance baseline. Budget
## Release only the workflow package
-This repository distributes the skill, deterministic tools, references and examples; it does not bundle the showcase's large assets, paid-service credentials or upstream private code. Build a deterministic source ZIP with `python3 scripts/package_plugin.py`. Install the extracted directory through official `img2 add --link` and run doctor/sync again.
+This package distributes the skill, deterministic tools, references and examples; it does not bundle the showcase's large assets, paid-service credentials or upstream private code. Maintainers can build a deterministic source ZIP from the repository with `python3 scripts/package_plugin.py`; development scripts and tests are not part of the npm skill payload. Install an extracted source directory through official `img2 add --link` and run doctor/sync again.
-The release includes actual `authoring/`, `resources_lib/`, `runtime/viewer/`, guarded `recipes/`, dependency declarations and source examples, excluding dependency installs, renders/caches, credentials and large assets. Current evidence/limits belong in `VERIFICATION.md`; historical showcase observations are not current cold-run acceptance.
+The release includes actual `authoring/`, `resources_lib/`, `runtime/viewer/`, guarded `recipes/`, dependency declarations and source examples, excluding dependency installs, renders/caches, credentials and large assets. Keep current evidence and limits in the authored project's handoff; historical showcase observations are not current cold-run acceptance.
diff --git a/reference/installation.md b/reference/installation.md
index 9a191c0..5269777 100644
--- a/reference/installation.md
+++ b/reference/installation.md
@@ -6,11 +6,30 @@
- A configured, image-capable Claude Code, Codex or OpenCode host with command execution and browser/image inspection. Hermes is not supported by this harness.
- Production native tools: isolated Python 3.11/bpy 4.3.0/NumPy 1.26.4 (`requirements-authoring.txt`); separate NumPy/Pillow image environment (`requirements-surfaces.txt`). Audit/state tools remain stdlib plus core API 1.
- Workspace-local pinned npm dependencies and a real WebGL browser for the viewer/validator. See [production setup and commands](production-runbook.md); a harness install does not silently install bpy, image packages or a web app. Compatible Blender wheels must exist for your platform.
-- Version 0.3.0 uses the [img2 Interior Proprietary License](../LICENSE). Proprietary portions require prior written authorization; GitHub/npm access or payment alone is not a usage license. [Component notices](../THIRD_PARTY_NOTICES.md) preserve separately licensed portions and earlier grants.
+- Version 0.3.0 uses the [img2 Interior Free Use, Restricted Commercialization License 1.0](../LICENSE): use and modification are free, including commercial project work and output delivery; selling/bundling the tool or offering paid hosted/API access to its workflow requires prior written permission. The output exception permits viewer/runtime code with deliverables. [Component notices](../THIRD_PARTY_NOTICES.md) preserve separately licensed portions and earlier grants.
-## Install the private source checkout
+## Public npm install (preferred)
-Access to `img2threejs/img2interior` is required. Use authenticated HTTPS Git credentials or an authorized SSH key; never put access tokens in a remote URL. Linking does not make the source public. Keep the checkout in a persistent location outside authored projects.
+Install `@img2threejs/[email protected]` from the public npm registry into a dedicated, persistent prefix, then register it with the official img2 harness via `add --link`. `npm install` is the real distribution and tracking event; `add --link` is the host registration step. The package has no lifecycle scripts, so `npm install` performs only a fetch and a directory copy. Neither step requires Git credentials or an authenticated npm session — the package is in the default-public `@img2threejs` scope.
+
+```sh
+npm install --prefix "$HOME/.local/share/img2interior" @img2threejs/[email protected]
+npx --yes @img2threejs/[email protected] install --yes
+npx --yes @img2threejs/[email protected] add --link "$HOME/.local/share/img2interior/node_modules/@img2threejs/img2interior" --yes
+npx --yes @img2threejs/[email protected] doctor --json
+npx --yes @img2threejs/[email protected] sync --check
+npx --yes @img2threejs/[email protected] capabilities --from-kind image --to-kind interior-scene-candidate --plugin interior --json
+```
+
+Skip the `install --yes` step if a compatible harness already exists on this host; the `add --link` flow alone is sufficient then. Keep the dedicated prefix in place at `$HOME/.local/share/img2interior` — future `npm install --prefix "$HOME/.local/share/img2interior" @img2threejs/img2interior@<version>` commands update the live link without moving it. Do not pass `--force`, do not run a global install, and do not delete the prefix while a host link still points inside it.
+
+The first `npx --yes` belongs to npx; the second `--yes` on `add` skips the harness consent prompt. The plugin manifests as `interior`; the harness-derived skill name is `img2-interior`. Optional `--plugin interior` enforces the manifest `name` matches before the registration is written. Restart the agent session after adding, open the authored project, attach an image and use the [standard prompt](../README.md#copy-and-use-prompt).
+
+> **Why this two-step path?** The img2 0.4.0 harness `add npm:@img2threejs/img2interior@<version> --yes` flow expects `npm view` to return a nested `info.dist.integrity`, but npm 10/11 return a flat `dist.integrity`; `add` therefore refuses the package rather than registering it. Real consumers use `npm install` to fetch the public package into a dedicated prefix, then `add --link` that installed copy. The `add npm:` transport bug lives in the img2 harness, not in this package; until the harness ships a fix, the documented supported install path is the two-step flow above. Do not claim `add npm:` works.
+
+## Install from public source or supplied archive
+
+The public GitHub repository `img2threejs/img2interior` is the same project that ships as the public npm package. Use this path when you want an exact commit, when working without npm connectivity, or when the npm registry is unreachable. No private access or authenticated Git credentials are required for the public repository.
```sh
git clone https://github.com/img2threejs/img2interior.git "$HOME/img2interior"
@@ -21,11 +40,9 @@ npx --yes @img2threejs/[email protected] sync --check
npx --yes @img2threejs/[email protected] capabilities --from-kind image --to-kind interior-scene-candidate --plugin interior --json
```
-These commands change local harness/host configuration. Skip `install` if a compatible harness already exists; it is not an upgrade command. Do not clone over an existing checkout. Restart the agent session after linking, open the authored project, attach an image and use the [standard prompt](../README.md#copy-and-use-prompt).
-
-`interior` is the manifest/registry ID, `img2-interior` the harness-derived skill name, and `img2interior` this repository's name. The host link points through `$IMG2_HOME/plugins/interior/` to this persistent checkout. Do not move/delete a linked source. `_img2_local.py` in root/tools is generated and ignored, not committed or distributed.
+Skip the `install --yes` step if a compatible harness already exists on this host; the `add --link` flow alone is sufficient then. Do not clone over an existing checkout. Restart the agent session after adding, open the authored project, attach an image and use the [standard prompt](../README.md#copy-and-use-prompt).
-An authorized source archive installs through the same official CLI: extract it into a persistent directory and pass that extracted `img2interior` directory to `add --link`. Use its actual absolute path, not the ZIP path. Source hosting and archives do not create an npm package or catalog entry; do not run `img2 add interior` before a catalog entry exists.
+A supplied source archive installs through the same official CLI: extract it into a persistent directory and pass that extracted `img2interior` directory to `add --link`. Use its actual absolute path, not the ZIP path. The link points through `$IMG2_HOME/plugins/interior/` to this persistent checkout; do not move/delete a linked source. `_img2_local.py` in root/tools is generated and ignored, not committed or distributed. `add --link` is a local-only registration; the public GitHub source is unchanged.
## Inspect and remove
@@ -37,33 +54,50 @@ npx --yes @img2threejs/[email protected] remove interior --yes
Local links are live; `update` does not fetch them. Removal unregisters owned links, not the original checkout. Never use `--force` to hide another registration or overwrite an unrelated host path. Review the harness's refusal instead.
+## Download metrics
+
+Read public npm registry data through the documented endpoints; do not embed a tracker in the package or the source archive. Per the [npm download-counts spec](https://github.com/npm/registry/blob/main/docs/download-counts.md):
+
+- **Package metadata** (version, description, license, repository): `https://registry.npmjs.org/@img2threejs/img2interior` — no auth required for a public scoped package.
+- **Point-in-time total** for a single period (returns one integer count): `https://api.npmjs.org/downloads/point/{period}/@img2threejs/img2interior`, where `{period}` is `last-day`, `last-week` or `last-month`.
+- **Date range with one bucket per day**: `https://api.npmjs.org/downloads/range/last-month/@img2threejs/img2interior` — yields per-day totals for the last 30 days.
+- **Custom date range with one bucket per day**: `https://api.npmjs.org/downloads/range/YYYY-MM-DD:YYYY-MM-DD/@img2threejs/img2interior` for any period you choose.
+
+**Limits to disclose, not work around.** Download counts include CI reinstalls, mirror fetches and any consumer that ran the install command, so they are not a "unique users" figure; cached registry mirrors and offline package managers may report 0. The public API updates roughly daily with a delay; the badge in the README therefore lags real consumption. No telemetry, beacon or remote call is added by this skill — there is nothing to disable and the registry's API is the only source these counts come from.
+
## Project boundary
Keep the current directory in the authored project. Resolve `SKILL_DIR` from the linked skill, then call its tools by absolute path. Do not initialize a room inside the plugin. Project state is in `.img2/state.json`, under `plugins.interior`; receipts are under `.img2/artifacts/interior/`.
`interior_project.py start` pins a supplied image; the agent authors intake/spec/builder and executes the full loop. `install-viewer` and the explicit hash-guarded `use-recipe` copy owned templates into the workspace with preflight collision checks. A new image is never routed to the old room. Keep dependency/build installs local; the installed plugin is not the generated app. On resume use the recorded workflow's `next` operation rather than initialize again.
-## Private npm release checklist
+## Public npm release checklist
-**Chosen distribution model:** private GitHub development plus a **private scoped npm payload** containing the implementation. No npm package metadata, payload release or catalog entry exists yet; source/archive installation remains the available method. A public wrapper that fetches private GitHub source is not the intended consumer flow.
+**Distribution model:** public source repository plus a **public scoped npm package** that ships the same project. No GitHub authentication is required to read or install either artifact. The maintainer publishes the package with `npm publish --access public`; once that version is live and consumer-tested, the install command in the README is the supported path.
-The historical npm Enterprise product [was sunset](https://docs.npmjs.com/configuring-your-registry-settings-as-an-npm-enterprise-user/). For npm registry distribution, obtain a current user/organization plan supporting private packages, then configure package read/write permissions and authentication. A plan purchase is not a usage license, automatic package publication or code encryption. Do not confuse this with a separately configured GitHub Packages registry.
-
-1. **Confirm the real name, registry and access policy.** Select an owned scoped package name and exact version. Keep plugin ID `interior` and skill name `img2-interior`; align package and plugin versions. Do not advertise a copy/paste npm install command until that real version is published and consumer-tested.
+1. **Confirm the real name, registry and access policy.** Select an owned scoped package name and exact version (`@img2threejs/img2interior`, current release `0.3.1`). Keep plugin ID `interior` and skill name `img2-interior`; align package and plugin versions.
2. **Package the implementation, not a Git-fetch wrapper.** Use a reviewed root `package.json` and explicit file allowlist. Include `plugin.json`, `SKILL.md`, steps/gates, tools, authoring helpers, resource library, viewer/templates, required recipes/examples, references, dependency manifests, README, `docs/showcase/`, `LICENSE`, `THIRD_PARTY_NOTICES.md` and `licenses/Apache-2.0.txt`. Include needed scripts/fixtures without generated state. Exclude credentials, generated `_img2_local.py`, environments, `node_modules`, builds, private production reports, full-resolution references and generated scenes.
-3. **Keep access and license metadata correct.** Use `license: "SEE LICENSE IN LICENSE"` for the primary proprietary terms and their expressly excluded components, and `publishConfig.access: "restricted"` for the scoped private payload. `private: true` prevents npm publication; it is not the switch for a publishable private package. Include all three license/notice files and preserve component terms and earlier grants. Review Blender/Python API and combined-distribution obligations with qualified counsel; a proprietary product label is not a GPL exception or a guarantee of exclusive rights to every included file.
-4. **Review the actual tarball.** Run `npm pack --dry-run`, build the tarball, inspect its complete file list and install that exact artifact in an isolated consumer. The source ZIP packager is a separate format, not proof of an npm package. Reopen the bundled guides/gallery without GitHub access; verify license files, image paths and required runtime dependencies.
-5. **Authorize and perform the first publication separately.** Use explicit restricted access, reviewed bytes, package write permission and the account's required authentication/2FA. Do not publish merely to preview the README. For CI, review current [trusted-publishing support](https://docs.npmjs.com/trusted-publishers/) for the selected registry/account and workflow; never commit credentials or assume an OIDC flow has been configured. Private source repositories do not support npm provenance attestations; keep provenance disabled rather than claim an attestation exists.
-6. **Test authenticated consumer registration after publication.** Use the official `img2 add` provider with the published package's exact `npm:` source. Harness 0.4.0 resolves packages with `npm view` and `npm pack`; verify the intended npm registry/auth configuration in practice. Test without GitHub source credentials, plus doctor, sync, capability resolution, update and removal. Packages outside the default `@img2threejs` scope require explicit source approval. Check an unauthorized npm reader fails without partial registration; do not weaken access or use `--force` to conceal failures.
-7. **Keep versions immutable and update real instructions.** Record the package version/integrity, verify authorized and unauthorized reads, then replace the README's planned status with the tested install command. Use the official harness for registration; `npm install` alone is not host skill registration. A package release does not register an img2 catalog entry.
+3. **Use public access and correct license metadata.** Scoped packages default to restricted access; set `publishConfig.access: "public"` and publish with `--access public`. Do not set `"private": true`, which prevents publication entirely. Use npm's custom-license convention `license: "SEE LICENSE IN LICENSE"`; preserve `THIRD_PARTY_NOTICES.md` and `licenses/Apache-2.0.txt` rather than the deprecated `licenses` metadata array. Review Blender/Python API and combined-distribution obligations before release; the primary license is not a GPL exception.
+4. **Review the actual tarball.** Run `npm pack --dry-run`, build the tarball, inspect its complete file list and install that exact artifact in an isolated consumer. The source ZIP packager is a separate format, not proof of an npm package. Reopen the bundled guides/gallery without GitHub access; verify license files, image paths and required runtime dependencies. Confirm the tarball ships no `preinstall`/`install`/`postinstall` scripts; lifecycle scripts are not used and would expand the install attack surface.
+5. **Authorize and perform the first publication separately.** Use explicit `--access public`, reviewed bytes, the publishing account's required authentication/2FA. Do not publish merely to preview the README. For CI, review current [trusted-publishing support](https://docs.npmjs.com/trusted-publishers/) for the selected registry/account and workflow; never commit credentials or assume an OIDC flow has been configured. Provenance attestation of npm releases from a public repository is enabled by `npm publish --provenance` after an OIDC publisher is configured; leave it off rather than claim an attestation that has not been issued.
+6. **Test the actual consumer install path.** The img2 0.4.0 harness `add npm:@img2threejs/img2interior@<exact-version> --yes` flow is **broken against npm 10/11** — it expects a nested `info.dist.integrity` from `npm view`, but npm 10/11 return a flat `dist.integrity`, so `add` refuses the package. The img2 harness bug is not in this package. Until the harness ships a fix, verify consumer install via the two-step flow:
+
+ ```sh
+ npm install --prefix "$HOME/.local/share/img2interior" @img2threejs/img2interior@<exact-version>
+ npx --yes @img2threejs/[email protected] add --link "$HOME/.local/share/img2interior/node_modules/@img2threejs/img2interior" --yes
+ npx --yes @img2threejs/[email protected] doctor --json
+ npx --yes @img2threejs/[email protected] sync --check
+ npx --yes @img2threejs/[email protected] capabilities --from-kind image --to-kind interior-scene-candidate --plugin interior --json
+ ```
+
+ Confirm a consumer without an authenticated npm session can complete install → link → doctor → sync → capabilities and removal. Do not weaken access or use `--force` to conceal the img2 transport failure. Record the failure mode in the release notes; do not assert `add npm:` works.
+7. **Keep versions immutable.** Record the published version and `dist.integrity` for each release; do not republish the same version with different bytes. `npm install --prefix "$HOME/.local/share/img2interior" @img2threejs/img2interior@<version>` updates the live link in place; the host link points at the installed prefix, so the consumer's next launch sees the new bytes. `npm install` alone is not host skill registration; `add --link` is. A package release does not register an img2 catalog entry; the harness `add --link` flow against the installed prefix is sufficient on its own. The README's install block and the badge URLs reflect the published `@img2threejs/[email protected]` exactly; any new release updates the version specifier in lockstep with the tarball.
### README and showcase delivery
-npm renders a root README using [GitHub Flavored Markdown](https://docs.npmjs.com/about-package-readme-files/). A GitHub README change does not update a published npm version until a new package release. Relative private-GitHub image URLs do not grant npm readers GitHub access.
-
-The landing page therefore embeds **public HTTPS previews pinned to an immutable commit** in the separately authorized [media repository](https://github.com/img2threejs/img2interior-media). Only optimized previews and captions are public, never implementation, GLBs, textures, full-resolution inputs or private reports. The same image bytes are included in `docs/showcase/` for local viewing; see the [gallery](../docs/showcase/README.md). Test image delivery without GitHub/npm credentials and keep alt text/captions accurate. No signed expiring image URLs, unpublished package URLs, CI badges implying public access, or unverified live-demo links.
+npm renders a root README using [GitHub Flavored Markdown](https://docs.npmjs.com/about-package-readme-files/). A GitHub README change does not update a published npm version until a new package release. Image bytes are pinned to an immutable commit in the separately hosted [media repository](https://github.com/img2threejs/img2interior-media) — those raw-image URLs are public, but they reference media, not source. The same image bytes are included in `docs/showcase/` for local viewing; see the [gallery](../docs/showcase/README.md). The live demo link in the README points at [img2threejs.io/living-room/](https://img2threejs.io/living-room/), an actual hosted Three.js viewer of the same authored scene. Test image delivery without GitHub/npm credentials and keep alt text/captions accurate. No signed expiring image URLs, unpublished package URLs, CI badges implying public access, or unverified live-demo links.
-Detailed guides ship with the private payload. Their source links may require GitHub access; npm-only consumers should ask their agent to open the installed guides. Public media access grants neither plugin permission nor access to unpublished scene assets. Updating previews is separate from changing source-repository visibility.
+Detailed guides ship with the public package and source. Both channels expose the same source, so a reference link in a guide works from either install method (the `npm install --prefix` flow or the Git clone flow). Public media access grants neither plugin permission nor access to any user's project assets. Updating previews is independent of releasing a new package.
## Maintainer checks
@@ -86,4 +120,4 @@ Native regressions need the separate authoring environment: set `IMG2_BLENDER_PY
`verify_install.py` runs the official CLI with temporary HOME/IMG2_HOME and three isolated host configurations; it does not alter real host settings or launchers. It checks install/add, identity, links, doctor, sync, capability resolution and removal. The source packager writes a deterministic versioned ZIP and `SHA256SUMS` under `dist/`, including `LICENSE`, `THIRD_PARTY_NOTICES.md`, the retained Apache-2.0 license and the small documentation gallery, not generated scene assets. Neither command publishes anything.
-Official references: [private packages](https://docs.npmjs.com/creating-and-publishing-private-packages/), [package metadata](https://docs.npmjs.com/cli/v11/configuring-npm/package-json/), [npm provenance](https://docs.npmjs.com/generating-provenance-statements/) and the [img2 harness](https://github.com/img2threejs/img2).
+Official references: [publishing packages](https://docs.npmjs.com/creating-and-publishing-packages/), [package metadata](https://docs.npmjs.com/cli/v11/configuring-npm/package-json/), [npm provenance](https://docs.npmjs.com/generating-provenance-statements/) and the [img2 harness](https://github.com/img2threejs/img2).
diff --git a/reference/oak-linen-recipe.md b/reference/oak-linen-recipe.md
index 2f99728..196443c 100644
--- a/reference/oak-linen-recipe.md
+++ b/reference/oak-linen-recipe.md
@@ -44,4 +44,4 @@ Downloaded asset bytes may change upstream; current verified acquisition receipt
Camera, metre scale, hidden surfaces, reflectance, dyes and scan footprints remain authored estimates. The source-specific artwork crop is an explicitly labeled artwork texture, not permission to turn furniture/room structure into photo cards. Native thin-pane shadows and runtime two-interface sun transmission are approximations; open-curtain GI/probe and portable appearance remain static.
-Historical showcase evidence is summarized in [lessons](showcase-lessons.md); current release smoke evidence is in [VERIFICATION.md](../VERIFICATION.md). Do not report a small low-sample mechanism smoke as a fresh full-quality photorealism or real-phone acceptance run.
+Historical showcase evidence is summarized in [lessons](showcase-lessons.md). Keep current smoke evidence with the authored project's delivery. Do not report a small low-sample mechanism smoke as a fresh full-quality photorealism or real-phone acceptance run.
diff --git a/scripts/package_plugin.py b/scripts/package_plugin.py
index 1b08f62..5fea51a 100755
--- a/scripts/package_plugin.py
+++ b/scripts/package_plugin.py
@@ -10,8 +10,9 @@ import zipfile
ROOT_FILES = (
"plugin.json", "steps.json", "gates.json", "SKILL.md", "README.md", "LICENSE",
- "THIRD_PARTY_NOTICES.md", "licenses/Apache-2.0.txt", "SECURITY.md", "CHANGELOG.md", "VERIFICATION.md",
+ "THIRD_PARTY_NOTICES.md", "licenses/Apache-2.0.txt", "SECURITY.md", "CHANGELOG.md",
"requirements.txt", "requirements-authoring.txt", "requirements-surfaces.txt", ".gitignore",
+ "package.json", ".npmignore",
"docs/showcase/README.md", "docs/showcase/living-room-comparison.webp", "docs/showcase/living-room-viewer.webp",
)
TREES = ("tools", "authoring", "resources_lib", "runtime", "recipes", "reference", "examples", "tests", "scripts", ".github")