@forgeax/engine-fbx 0.0.0-dev.8d955ade1c79

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,188 @@
+# @forgeax/engine-fbx
+
+FBX importer for the forgeax engine. A single **ufbx**-based parser compiled to
+WebAssembly via Emscripten -- works in both the browser and Node.js, no
+Autodesk FBX SDK, no native addon. Emits the engine FBX POD JSON schema
+(meshes, nodes, materials, skeletons, skins, clips), consumed by the shared
+`parse-*.ts` / `to-asset-pack.ts` bridge layer.
+
+## Evidence and recovery
+
+The FBX producer writes source meta and a producer-owned `CookReceipt`; the catalog only supplies the GUID locator (`packageUrl` and optional `cookReceiptUrl`). `AssetEvidence` joins those records with Pack v2 package and artifact verification so browser/runtime code does not guess whether a cook completed.
+
+Read `notCooked`, `ready/current`, `ready/stale`, or `unknown` literally. Package and artifact evidence must remain `notChecked`, `passed`, or `failed`. If the probe reports `stale` or `failed`, repair the source/import settings or recook and rerun `lookup/verify --guid --project --catalog --json`; retain the structured error hint for the next action.
+
+```
+FBX bytes -> ufbx (wasm) -> JSON POD -> parse-*.ts -> meta.json
+```
+
+## AI user consumption path
+
+The importer key `'fbx'` is unchanged from the SDK era -- zero migration for
+existing `.fbx.meta.json` sidecars. The engine resolves the importer
+automatically via `loadByGuid`:
+
+```ts
+// 1) Point the asset registry at the pack index
+assets.configurePackIndex('/pack-index.json');
+
+// 2) loadByGuid dispatches on meta.importer: 'fbx' automatically
+const res = await assets.loadByGuid<SceneAsset>(guid);
+if (!res.ok) {
+  console.error(res.error.code, res.error.hint);
+  return;
+}
+const scene = res.value; // SceneAsset -- ready for instantiate()
+```
+
+Under the hood, `vite-plugin-pack` calls `fbxImporter.import(ctx)` which
+initializes the ufbx WASM module on first use, parses the FBX bytes, and
+returns `ImportedAsset[]` (mesh, material, scene, skeleton, skin,
+animation-clip, texture). The importer registration is a one-liner if you
+need it explicitly:
+
+```ts
+import { fbxImporter } from '@forgeax/engine-fbx';
+import { ImporterRegistry } from '@forgeax/engine-import';
+const importers = new ImporterRegistry();
+importers.register(fbxImporter);
+```
+
+## 7 sub-asset POD types
+
+The FBX importer produces 7 sub-asset kinds. Types are defined in
+`@forgeax/engine-types` (SSOT) -- see the `Asset` union and the per-kind POD
+interfaces. This section is a discovery index; do not copy-paste member lists
+from here.
+
+| POD type | Description | Source anchor |
+|:--|:--|:--|
+| `MeshPod` | Vertices, indices, attributes, submeshes | `@forgeax/engine-types` `MeshPod` |
+| `MaterialPod` | PBR parameters (StingrayPBS / Phong / Lambert / fallback) | `@forgeax/engine-types` `MaterialPod` |
+| `ScenePod` | Entity hierarchy + mounts | `@forgeax/engine-types` `ScenePod` |
+| `TexturePod` | External file path | `@forgeax/engine-types` `TexturePod` |
+| `SkeletonPod` | Joint count + inverse bind matrices | `@forgeax/engine-types` `SkeletonPod` |
+| `SkinPod` | Skeleton GUID + joint paths | `@forgeax/engine-types` `SkinPod` |
+| `AnimationClipPod` | Duration + channels + samplers | `@forgeax/engine-types` `AnimationClipPod` |
+
+## Material mapping
+
+Three branches, one output (`passes[0].shader` = `'forgeax::default-standard-pbr'`).
+Priority: StingrayPBS > Phong > Lambert > fallback.
+
+| Branch | Detection | Mapping |
+|:--|:--|:--|
+| **StingrayPBS** | `kind === 'stingray-pbs'` in the bridge JSON POD | Channels copied directly: `baseColor`, `metallic`, `roughness`, `normal`, `occlusion` |
+| **Phong** | `kind === 'phong'` | `baseColor = diffuse`, `metallic = 0`, `roughness = 1 - sqrt(shininess / 100)` (Family A) |
+| **Lambert** | `kind === 'lambert'` | `baseColor = diffuse`, `metallic = 0`, `roughness = 0.5` (no specular) |
+| **Fallback** | No recognized material type | `baseColor = [0.5, 0.5, 0.5]` (grey), `metallic = 0`, `roughness = 0.5` |
+
+The Phong-to-PBR roughness formula is **Family A**: `roughness = 1 - sqrt(shininess / maxGloss)`
+with `maxGloss = 100`. Implementation SSOT: `src/parse-material.ts` lines
+32-35 (`phongRoughness` function). Industry survey (5 engines/tools) and
+formula rationale: KB `2026-06-15-fbx-phong-roughness-conversion.md` (Family A
+vs Family B comparison, max_gloss convention).
+
+## Error codes
+
+Errors are structured: every error object carries `.code`, `.expected`,
+`.hint`, and `.detail`. AI users switch on `.code` for exhaustive handling.
+
+**FbxErrorCode** (this package, closed union): source SSOT is `src/errors.ts`.
+Do not copy-paste the member list; inspect the source for the current union.
+
+**ImportErrorCode** (in `@forgeax/engine-types`): source SSOT is
+`packages/types/src/index.ts`; it owns the runtime importer-dispatch union.
+
+## Contributor toolchain
+
+<details>
+<summary>Getting pre-built WASM (fetch-wasm)</summary>
+
+The `pkg/` directory is **not committed to git** (zero-binary invariant). A
+workspace `pnpm install` or `bun install` runs a package-local, best-effort
+postinstall hook that fetches the matching bundle when it is absent. The hook
+is idempotent and non-fatal: it skips a complete `pkg/`, and an unavailable
+release leaves installation successful with the explicit recovery command
+below. Set `FORGEAX_SKIP_FBX_WASM_FETCH=1` to opt out.
+
+To provision a fresh checkout explicitly, fetch the pre-built WASM bundle from
+GitHub Releases instead of compiling locally:
+
+```bash
+pnpm -F @forgeax/engine-fbx fetch-wasm
+```
+
+This runs `scripts/fetch-wasm.mjs`, which:
+1. Resolves the GitHub repo from `git remote get-url origin` (SSH or HTTPS).
+2. Computes the **content key** = `SHA256(bridge.c + fetch-ufbx.mjs +
+   build-wasm.mjs)` truncated to 8 hex chars (SSOT: `scripts/content-key.mjs`).
+3. Looks for a matching asset `fbx-wasm-v0.23.0-{sha8}.tar.gz` under the
+   `wasm-artifacts` release tag.
+4. Downloads and extracts it into `pkg/`. emcc emits a **pair** —
+   `pkg/fbx-wasm.wasm` + its self-loading `pkg/fbx-wasm.mjs` glue — and the
+   runtime imports the `.mjs` glue, so the release ships the whole `pkg/` as one
+   tarball (mirrors `@forgeax/engine-wgpu-wasm` and `@forgeax/engine-codec`), not
+   a lone `.wasm`.
+
+The content key guarantees you get the bundle that matches your exact source --
+no accidental mismatch. The shared downloader tries Node `fetch` first; when it
+cannot complete the TLS/network handshake, it falls back to authenticated
+`gh api`/`gh release download`, then `curl` (`curl.exe` on Windows). All paths
+remain pinned to this repository, the `wasm-artifacts` tag, and the exact
+content-keyed asset name.
+
+If the asset is not found (e.g. modified `bridge.c` that was never published),
+the script prints a structured error with a hint to compile locally. If the
+repo is private, set `GITHUB_TOKEN`/`GH_TOKEN` or run `gh auth login`; public
+repos work anonymously (no token needed).
+
+</details>
+
+<details>
+<summary>Compiling from source (emcc fallback)</summary>
+
+When no pre-built release is available, compile locally with Emscripten:
+
+```bash
+# Prerequisite: install emsdk and activate it
+# https://emscripten.org/docs/getting_started/downloads.html
+
+pnpm -F @forgeax/engine-fbx build:wasm
+```
+
+`build:wasm` runs two scripts in order:
+1. `scripts/fetch-ufbx.mjs` -- downloads `ufbx.c` + `ufbx.h` (v0.23.0) from
+   the official ufbx repo. Idempotent: skips if already present.
+2. `scripts/build-wasm.mjs` -- invokes `emcc` to compile `ufbx.c` + `bridge.c`
+   into `pkg/fbx-wasm.mjs` + `pkg/fbx-wasm.wasm`.
+
+Both `ufbx.c`/`.h` and `pkg/` are in `.gitignore`; CI provides emsdk via
+`emscripten-core/setup-emsdk` and rebuilds from a bare checkout on every run.
+
+</details>
+
+### Fetch-wasm error codes
+
+| Code | Meaning | Self-help |
+|:--|:--|:--|
+| `E1_NETWORK` | Node fetch and available native transports failed, or an unexpected HTTP error occurred | Check the TLS/proxy diagnosis and retry with `gh auth login`, then use `pnpm -F @forgeax/engine-fbx build:wasm` (local emcc) |
+| `E2_ASSET_NOT_FOUND` | Release tag or asset not found | `pnpm -F @forgeax/engine-fbx build:wasm`, or push to main to trigger CI release |
+| `E3_ORIGIN_UNSUPPORTED_HOST` | `git remote get-url origin` returned a non-GitHub host | Check `git remote -v`; set origin to a GitHub remote |
+| `E3_ORIGIN_PARSE_FAILED` | Cannot parse the origin URL into owner/repo | Expected `git@github.com:OWNER/REPO.git` or `https://github.com/OWNER/REPO.git` |
+| `E3_NO_ORIGIN` | No `origin` remote configured | `git remote add origin <url>` or `build:wasm` |
+| `E4_HASH_MISMATCH` | content key does not match any published asset | `pnpm -F @forgeax/engine-fbx build:wasm` |
+| `E5_AUTH_FAILED` | Private repo requires authentication (401/403) | Set `GITHUB_TOKEN` environment variable, or `build:wasm` |
+
+### Content-keyed idempotency
+
+The CI `main-push` release step packs `pkg/` into `fbx-wasm-v0.23.0-{sha8}.tar.gz`
+and publishes it under the `wasm-artifacts` release tag. The publish step checks
+for an existing asset with the same name before uploading -- identical source
+content never produces a duplicate release. The hash is computed from the source
+at build time via `scripts/content-key.mjs` (Derive, Don't Duplicate -- no stored
+hash file).
+
+## License
+
+MIT