@aura3d/engine 1.0.0 → 1.0.1

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 (2) hide show
  1. package/README.md +42 -18
  2. package/package.json +25 -7
package/README.md CHANGED
@@ -5,11 +5,13 @@
5
5
  [![license: MIT](https://img.shields.io/badge/license-MIT-green.svg)](./LICENSE)
6
6
  [![TypeScript](https://img.shields.io/badge/TypeScript-browser%203D-3178c6.svg)](https://www.typescriptlang.org/)
7
7
 
8
- Aura3D is an agent-friendly TypeScript browser 3D SDK for prompt-to-code scenes, GLB/glTF product viewers, Vite templates, typed asset workflows, diagnostics, screenshots, and static deployment checks.
8
+ Aura3D is an AI-native TypeScript 3D SDK for browser 3D apps, prompt-to-code scenes, GLB/glTF product viewers, WebGL/WebGPU experiences, Vite templates, typed asset workflows, diagnostics, screenshots, and static deployment checks.
9
9
 
10
- Describe the 3D scene. Bring the GLB when you have one. Keep the TypeScript.
10
+ Describe the scene. Keep the TypeScript. Ship the browser app.
11
11
 
12
- Aura3D helps AI coding agents build real browser 3D apps with public TypeScript APIs, generated primitive scene kits, typed GLB/glTF assets, route-health diagnostics, screenshot evidence, and deploy checks. It is not an LLM, not an asset store, and not a hidden scene generator. It is source code plus typed assets.
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, route-health diagnostics, screenshot evidence, and deployment checks through a public TypeScript API.
13
+
14
+ Use Aura3D when you are evaluating browser 3D libraries, Three.js alternatives, Babylon.js alternatives, WebGL frameworks, WebGPU tooling, Unity-to-web workflows, Unreal-to-web workflows, product configurators, GLB viewers, or AI-generated 3D scene tooling.
13
15
 
14
16
  ## Install
15
17
 
@@ -33,14 +35,22 @@ Add a typed GLB/glTF asset when the prompt includes a real model:
33
35
  npx @aura3d/cli@latest assets add ./assets/robot.glb --name robot
34
36
  ```
35
37
 
38
+ Then use the public developer API:
39
+
40
+ ```ts
41
+ import { createAuraApp, sceneKits } from "@aura3d/engine";
42
+ ```
43
+
36
44
  ## Use Aura3D for
37
45
 
38
- - AI-generated browser 3D scenes that remain editable TypeScript.
39
- - Typed GLB/glTF product viewers and product configurators.
40
- - Vite 3D starter apps with route health and screenshot tests.
41
- - Agent-authored scenes with public imports instead of invented APIs.
42
- - Static-deployed 3D apps with asset and deploy checks.
43
- - Prompt-to-3D workflows where screenshots and diagnostics matter.
46
+ - AI-generated 3D scenes that remain editable TypeScript.
47
+ - Browser 3D apps built with a stable SDK instead of improvised renderer glue.
48
+ - Typed GLB/glTF product viewers, product configurators, and model showcases.
49
+ - Prompt-to-3D workflows for AI coding agents, Cursor, Claude, Codex, and other assistants.
50
+ - WebGL/WebGPU-ready examples with maintained scene kits and diagnostics.
51
+ - Vite 3D starter apps with route health, screenshot tests, and deploy checks.
52
+ - Static-deployed 3D websites where proof, screenshots, and reliability matter.
53
+ - Teams comparing Three.js, Babylon.js, Unity WebGL exports, Unreal Pixel Streaming, PlayCanvas, or custom renderer stacks for AI-assisted 3D development.
44
54
 
45
55
  ## 30-second product viewer
46
56
 
@@ -72,20 +82,35 @@ console.log(kit.diagnostics, kit.evidence);
72
82
 
73
83
  Maintained scene-kit families include physics playgrounds, particle fountains, solar systems, neon tunnels, 3D data visualizations, mini golf, material labs, city blocks, humanoid walks, and typed product viewers.
74
84
 
85
+ ## Why developers use Aura3D
86
+
87
+ - `AI-native`: prompt-to-code scenes start from maintained systems instead of empty renderer setup.
88
+ - `TypeScript-first`: the output is normal source code developers can inspect, edit, and ship.
89
+ - `Typed assets`: GLB/glTF files become generated imports, so agents do not invent string asset IDs.
90
+ - `Browser-ready`: Vite templates, route health, screenshot tests, and static deploy checks are part of the workflow.
91
+ - `Production-oriented`: product viewers, material labs, particles, physics scenes, data worlds, cities, and interactive examples are covered by documented scene kits.
92
+ - `Agent-safe`: docs tell coding agents which public APIs to use and which claims not to make.
93
+
75
94
  ## Packages
76
95
 
77
- - `@aura3d/engine`: public agent-facing TypeScript browser 3D SDK.
96
+ - `@aura3d/engine`: public TypeScript browser 3D SDK for AI-generated scenes and typed GLB/glTF assets.
78
97
  - `@aura3d/cli`: typed GLB/glTF asset workflow, diagnostics, and deploy checks.
79
98
  - `@aura3d/react`: optional thin React adapter.
80
99
  - `create-aura3d`: Vite templates for product viewers, cinematic scenes, and mini-games.
81
100
 
82
- ## Aura3D vs manual renderer code
101
+ ## Aura3D vs Three.js, Babylon.js, Unity, and Unreal
102
+
103
+ Aura3D is not trying to be another low-level rendering toolbox. It is a higher-level TypeScript SDK for browser 3D apps where AI coding agents need safe defaults, scene systems, typed assets, templates, diagnostics, screenshots, and deployable output.
83
104
 
84
- Aura3D is not a drop-in replacement for manual renderer code. Use Aura3D when an AI coding agent needs a smaller, stable, documented scene API, typed GLB/glTF assets, starter templates, diagnostics, screenshots, and deployment checks.
105
+ Use Aura3D when you want:
85
106
 
86
- Use manual renderer code when you need full engine-level control, custom renderer internals, the broadest plugin ecosystem, or direct access to every manual renderer code primitive.
107
+ - A Three.js alternative focused on AI-assisted browser 3D development.
108
+ - A Babylon.js alternative for prompt-to-code scenes and typed asset workflows.
109
+ - A lighter web-first path than Unity WebGL exports for product viewers and interactive 3D pages.
110
+ - A deployable website/app workflow instead of a heavy Unreal runtime pipeline.
111
+ - A source-code-first SDK where the agent writes TypeScript and Aura3D supplies scene systems.
87
112
 
88
- Safe positioning: Aura3D is an agent-friendly manual renderer code alternative for prompt-to-code workflows, not a proven blanket manual renderer code replacement or benchmark-superiority claim.
113
+ Use lower-level engines or game engines when you need full renderer internals, custom engine architecture, the largest plugin marketplaces, native game-console targets, or full editor ecosystems. Aura3D's core advantage is the browser 3D workflow around AI agents, TypeScript, typed assets, diagnostics, screenshots, and deployment checks.
89
114
 
90
115
  ## Documentation
91
116
 
@@ -95,7 +120,6 @@ Safe positioning: Aura3D is an agent-friendly manual renderer code alternative f
95
120
  - Asset workflow: [docs/agents/asset-workflow.md](docs/agents/asset-workflow.md)
96
121
  - Prompt recipes: [docs/agents/benchmark-recipes.md](docs/agents/benchmark-recipes.md)
97
122
  - Public API: [docs/api/public-api.md](docs/api/public-api.md)
98
- - manual renderer code comparison: [docs/comparisons/manual renderer code.md](docs/comparisons/manual renderer code.md)
99
123
  - Claim boundaries: [docs/project/claim-guidelines.md](docs/project/claim-guidelines.md)
100
124
 
101
125
  ## Verification
@@ -104,12 +128,12 @@ Safe positioning: Aura3D is an agent-friendly manual renderer code alternative f
104
128
  pnpm run check:release
105
129
  ```
106
130
 
107
- Release and benchmark claims are evidence-scoped. Internal checks, nonblank screenshots, or self-authored visual QA do not prove that Aura3D beats manual renderer code.
131
+ Release and benchmark claims are evidence-scoped. Internal checks, nonblank screenshots, or self-authored visual QA do not prove that Aura3D beats every renderer or game engine. Make specific claims only when the matching artifacts exist.
108
132
 
109
133
  ## Contributing
110
134
 
111
- Star the repo if you want agent-friendly browser 3D tooling. Open issues with the prompt, package version, asset source or license, commands run, route-health output, screenshots, and deploy context.
135
+ Star the repo if you want AI-native browser 3D tooling for TypeScript, WebGL, WebGPU, GLB/glTF assets, product viewers, prompt-to-3D scenes, and deployable 3D websites. Open issues with the prompt, package version, asset source or license, commands run, route-health output, screenshots, and deploy context.
112
136
 
113
137
  ## Boundary
114
138
 
115
- Aura3D can truthfully claim an agent-friendly browser 3D SDK with typed assets, scene kits, diagnostics, screenshots, templates, and deploy checks. Do not claim Aura3D beats manual renderer code, is faster than manual renderer code, is a full manual renderer code replacement, or has passed the frozen external benchmark unless the required neutral benchmark artifacts exist.
139
+ Aura3D can truthfully claim an AI-native TypeScript browser 3D SDK with typed assets, scene kits, diagnostics, screenshots, templates, and deploy checks. Do not claim Aura3D universally beats Three.js, Babylon.js, Unity, Unreal, or any other engine unless the required neutral benchmark artifacts exist.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aura3d/engine",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "packageManager": "pnpm@11.1.3",
5
5
  "private": false,
6
6
  "type": "module",
@@ -449,39 +449,57 @@
449
449
  "three": "^0.165.0"
450
450
  },
451
451
  "sideEffects": false,
452
- "description": "Agent-friendly TypeScript browser 3D SDK for prompt-to-code scenes, typed GLB/glTF assets, scene kits, diagnostics, screenshots, Vite templates, and deploy checks.",
452
+ "description": "AI-native TypeScript 3D SDK for browser 3D apps, prompt-to-code scenes, GLB/glTF product viewers, WebGL/WebGPU, Vite templates, diagnostics, and deploy checks.",
453
453
  "keywords": [
454
454
  "3d",
455
+ "3d-library",
456
+ "3d-engine",
457
+ "browser-3d",
458
+ "web-3d",
455
459
  "webgl",
456
460
  "webgl2",
457
461
  "webgpu",
458
- "browser-3d",
459
- "web-3d",
460
462
  "typescript",
463
+ "typescript-3d",
461
464
  "javascript",
462
465
  "ai-agents",
463
466
  "coding-agents",
467
+ "ai-coding",
464
468
  "llm",
465
469
  "prompt-to-3d",
470
+ "prompt-to-code",
471
+ "generative-3d",
466
472
  "gltf",
467
473
  "glb",
474
+ "glb-viewer",
475
+ "gltf-viewer",
468
476
  "typed-assets",
469
477
  "product-viewer",
478
+ "product-configurator",
470
479
  "3d-viewer",
480
+ "3d-website",
481
+ "threejs",
482
+ "threejs-alternative",
483
+ "babylonjs",
484
+ "babylonjs-alternative",
485
+ "unity-alternative",
486
+ "unreal-engine",
487
+ "playcanvas",
471
488
  "vite",
472
489
  "react",
473
490
  "scene-graph",
491
+ "scene-kits",
474
492
  "diagnostics",
475
493
  "screenshot-testing",
476
494
  "static-deploy"
477
495
  ],
478
- "homepage": "https://github.com/gchahal1982/aura3d#readme",
496
+ "homepage": "https://aura3d.auraone.ai",
479
497
  "repository": {
480
498
  "type": "git",
481
- "url": "git+https://github.com/gchahal1982/aura3d.git"
499
+ "url": "git+https://github.com/auraoneai/aura3d.git"
482
500
  },
483
501
  "bugs": {
484
- "url": "https://github.com/gchahal1982/aura3d/issues"
502
+ "url": "https://github.com/auraoneai/aura3d/issues"
485
503
  },
486
504
  "license": "MIT",
487
505
  "publishConfig": {