create-aura3d 1.4.1 → 1.4.3
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.
- package/README.md +42 -55
- package/dist/index.js +1 -1
- package/package.json +3 -3
- package/templates/animation-channel/package.json +1 -1
- package/templates/animation-studio/package.json +5 -5
- package/templates/character-controller/package.json +3 -3
- package/templates/cinematic-scene/package.json +1 -1
- package/templates/episode-builder/package.json +1 -1
- package/templates/falling-blocks-starter/package.json +1 -1
- package/templates/fighting-game/package.json +1 -1
- package/templates/mini-game/package.json +1 -1
- package/templates/product-viewer/package.json +1 -1
- package/templates/prompt-animation-channel/package.json +1 -1
- package/templates/racing-starter/package.json +1 -1
- package/templates/three-compat-architecture-interior/package.json +1 -1
- package/templates/three-compat-asset-inspector/package.json +1 -1
- package/templates/three-compat-character-viewer/package.json +1 -1
- package/templates/three-compat-custom-threejs-migration/package.json +1 -1
- package/templates/three-compat-large-scene/package.json +1 -1
- package/templates/three-compat-material-authoring/package.json +1 -1
- package/templates/three-compat-postprocess-scene/package.json +1 -1
- package/templates/three-compat-premium-product-viewer/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,113 +1,100 @@
|
|
|
1
1
|
# create-aura3d
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
Start a real Aura3D browser app in one command.
|
|
4
|
+
|
|
5
|
+
`create-aura3d` gives you a Vite project with editable TypeScript, typed
|
|
6
|
+
GLB/glTF assets, route-health tests, screenshot checks, and deploy-ready
|
|
7
|
+
structure. It is built for developers and coding agents that need to move from
|
|
8
|
+
prompt to working 3D app without hand-assembling renderer boilerplate.
|
|
5
9
|
|
|
6
10
|
```bash
|
|
7
|
-
npx create-aura3d@latest my-
|
|
8
|
-
cd my-
|
|
11
|
+
npx create-aura3d@latest my-product --template product-viewer
|
|
12
|
+
cd my-product
|
|
9
13
|
npm run dev
|
|
10
14
|
```
|
|
11
15
|
|
|
12
|
-
##
|
|
13
|
-
|
|
14
|
-
`create-aura3d` copies a complete starter project that uses public
|
|
15
|
-
`@aura3d/engine` imports, generated typed assets from `src/aura-assets.ts`,
|
|
16
|
-
browser route-health tests, and template-local project files. Most public
|
|
17
|
-
starter templates also include a route README or template notes when the
|
|
18
|
-
template needs extra operating guidance.
|
|
19
|
-
|
|
20
|
-
Use it for:
|
|
21
|
-
|
|
22
|
-
- GLB/glTF product viewers and product configurators;
|
|
23
|
-
- cinematic browser 3D scenes;
|
|
24
|
-
- browser-native game prototype routes with input, HUD state, tests, and reset;
|
|
25
|
-
- prompt-animation and episode-builder scaffolds;
|
|
26
|
-
- animation-studio projects for scene, cast, shot, and render-package workflows.
|
|
27
|
-
|
|
28
|
-
Aura3D starter templates are source projects. You keep normal TypeScript,
|
|
29
|
-
Vite, Playwright tests, and asset manifests after generation.
|
|
30
|
-
|
|
31
|
-
## Templates
|
|
16
|
+
## Pick A Starting Point
|
|
32
17
|
|
|
33
18
|
```bash
|
|
34
19
|
npx create-aura3d@latest my-product --template product-viewer
|
|
35
20
|
npx create-aura3d@latest my-scene --template cinematic-scene
|
|
36
21
|
npx create-aura3d@latest my-game --template mini-game
|
|
37
|
-
npx create-aura3d@latest my-racer --template racing-starter
|
|
38
|
-
npx create-aura3d@latest my-blocks --template falling-blocks-starter
|
|
39
22
|
npx create-aura3d@latest my-fighter --template fighting-game
|
|
40
|
-
npx create-aura3d@latest my-channel --template animation-channel
|
|
41
23
|
npx create-aura3d@latest my-episode --template prompt-animation-channel
|
|
42
24
|
npx create-aura3d@latest my-studio --template animation-studio
|
|
43
|
-
npx create-aura3d@latest my-builder --template episode-builder
|
|
44
25
|
npx create-aura3d@latest my-character --template character-controller
|
|
26
|
+
npx create-aura3d@latest my-migration --template three-compat-custom-threejs-migration
|
|
45
27
|
```
|
|
46
28
|
|
|
47
|
-
|
|
48
|
-
compatibility work:
|
|
29
|
+
Run the full list at any time:
|
|
49
30
|
|
|
50
31
|
```bash
|
|
51
|
-
npx create-aura3d@latest
|
|
32
|
+
npx create-aura3d@latest --help
|
|
52
33
|
```
|
|
53
34
|
|
|
54
|
-
|
|
55
|
-
your installed version.
|
|
35
|
+
## Why Use It
|
|
56
36
|
|
|
57
|
-
|
|
37
|
+
- **You get an app, not a blank canvas.** Templates ship with Vite, source,
|
|
38
|
+
scripts, test files, and Aura3D imports wired up.
|
|
39
|
+
- **Assets stay typed.** Generated projects use `src/aura-assets.ts` so scene
|
|
40
|
+
code renders `model(assets.product)` instead of guessed URLs or string IDs.
|
|
41
|
+
- **AI output stays maintainable.** Coding agents can generate scenes while
|
|
42
|
+
developers keep normal TypeScript, package scripts, and browser tests.
|
|
43
|
+
- **Proof is part of the starter.** Route-health, screenshot, gameplay, or
|
|
44
|
+
template checks are included where the template needs them.
|
|
45
|
+
- **Static deploys are first-class.** Build output is a browser app you can
|
|
46
|
+
deploy like any Vite project.
|
|
58
47
|
|
|
59
|
-
|
|
60
|
-
model IDs.
|
|
48
|
+
## Add A Real Model
|
|
61
49
|
|
|
62
|
-
Add a local
|
|
50
|
+
Add a local GLB/glTF asset:
|
|
63
51
|
|
|
64
52
|
```bash
|
|
65
|
-
npx @aura3d/cli@latest assets add ./assets/
|
|
53
|
+
npx @aura3d/cli@latest assets add ./assets/sneaker.glb --name sneaker
|
|
66
54
|
```
|
|
67
55
|
|
|
68
|
-
Or resolve a catalog
|
|
56
|
+
Or resolve a catalog candidate:
|
|
69
57
|
|
|
70
58
|
```bash
|
|
71
59
|
npx @aura3d/cli@latest assets search "battle-worn knight helmet"
|
|
72
60
|
npx @aura3d/cli@latest assets resolve "battle-worn knight helmet" --name helmet
|
|
73
61
|
```
|
|
74
62
|
|
|
75
|
-
Then
|
|
63
|
+
Then render the generated typed reference:
|
|
76
64
|
|
|
77
65
|
```ts
|
|
78
66
|
import { createAuraApp, lights, model, scene } from "@aura3d/engine";
|
|
79
67
|
import { assets } from "./aura-assets";
|
|
80
68
|
|
|
81
69
|
createAuraApp("#app", {
|
|
82
|
-
scene: scene().add(model(assets.
|
|
70
|
+
scene: scene().add(model(assets.sneaker)).add(lights.studio())
|
|
83
71
|
});
|
|
84
72
|
```
|
|
85
73
|
|
|
86
|
-
##
|
|
74
|
+
## What It Creates
|
|
87
75
|
|
|
88
76
|
Most templates include:
|
|
89
77
|
|
|
90
78
|
- `npm run dev` for local Vite development;
|
|
91
79
|
- `npm run build` for static output;
|
|
92
80
|
- `npm run test` for route-health, screenshot, or gameplay checks;
|
|
93
|
-
- `
|
|
94
|
-
-
|
|
95
|
-
|
|
96
|
-
## Public Claim Boundary
|
|
81
|
+
- `src/main.ts` with public `@aura3d/engine` imports;
|
|
82
|
+
- `src/aura-assets.ts` for generated typed asset references;
|
|
83
|
+
- template-local test and project files you can keep editing.
|
|
97
84
|
|
|
98
|
-
|
|
99
|
-
production renderer parity, native WebGPU rendering, full PBR material parity,
|
|
100
|
-
postprocess, skinned animation, morph targets, or production-quality game kits.
|
|
101
|
-
Only claim those capabilities when the generated route has matching browser
|
|
102
|
-
evidence for the exact API path being used.
|
|
85
|
+
## Best For
|
|
103
86
|
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
87
|
+
- product viewers and configurators;
|
|
88
|
+
- cinematic 3D landing pages;
|
|
89
|
+
- browser-native game prototypes;
|
|
90
|
+
- prompt-authored animation channels;
|
|
91
|
+
- episode and animation-studio workflows;
|
|
92
|
+
- character controller prototypes;
|
|
93
|
+
- Three.js migration experiments that need a source-owned starter.
|
|
107
94
|
|
|
108
95
|
## Links
|
|
109
96
|
|
|
110
97
|
- Website: https://aura3d.auraone.ai
|
|
111
98
|
- Repository: https://github.com/auraoneai/aura3d
|
|
112
|
-
- Template docs: https://github.com/auraoneai/aura3d/blob/main/docs/templates/create-aura3d-templates.md
|
|
113
99
|
- Engine package: https://www.npmjs.com/package/@aura3d/engine
|
|
100
|
+
- CLI package: https://www.npmjs.com/package/@aura3d/cli
|
package/dist/index.js
CHANGED
|
@@ -41,7 +41,7 @@ export function createA3DProject(options) {
|
|
|
41
41
|
const packageJson = JSON.parse(readFileSync(packagePath, "utf8"));
|
|
42
42
|
packageJson.dependencies = {
|
|
43
43
|
...(packageJson.dependencies ?? {}),
|
|
44
|
-
"@aura3d/engine": options.packageVersion ?? packageJson.dependencies?.["@aura3d/engine"] ?? "1.4.
|
|
44
|
+
"@aura3d/engine": options.packageVersion ?? packageJson.dependencies?.["@aura3d/engine"] ?? "1.4.3"
|
|
45
45
|
};
|
|
46
46
|
writeFileSync(packagePath, `${JSON.stringify(packageJson, null, 2)}\n`);
|
|
47
47
|
return {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-aura3d",
|
|
3
|
-
"version": "1.4.
|
|
3
|
+
"version": "1.4.3",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"bin": {
|
|
6
6
|
"create-aura3d": "dist/cli.js"
|
|
@@ -54,9 +54,9 @@
|
|
|
54
54
|
"main": "./dist/index.js",
|
|
55
55
|
"types": "./dist/index.d.ts",
|
|
56
56
|
"dependencies": {
|
|
57
|
-
"@aura3d/asset-index": "1.4.
|
|
57
|
+
"@aura3d/asset-index": "1.4.3"
|
|
58
58
|
},
|
|
59
|
-
"description": "
|
|
59
|
+
"description": "Start real Aura3D browser 3D apps in one command with Vite templates, typed GLB/glTF assets, route-health tests, screenshots, and deploy-ready structure.",
|
|
60
60
|
"keywords": [
|
|
61
61
|
"create-aura3d",
|
|
62
62
|
"vite",
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
"test:negative-failed-puppets": "playwright test tests/concept-2-5d.spec.ts tests/puppet-2d.spec.ts tests/image-puppet.spec.ts tests/concept-2-5d-animation.spec.ts tests/puppet-2d-animation.spec.ts tests/image-puppet-animation.spec.ts --workers=1"
|
|
13
13
|
},
|
|
14
14
|
"dependencies": {
|
|
15
|
-
"@aura3d/engine": "1.4.
|
|
15
|
+
"@aura3d/engine": "1.4.3"
|
|
16
16
|
},
|
|
17
17
|
"devDependencies": {
|
|
18
18
|
"@playwright/test": "^1.52.0",
|
|
@@ -16,11 +16,11 @@
|
|
|
16
16
|
"preview": "vite preview --host 0.0.0.0"
|
|
17
17
|
},
|
|
18
18
|
"dependencies": {
|
|
19
|
-
"@aura3d/animation": "1.4.
|
|
20
|
-
"@aura3d/assets": "1.4.
|
|
21
|
-
"@aura3d/core": "1.4.
|
|
22
|
-
"@aura3d/engine": "1.4.
|
|
23
|
-
"@aura3d/physics": "1.4.
|
|
19
|
+
"@aura3d/animation": "1.4.3",
|
|
20
|
+
"@aura3d/assets": "1.4.3",
|
|
21
|
+
"@aura3d/core": "1.4.3",
|
|
22
|
+
"@aura3d/engine": "1.4.3",
|
|
23
|
+
"@aura3d/physics": "1.4.3",
|
|
24
24
|
"react": "^18.3.1",
|
|
25
25
|
"react-dom": "^18.3.1",
|
|
26
26
|
"sharp": "^0.33.5"
|
|
@@ -11,9 +11,9 @@
|
|
|
11
11
|
"test": "playwright test tests/route-health.spec.ts tests/screenshot.spec.ts --workers=1"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@aura3d/animation": "1.4.
|
|
15
|
-
"@aura3d/engine": "1.4.
|
|
16
|
-
"@aura3d/physics": "1.4.
|
|
14
|
+
"@aura3d/animation": "1.4.3",
|
|
15
|
+
"@aura3d/engine": "1.4.3",
|
|
16
|
+
"@aura3d/physics": "1.4.3"
|
|
17
17
|
},
|
|
18
18
|
"devDependencies": {
|
|
19
19
|
"@playwright/test": "^1.52.0",
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"test": "playwright test tests/route-health.spec.ts tests/playable.spec.ts tests/screenshot.spec.ts --workers=1"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@aura3d/engine": "1.4.
|
|
14
|
+
"@aura3d/engine": "1.4.3"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
17
|
"@playwright/test": "^1.52.0",
|