@aura3d/engine 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 +94 -133
- package/dist/create-aura3d/index.js +1 -1
- package/package.json +23 -23
package/README.md
CHANGED
|
@@ -5,146 +5,107 @@
|
|
|
5
5
|
[](./LICENSE)
|
|
6
6
|
[](https://www.typescriptlang.org/)
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
Describe the scene. Keep the TypeScript. Ship the browser app.
|
|
11
|
-
|
|
12
|
-
Aura3D is built for developers and AI coding agents that need real 3D software, not a blank canvas and renderer glue. It gives agents maintained scene kits, typed GLB/glTF assets, product-viewer workflows, source-level game prototype workflows, route-health diagnostics, screenshot evidence, and deployment checks through a public TypeScript API.
|
|
13
|
-
|
|
14
|
-
Use Aura3D when you are building agent-written browser 3D apps, prompt-authored scenes, product configurators, GLB viewers, browser-native game-route prototypes, static-deployed interactive websites, or AI-generated 3D scene tooling.
|
|
15
|
-
|
|
16
|
-
## Public claim boundary
|
|
17
|
-
|
|
18
|
-
Aura3D has multiple capability paths. Public claims must name the path they are
|
|
19
|
-
proving:
|
|
20
|
-
|
|
21
|
-
- root safe API: `@aura3d/engine` through `createAuraApp`;
|
|
22
|
-
- production runtime: `@aura3d/engine/production-runtime`;
|
|
23
|
-
- rendering internals: `@aura3d/rendering` and explicit renderer packages;
|
|
24
|
-
- CLI asset pipeline: `@aura3d/cli` typed asset acquisition and validation;
|
|
25
|
-
- templates and showcase routes.
|
|
26
|
-
|
|
27
|
-
The root `createAuraApp` path is the API that AI coding agents should use for
|
|
28
|
-
browser examples. A feature is not public-route proof just because a lower-level
|
|
29
|
-
package exports it. For release-facing docs, screenshots, or marketing pages,
|
|
30
|
-
claim only what the mounted route proves with typed assets, browser evidence,
|
|
31
|
-
and route-health output. Unsupported capabilities must be labeled as
|
|
32
|
-
`production-runtime`, `internal`, `prototype`, or `planned`.
|
|
33
|
-
|
|
34
|
-
Do not use primitives as the primary subject for named real-world objects,
|
|
35
|
-
characters, vehicles, worlds, products, or game environments. Resolve real
|
|
36
|
-
GLB/glTF assets through the Aura3D CLI, import generated `assets` from
|
|
37
|
-
`src/aura-assets.ts`, and render with `model(assets.x)`. Do not use raw string
|
|
38
|
-
asset ids, invented URLs, `GLTFLoader`, direct `three` imports, CSS particles,
|
|
39
|
-
DOM scene effects, or route-local hacks to make a public example appear more
|
|
40
|
-
capable than the Aura3D API path actually is.
|
|
41
|
-
|
|
42
|
-
## Showcase integrity
|
|
43
|
-
|
|
44
|
-
The showcase routes must use Aura3D for scene content. CSS and DOM are allowed
|
|
45
|
-
for layout, HUDs, buttons, panels, responsive sizing, and accessibility text
|
|
46
|
-
only. They must not be used as a substitute for 3D content, particles, motion,
|
|
47
|
-
track scenery, city scenery, data visuals, robots, vehicles, beams, scanlines,
|
|
48
|
-
vignettes, or other effects that are claimed as part of the 3D scene.
|
|
49
|
-
|
|
50
|
-
The current release-candidate showcase classification is:
|
|
51
|
-
|
|
52
|
-
- Public release candidates: `apps/showcase-product-configurator/`,
|
|
53
|
-
`apps/showcase-material-asset-inspector/`,
|
|
54
|
-
`apps/showcase-smart-city-control/`,
|
|
55
|
-
`apps/showcase-cinematic-architecture/`,
|
|
56
|
-
`apps/showcase-digital-twin-ops/`, and
|
|
57
|
-
`apps/showcase-blockfall-reactor/`.
|
|
58
|
-
- Internal diagnostics retained for evidence only:
|
|
59
|
-
`apps/showcase-data-galaxy/` and
|
|
60
|
-
`apps/showcase-webgpu-particle-lab/`.
|
|
61
|
-
- Prototype-blocked game diagnostics, intentionally removed from public
|
|
62
|
-
examples: `apps/showcase-turbo-drift-circuit/` and
|
|
63
|
-
`apps/showcase-skyline-runner/`.
|
|
64
|
-
|
|
65
|
-
`node tools/showcase-library/build-and-check.mjs` is the release gate for this
|
|
66
|
-
classification. The current public release status is 6/6 public candidates
|
|
67
|
-
passing, with two internal diagnostics and two prototype-blocked game routes
|
|
68
|
-
retained outside the public showcase path.
|
|
69
|
-
|
|
70
|
-
For those routes, the implementation boundary is:
|
|
71
|
-
|
|
72
|
-
- Use public `@aura3d/engine` APIs such as `createAuraApp`,
|
|
73
|
-
`createGameApp`, `scene`, `sceneKits`, `model`, `camera`, `lights`,
|
|
74
|
-
`material`, `primitives`, `effects`, `particles`, `labels`, `charts`,
|
|
75
|
-
`game`, `interactions`, and `timeline`.
|
|
76
|
-
- Use typed assets from `src/aura-assets.ts` with `model(assets.x)`.
|
|
77
|
-
Do not write string asset ids such as `model("asset")`, invented URLs, raw
|
|
78
|
-
GLB URLs, or direct loader code.
|
|
79
|
-
- Use Aura3D particles through `effects.particles(...)`,
|
|
80
|
-
`particles.fountain(...)`, or the explicit WebGPU rendering path when it is
|
|
81
|
-
actually supported. Do not create particle clouds with DOM nodes, CSS
|
|
82
|
-
animations, pseudo-elements, or background gradients.
|
|
83
|
-
- Use Aura3D runtime movement through `app.onFrame(...)`,
|
|
84
|
-
`.runtime(game.runtimeNode("id"))`, and runtime node mutation. Do not fake
|
|
85
|
-
scene motion with CSS keyframes or DOM transforms.
|
|
86
|
-
- Use CSS only for UI chrome and layout. A screenshot should still show the
|
|
87
|
-
3D scene, particles, motion targets, and typed assets when CSS decorative
|
|
88
|
-
backgrounds are removed.
|
|
89
|
-
- Keep claims honest: native WebGPU, typed asset usage, game runtime,
|
|
90
|
-
animation, particles, screenshots, and deployment readiness must each map to
|
|
91
|
-
a named API, route evidence global, test, screenshot, or report.
|
|
92
|
-
|
|
93
|
-
Current renderer boundary: the `createAuraApp` WebGL2 agent runtime used by the
|
|
94
|
-
showcase routes renders typed GLB meshes, glTF base-color textures, non-skinned
|
|
95
|
-
glTF node animation clips, Aura primitives, Aura particle effects,
|
|
96
|
-
runtime-node transforms, and basic scene effects. It is still not the full
|
|
97
|
-
production renderer path: it does not yet render skinned GLB animation mixer
|
|
98
|
-
playback, full PBR material stacks, image-based lighting, shadow maps, or
|
|
99
|
-
postprocess passes in pixels on that route. Do not claim visible skinned
|
|
100
|
-
character animation or Three.js-grade production material parity from a
|
|
101
|
-
`createAuraApp` screenshot until the agent renderer adapter is wired to the
|
|
102
|
-
production animation/skinning and material runtime; publish unsupported
|
|
103
|
-
capabilities as metadata only.
|
|
104
|
-
|
|
105
|
-
Release-facing showcase PRs must pass `assets validate --source --release`,
|
|
106
|
-
route-health collection, browser screenshots, visual review, and game input
|
|
107
|
-
tests where applicable. If any route uses primitive-only primary subjects, fake
|
|
108
|
-
CSS/DOM particles, unsupported WebGPU/PBR/skinning claims, or screenshots where
|
|
109
|
-
the primary subject is hidden, tiny, clipped, or unreadable, the route must be
|
|
110
|
-
classified as prototype, internal diagnostic, or blocked instead of public.
|
|
8
|
+
Build browser 3D apps from prompts, assets, and TypeScript.
|
|
111
9
|
|
|
112
|
-
|
|
10
|
+
Aura3D is the developer SDK for AI-authored 3D software: product viewers,
|
|
11
|
+
interactive scenes, cinematic pages, prototype game routes, animation tools,
|
|
12
|
+
and deployable Vite apps. It gives coding agents and developers a real 3D app
|
|
13
|
+
surface instead of a pile of renderer glue: typed GLB/glTF assets, scene kits,
|
|
14
|
+
starter templates, route-health checks, screenshots, and static deploy proof.
|
|
15
|
+
|
|
16
|
+
Describe the scene. Keep the code. Ship the app.
|
|
113
17
|
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
18
|
+
## Start In One Command
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx create-aura3d@latest my-product --template product-viewer
|
|
22
|
+
cd my-product
|
|
23
|
+
npm run dev
|
|
24
|
+
```
|
|
118
25
|
|
|
119
|
-
|
|
120
|
-
foundations forward, then hardened the release path:
|
|
121
|
-
role-aware asset validation, rendered-probe rejection for fake/stale proof, AST
|
|
122
|
-
source validation, package/dist parity checks, resolver-backed showcase-spec
|
|
123
|
-
repair, route-primary probes, release asset probes, gameplay proof where
|
|
124
|
-
appropriate, and visual review as a hard public-release gate.
|
|
26
|
+
Add a real model and keep it typed:
|
|
125
27
|
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
WebGPU Particle Lab stay internal diagnostics. Turbo Drift Circuit and Skyline
|
|
130
|
-
Runner stay prototype-blocked until the game layer has certified racing
|
|
131
|
-
topology and platformer playable-surface support.
|
|
28
|
+
```bash
|
|
29
|
+
npx @aura3d/cli@latest assets add ./assets/sneaker.glb --name sneaker
|
|
30
|
+
```
|
|
132
31
|
|
|
133
|
-
|
|
32
|
+
Render it from normal TypeScript:
|
|
134
33
|
|
|
135
|
-
|
|
34
|
+
```ts
|
|
35
|
+
import { createAuraApp, lights, model, scene } from "@aura3d/engine";
|
|
36
|
+
import { assets } from "./aura-assets";
|
|
37
|
+
|
|
38
|
+
createAuraApp("#app", {
|
|
39
|
+
scene: scene().add(model(assets.sneaker)).add(lights.studio())
|
|
40
|
+
});
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Why Developers Install It
|
|
44
|
+
|
|
45
|
+
- **Prompt-to-code, not prompt-to-mystery.** Aura3D turns AI-generated 3D work
|
|
46
|
+
into editable TypeScript projects you can inspect, test, and ship.
|
|
47
|
+
- **Real assets by default.** The CLI tracks GLB/glTF source, license,
|
|
48
|
+
metadata, hashes, and generated `assets.name` imports.
|
|
49
|
+
- **Templates that start as apps.** Product viewers, cinematic scenes,
|
|
50
|
+
mini-games, fighting-game prototypes, animation channels, episode builders,
|
|
51
|
+
character controllers, and Three.js migration starters all scaffold as Vite
|
|
52
|
+
projects.
|
|
53
|
+
- **Built-in proof.** Route-health checks, screenshots, package smoke tests,
|
|
54
|
+
and deploy checks are part of the workflow instead of an afterthought.
|
|
55
|
+
- **Designed for coding agents.** Codex, Claude, Cursor, and other agents get
|
|
56
|
+
a stable API, typed assets, and guardrails that keep generated scenes in real
|
|
57
|
+
source code.
|
|
58
|
+
|
|
59
|
+
## What You Can Build
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
npx create-aura3d@latest shoe-launch --template product-viewer
|
|
63
|
+
npx create-aura3d@latest launch-film --template cinematic-scene
|
|
64
|
+
npx create-aura3d@latest arena --template fighting-game
|
|
65
|
+
npx create-aura3d@latest episode --template prompt-animation-channel
|
|
66
|
+
npx create-aura3d@latest studio --template animation-studio
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Aura3D is especially useful when the output needs to be more than a demo:
|
|
70
|
+
typed assets, browser tests, screenshots, deploy checks, and source code that a
|
|
71
|
+
developer can keep owning after the AI has written the first pass.
|
|
72
|
+
|
|
73
|
+
## Packages
|
|
74
|
+
|
|
75
|
+
- `@aura3d/engine`: public TypeScript runtime for browser 3D scenes and apps.
|
|
76
|
+
- `create-aura3d`: one-command Vite scaffolds for Aura3D projects.
|
|
77
|
+
- `@aura3d/cli`: typed GLB/glTF asset workflow, catalog search, validation,
|
|
78
|
+
diagnostics, and deploy checks.
|
|
79
|
+
- Package modules for animation, rendering, scene, physics, materials, React,
|
|
80
|
+
product-studio, workflows, controls, environments, and Three.js migration.
|
|
81
|
+
|
|
82
|
+
## Proof-Oriented By Design
|
|
83
|
+
|
|
84
|
+
Aura3D is built for public, inspectable software. Generated projects keep their
|
|
85
|
+
TypeScript source, asset manifest, tests, screenshots, and deploy checks in the
|
|
86
|
+
repo. The claim-boundary and release evidence docs live under `docs/` for teams
|
|
87
|
+
that need strict publication review, but the developer path starts here: create
|
|
88
|
+
an app, add typed assets, run it, test it, deploy it.
|
|
89
|
+
|
|
90
|
+
## Current Release
|
|
136
91
|
|
|
137
|
-
|
|
92
|
+
`@aura3d/engine@1.4.3` is the current package release across the 26 public
|
|
93
|
+
Aura3D packages. It is a developer-positioning and npm-discoverability patch:
|
|
94
|
+
the root README, `create-aura3d`, and `@aura3d/cli` now lead with the install
|
|
95
|
+
path, typed asset workflow, templates, and developer outcomes that make Aura3D
|
|
96
|
+
worth trying.
|
|
138
97
|
|
|
139
|
-
|
|
98
|
+
The runtime baseline remains the 1.4.x package family: public
|
|
99
|
+
`createAuraApp` scene composition, typed GLB/glTF assets, prompt-oriented
|
|
100
|
+
templates, asset validation, route-health checks, screenshots, deploy checks,
|
|
101
|
+
game prototype helpers, animation workflow packages, and the package smoke
|
|
102
|
+
tests used for release.
|
|
140
103
|
|
|
141
|
-
Registry target:
|
|
142
|
-
(`@aura3d/engine`, `@aura3d/asset-index`, `@aura3d/cli`, `create-aura3d`,
|
|
143
|
-
|
|
144
|
-
`
|
|
145
|
-
|
|
146
|
-
the showcase is deployed at
|
|
147
|
-
https://aura3d.auraone.ai.
|
|
104
|
+
Registry target: npm `latest` resolves to `1.4.3` across all 26 public packages
|
|
105
|
+
(`@aura3d/engine`, `@aura3d/asset-index`, `@aura3d/cli`, `create-aura3d`, and
|
|
106
|
+
the rest of the package family). Release evidence and detailed claim boundaries
|
|
107
|
+
live under `docs/project/` and `docs/agents/` so the README can stay focused on
|
|
108
|
+
why developers should install the SDK.
|
|
148
109
|
|
|
149
110
|
## Aura3D 1.1.0 asset catalog
|
|
150
111
|
|
|
@@ -168,7 +129,7 @@ npx @aura3d/cli@latest assets validate-game --profile fighting-character --asset
|
|
|
168
129
|
`--profile fighting-character` requires animated GLB candidates from verified CC0/CC-BY sources, applies a browser-sized triangle budget, and writes source URL, license, author/attribution, and source family into `aura.assets.json` during `assets resolve`.
|
|
169
130
|
## Aura3D 1.1.0 runtime launch track
|
|
170
131
|
|
|
171
|
-
Aura3D 1.1.0 introduced the runtime and animation evidence foundation; 1.4.
|
|
132
|
+
Aura3D 1.1.0 introduced the runtime and animation evidence foundation; 1.4.3 is
|
|
172
133
|
the current package release that carries it forward:
|
|
173
134
|
|
|
174
135
|
- `game runtime`: mutable runtime nodes, app-owned frame loops, input, kinematic bodies, hitboxes, combat events, camera direction, effects, and evidence for browser-native game prototypes.
|
|
@@ -621,7 +582,7 @@ Aura3D 1.1.0 game-engine/showcase readiness is stricter:
|
|
|
621
582
|
pnpm aura3d110:readiness
|
|
622
583
|
```
|
|
623
584
|
|
|
624
|
-
Expected current state — The scoped package gates pass for the published 1.4.
|
|
585
|
+
Expected current state — The scoped package gates pass for the published 1.4.3
|
|
625
586
|
baseline, and the release-candidate showcase gate passes for six public examples
|
|
626
587
|
while retaining two internal diagnostics and two prototype-blocked game routes
|
|
627
588
|
outside the public path.
|
|
@@ -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": "@aura3d/engine",
|
|
3
|
-
"version": "1.4.
|
|
3
|
+
"version": "1.4.3",
|
|
4
4
|
"private": false,
|
|
5
5
|
"type": "module",
|
|
6
6
|
"files": [
|
|
@@ -118,27 +118,27 @@
|
|
|
118
118
|
"typescript": "^5.8.3",
|
|
119
119
|
"vite": "^7.3.2",
|
|
120
120
|
"vitest": "^3.1.3",
|
|
121
|
-
"@aura3d/
|
|
122
|
-
"@aura3d/
|
|
123
|
-
"@aura3d/audio": "1.4.
|
|
124
|
-
"@aura3d/
|
|
125
|
-
"@aura3d/
|
|
126
|
-
"@aura3d/assets": "1.4.
|
|
127
|
-
"@aura3d/debug": "1.4.
|
|
128
|
-
"@aura3d/
|
|
129
|
-
"@aura3d/
|
|
130
|
-
"@aura3d/editor-runtime": "1.4.
|
|
131
|
-
"@aura3d/
|
|
132
|
-
"@aura3d/
|
|
133
|
-
"@aura3d/
|
|
134
|
-
"@aura3d/
|
|
135
|
-
"@aura3d/product-studio": "1.4.
|
|
136
|
-
"@aura3d/
|
|
137
|
-
"@aura3d/
|
|
138
|
-
"@aura3d/workflows": "1.4.
|
|
139
|
-
"
|
|
140
|
-
"
|
|
141
|
-
"@aura3d/
|
|
121
|
+
"@aura3d/animation": "1.4.3",
|
|
122
|
+
"@aura3d/apps": "1.4.3",
|
|
123
|
+
"@aura3d/audio": "1.4.3",
|
|
124
|
+
"@aura3d/core": "1.4.3",
|
|
125
|
+
"@aura3d/cli": "1.4.3",
|
|
126
|
+
"@aura3d/assets": "1.4.3",
|
|
127
|
+
"@aura3d/debug": "1.4.3",
|
|
128
|
+
"@aura3d/ecs": "1.4.3",
|
|
129
|
+
"@aura3d/editor": "1.4.3",
|
|
130
|
+
"@aura3d/editor-runtime": "1.4.3",
|
|
131
|
+
"@aura3d/engine-runtime": "1.4.3",
|
|
132
|
+
"@aura3d/input": "1.4.3",
|
|
133
|
+
"@aura3d/math": "1.4.3",
|
|
134
|
+
"@aura3d/physics": "1.4.3",
|
|
135
|
+
"@aura3d/product-studio": "1.4.3",
|
|
136
|
+
"@aura3d/rendering": "1.4.3",
|
|
137
|
+
"@aura3d/scene": "1.4.3",
|
|
138
|
+
"@aura3d/workflows": "1.4.3",
|
|
139
|
+
"@aura3d/scripting": "1.4.3",
|
|
140
|
+
"create-aura3d": "1.4.3",
|
|
141
|
+
"@aura3d/react": "1.4.3"
|
|
142
142
|
},
|
|
143
143
|
"dependencies": {
|
|
144
144
|
"@loaders.gl/core": "4.4.1",
|
|
@@ -146,7 +146,7 @@
|
|
|
146
146
|
"cannon-es": "0.20.0"
|
|
147
147
|
},
|
|
148
148
|
"sideEffects": false,
|
|
149
|
-
"description": "AI-
|
|
149
|
+
"description": "Build AI-authored browser 3D apps with TypeScript, typed GLB/glTF assets, Vite templates, scene kits, diagnostics, screenshots, and deploy checks.",
|
|
150
150
|
"keywords": [
|
|
151
151
|
"3d",
|
|
152
152
|
"3d-library",
|