@iwsdk/create 1.2.0-rc.0 → 1.2.0-rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (87) hide show
  1. package/README.md +22 -6
  2. package/dist/cli.js +591 -99
  3. package/dist/guidance/files/.agents/skills/iwsdk-build-model/SKILL.md +1 -1
  4. package/dist/guidance/files/.agents/skills/iwsdk-compose-scene/SKILL.md +1 -1
  5. package/dist/guidance/files/.agents/skills/iwsdk-debug/SKILL.md +1 -1
  6. package/dist/guidance/files/.agents/skills/iwsdk-depth-occlusion/SKILL.md +1 -1
  7. package/dist/guidance/files/.agents/skills/iwsdk-dev/SKILL.md +20 -1
  8. package/dist/guidance/files/.agents/skills/iwsdk-dev/references/api-reference.md +2 -1
  9. package/dist/guidance/files/.agents/skills/iwsdk-dev/references/headless-rendering.md +15 -1
  10. package/dist/guidance/files/.agents/skills/iwsdk-dev/references/iterate.md +7 -3
  11. package/dist/guidance/files/.agents/skills/iwsdk-glasses-test/SKILL.md +1 -1
  12. package/dist/guidance/files/.agents/skills/iwsdk-grab/SKILL.md +1 -1
  13. package/dist/guidance/files/.agents/skills/iwsdk-hosting/SKILL.md +3 -2
  14. package/dist/guidance/files/.agents/skills/iwsdk-metavr-native/SKILL.md +216 -0
  15. package/dist/guidance/files/.agents/skills/iwsdk-metavr-native/assets/iwn-host.mjs +71 -0
  16. package/dist/guidance/files/.agents/skills/iwsdk-native-xr-test/SKILL.md +1 -1
  17. package/dist/guidance/files/.agents/skills/iwsdk-offline/SKILL.md +217 -0
  18. package/dist/guidance/files/.agents/skills/iwsdk-offline/assets/offline.ts.template +99 -0
  19. package/dist/guidance/files/.agents/skills/iwsdk-offline/assets/sw.js.template +241 -0
  20. package/dist/guidance/files/.agents/skills/iwsdk-offline/assets/write-service-worker.mjs.template +72 -0
  21. package/dist/guidance/files/.agents/skills/iwsdk-offline/references/build-step.md +71 -0
  22. package/dist/guidance/files/.agents/skills/iwsdk-offline/references/page.md +70 -0
  23. package/dist/guidance/files/.agents/skills/iwsdk-offline/references/service-worker.md +107 -0
  24. package/dist/guidance/files/.agents/skills/iwsdk-offline/references/testing.md +57 -0
  25. package/dist/guidance/files/.agents/skills/iwsdk-physics/SKILL.md +1 -1
  26. package/dist/guidance/files/.agents/skills/iwsdk-physics/references/tuning-and-config.md +1 -0
  27. package/dist/guidance/files/.agents/skills/iwsdk-physics/references/workflows.md +9 -3
  28. package/dist/guidance/files/.agents/skills/iwsdk-pwa-packaging/SKILL.md +18 -3
  29. package/dist/guidance/files/.agents/skills/iwsdk-pwa-packaging/references/manifest-and-icons.md +1 -1
  30. package/dist/guidance/files/.agents/skills/iwsdk-pwa-packaging/references/troubleshooting.md +30 -0
  31. package/dist/guidance/files/.agents/skills/iwsdk-ray/SKILL.md +1 -1
  32. package/dist/guidance/files/.agents/skills/iwsdk-ui/SKILL.md +12 -5
  33. package/dist/guidance/files/.agents/skills/iwsdk-upgrade/SKILL.md +1 -1
  34. package/dist/guidance/files/.claude/agents/iwsdk-project-code-reviewer.md +1 -1
  35. package/dist/guidance/files/.claude/rules/assets-and-manifest.md +1 -1
  36. package/dist/guidance/files/.claude/rules/ecs-api.md +1 -1
  37. package/dist/guidance/files/.claude/rules/scene-json.md +1 -1
  38. package/dist/guidance/files/.claude/rules/uikitml.md +1 -1
  39. package/dist/guidance/files/.claude/settings.json +2 -0
  40. package/dist/guidance/files/.claude/skills/iwsdk-build-model/SKILL.md +1 -1
  41. package/dist/guidance/files/.claude/skills/iwsdk-compose-scene/SKILL.md +1 -1
  42. package/dist/guidance/files/.claude/skills/iwsdk-debug/SKILL.md +1 -1
  43. package/dist/guidance/files/.claude/skills/iwsdk-depth-occlusion/SKILL.md +1 -1
  44. package/dist/guidance/files/.claude/skills/iwsdk-dev/SKILL.md +20 -1
  45. package/dist/guidance/files/.claude/skills/iwsdk-dev/references/api-reference.md +2 -1
  46. package/dist/guidance/files/.claude/skills/iwsdk-dev/references/headless-rendering.md +15 -1
  47. package/dist/guidance/files/.claude/skills/iwsdk-dev/references/iterate.md +7 -3
  48. package/dist/guidance/files/.claude/skills/iwsdk-glasses-test/SKILL.md +1 -1
  49. package/dist/guidance/files/.claude/skills/iwsdk-grab/SKILL.md +1 -1
  50. package/dist/guidance/files/.claude/skills/iwsdk-hosting/SKILL.md +3 -2
  51. package/dist/guidance/files/.claude/skills/iwsdk-metavr-native/SKILL.md +216 -0
  52. package/dist/guidance/files/.claude/skills/iwsdk-metavr-native/assets/iwn-host.mjs +71 -0
  53. package/dist/guidance/files/.claude/skills/iwsdk-native-xr-test/SKILL.md +1 -1
  54. package/dist/guidance/files/.claude/skills/iwsdk-offline/SKILL.md +217 -0
  55. package/dist/guidance/files/.claude/skills/iwsdk-offline/assets/offline.ts.template +99 -0
  56. package/dist/guidance/files/.claude/skills/iwsdk-offline/assets/sw.js.template +241 -0
  57. package/dist/guidance/files/.claude/skills/iwsdk-offline/assets/write-service-worker.mjs.template +72 -0
  58. package/dist/guidance/files/.claude/skills/iwsdk-offline/references/build-step.md +71 -0
  59. package/dist/guidance/files/.claude/skills/iwsdk-offline/references/page.md +70 -0
  60. package/dist/guidance/files/.claude/skills/iwsdk-offline/references/service-worker.md +107 -0
  61. package/dist/guidance/files/.claude/skills/iwsdk-offline/references/testing.md +57 -0
  62. package/dist/guidance/files/.claude/skills/iwsdk-physics/SKILL.md +1 -1
  63. package/dist/guidance/files/.claude/skills/iwsdk-physics/references/tuning-and-config.md +1 -0
  64. package/dist/guidance/files/.claude/skills/iwsdk-physics/references/workflows.md +9 -3
  65. package/dist/guidance/files/.claude/skills/iwsdk-pwa-packaging/SKILL.md +18 -3
  66. package/dist/guidance/files/.claude/skills/iwsdk-pwa-packaging/references/manifest-and-icons.md +1 -1
  67. package/dist/guidance/files/.claude/skills/iwsdk-pwa-packaging/references/troubleshooting.md +30 -0
  68. package/dist/guidance/files/.claude/skills/iwsdk-ray/SKILL.md +1 -1
  69. package/dist/guidance/files/.claude/skills/iwsdk-ui/SKILL.md +12 -5
  70. package/dist/guidance/files/.claude/skills/iwsdk-upgrade/SKILL.md +1 -1
  71. package/dist/guidance/files/.cursor/rules/assets-and-manifest.mdc +1 -1
  72. package/dist/guidance/files/.cursor/rules/ecs-api.mdc +1 -1
  73. package/dist/guidance/files/.cursor/rules/scene-json.mdc +1 -1
  74. package/dist/guidance/files/.cursor/rules/uikitml.mdc +1 -1
  75. package/dist/guidance/files/.github/instructions/assets-and-manifest.instructions.md +1 -1
  76. package/dist/guidance/files/.github/instructions/ecs-api.instructions.md +1 -1
  77. package/dist/guidance/files/.github/instructions/scene-json.instructions.md +1 -1
  78. package/dist/guidance/files/.github/instructions/uikitml.instructions.md +1 -1
  79. package/dist/guidance/files/AGENTS.md +10 -1
  80. package/dist/guidance/files/public/scenes/AGENTS.md +1 -1
  81. package/dist/guidance/files/public/ui/AGENTS.md +1 -1
  82. package/dist/guidance/files/src/AGENTS.md +1 -1
  83. package/dist/guidance/manifest.json +142 -12
  84. package/dist/template/scenes/ar.iwsdk.scene.json +1 -0
  85. package/dist/template/scenes/immersive.iwsdk.scene.json +1 -0
  86. package/package.json +4 -4
  87. package/scripts/verify-release-ready.mjs +2 -2
package/README.md CHANGED
@@ -30,17 +30,30 @@ IWSDK to that project and never overwrites an existing file, even with
30
30
  empty asset and component manifests, and type references), so it never shadows
31
31
  the project's modules. `iwsdk.config.json` and an empty scene are added where
32
32
  missing, and `index.html`, a Vite config and `tsconfig.json` only when the
33
- project has none. The starter demo is not added;
33
+ project has none. A new Vite config is `vite.config.mts` (`.mjs` in
34
+ JavaScript) unless `package.json` sets `"type": "module"`, because the IWSDK
35
+ plugin is ESM-only. The starter demo is not added;
36
+ - locomotion stays off unless asked for (`--locomotion`, or Yes in the
37
+ customize prompt, which starts at No here), because the empty scene has no
38
+ floor to stand on; the report says so. When it is on, give your floor a
39
+ `LocomotionEnvironment` component, or the player falls through the world. In
40
+ a project whose `iwsdk.config.json` already turns locomotion on, that step is
41
+ listed while its scene has no `LocomotionEnvironment`;
34
42
  - `package.json` is merged in its own indentation: IWSDK packages, the `three`
35
43
  alias and `@types/three` are set, versions are only raised, and specs that are
36
- not registry versions (`workspace:`, `file:`, `catalog:`) are left alone and
37
- reported. Other dependencies and your scripts are kept; `iwsdk:dev` is added
38
- when `dev` is taken;
44
+ not version ranges (`workspace:`, `file:`, `catalog:`, or a dist-tag such as
45
+ `latest`) are left alone and reported. Other dependencies and your scripts are
46
+ kept; `iwsdk:dev` is added when `dev` is taken;
39
47
  - overrides go where the package manager reads them: `overrides` (npm, bun),
40
48
  `resolutions` (yarn), or `pnpm-workspace.yaml` (pnpm), merged without touching
41
49
  its other settings;
42
50
  - `iwsdkDev()` is added to an existing Vite config when the config's own
43
- top-level `plugins` array is unambiguous, and listed as a step otherwise;
51
+ top-level `plugins` array is unambiguous, Vite loads it as an ES module, and
52
+ it is the project's only Vite config; otherwise it is listed as a step that
53
+ names the config Vite loads (in Vite's order: `.js`, `.mjs`, `.ts`, `.cjs`,
54
+ `.mts`, `.cts`). A config that Vite loads as CommonJS cannot import the
55
+ plugin, so renaming it to `.mjs`/`.mts` is listed too, also when it already
56
+ imports the plugin;
44
57
  - `.gitignore` gains IWSDK's runtime and MCP entries, dependencies install with
45
58
  the package manager found from the nearest lockfile (a monorepo's included),
46
59
  and no Git repository is created;
@@ -88,7 +101,9 @@ dependencies. They also apply a small target-specific baseline:
88
101
  Choose **Customize setup...** to select JavaScript, change applicable SDK
89
102
  features, or opt out of Git initialization and dependency installation. The CLI
90
103
  derives low-level WebXR feature settings from those choices instead of asking
91
- for raw `No` / `Optional` / `Required` states.
104
+ for raw `No` / `Optional` / `Required` states. In an existing project, the
105
+ recommended settings leave locomotion off and the customize prompt starts it at
106
+ No (see above).
92
107
 
93
108
  Every project includes guidance and configuration for Claude Code, Codex,
94
109
  Cursor, GitHub Copilot/VS Code, and OpenCode. Delete integrations you do not use;
@@ -167,6 +182,7 @@ the interactive setup controls language, features, Git, and installation.
167
182
  | `--git` / `--no-git` | Initialize or skip a Git repository |
168
183
  | `--canary` | Use the default canary SDK bundle |
169
184
  | `--canary URL` | Use a custom HTTP(S) SDK bundle |
185
+ | `--metavr-native` | Alpha, VR or AR: add `npm run build:metavr`, a native Quest APK built with `@iwer/native` |
170
186
 
171
187
  Automation and coding agents should map the requested experience to a target
172
188
  and high-level feature flags before invoking Create, then pass those choices