phoria2 0.0.0-stage → 1.0.0-rc.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-2026 Kevin Roast
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,133 @@
-# Temporary Holding Version
+# phoria2
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Small, friendly 3D for the web. A WebGL 2 renderer with PBR materials, instancing, points, lines,
+labels, picking and particles, behind an API small enough to learn in an afternoon - aimed at
+business apps: charts, labelled scenes, diagrams, dashboards and product viewers.
+
+- **Small**: about 46 KB gzipped for a lit, interactive scene; charts, particles and glTF are
+  separate imports, and the heavier parts (shadows, HDR environments, GPU picking) load only when used.
+- **Idle when nothing changes**: a view draws only when something in it changed, so a dashboard of
+  many views costs nothing at rest.
+- **Tells you what to write**: every option is checked, and a mistake throws an error that names
+  the fix - pass `colour` and you get `Material: use 'color'`. Written to be easy for coding
+  agents too.
+- **No runtime dependencies.** ES modules, with TypeScript types.
+
+## Install
+
+```sh
+npm install phoria2
+```
+
+Or straight from a CDN, with no build step:
+
+```html
+<script type="module">
+  import { View, Mesh, box } from 'https://cdn.jsdelivr.net/npm/phoria2/+esm'
+</script>
+```
+
+## A first scene
+
+```html
+<canvas id="c" style="width: 100%; height: 100vh; display: block"></canvas>
+<script type="module" src="./main.js"></script>
+```
+
+```js
+import { View, Mesh, box, DirectionalLight } from 'phoria2'
+
+const view = new View({ canvas: '#c', orbit: true, background: '#1c1c20' })
+const cube = view.scene.add(new Mesh({ geometry: box(2), material: { color: 'orange' } }))
+view.scene.add(new DirectionalLight({ direction: [-1, -2, -1] }))
+view.start((dt) => cube.rotateY(0.6 * dt))
+```
+
+The canvas takes its size from CSS; the view matches its drawing buffer to it and follows resizes.
+The camera starts fitted to the scene, and `orbit: true` lets the user turn, pan and zoom it.
+
+## Charts
+
+```js
+import { View } from 'phoria2'
+import { chart } from 'phoria2/charts'
+
+const view = new View({ canvas: '#c', orbit: true })
+view.scene.add(chart({
+  mark: 'bar',
+  data: rows,                         // [{ month: 'Jan', region: 'North', sales: 41 }, ...]
+  x: 'month', z: 'region', y: 'sales',
+  color: 'region',
+  tooltip: true,
+}))
+```
+
+Marks: `bar`, `point`, `line`, `area`, `surface` and `network`, with axes, legends, labels, tooltips
+and animated updates (`chart.update(newRows)`). A JSON schema for specs ships as
+`phoria2/charts/schema.json`.
+
+## Models
+
+```js
+import { loadGLTF } from 'phoria2/gltf'
+
+const model = await loadGLTF('models/chair.glb')   // .glb or .gltf
+view.scene.add(model)
+view.frame(model)
+model.play()                                        // its first animation
+```
+
+## With React
+
+React owns the canvas; phoria2 draws on it. Make the view once, dispose of it on unmount, and
+change the scene in place when props change:
+
+```jsx
+import { useEffect, useRef } from 'react'
+import { View, Mesh, box } from 'phoria2'
+
+export function SpinningBox({ color }) {
+  const canvas = useRef(null)
+  const mesh = useRef(null)
+
+  useEffect(() => {
+    const view = new View({ canvas: canvas.current, orbit: true })
+    mesh.current = view.scene.add(new Mesh({ geometry: box(2) }))
+    view.start((dt) => mesh.current.rotateY(0.6 * dt))
+    return () => view.dispose()
+  }, [])
+
+  useEffect(() => {
+    mesh.current.material.color.set(color)
+  }, [color])
+
+  return <canvas ref={canvas} style={{ width: '100%', height: 320 }} />
+}
+```
+
+A full example, with a chart that follows its data, is in
+[`examples/react`](https://github.com/kevinroast/kevs3d/tree/master/phoria2/examples/react).
+
+## What's in the package
+
+| Import | |
+|---|---|
+| `phoria2` | the view, scene graph, cameras, lights, materials, geometry, textures, picking, labels, `create()` from JSON |
+| `phoria2/charts` | `chart()` - charts from a spec of mark, data and channels, and the scales they use |
+| `phoria2/particles` | `Emitter` and `Body` |
+| `phoria2/gltf` | `loadGLTF()` - glTF 2.0 models with their materials and animations |
+
+## Browsers
+
+Any browser with WebGL 2: current Chrome, Edge, Firefox and Safari (desktop and iOS 15+).
+
+## Examples
+
+The demo gallery shows each feature and a few showcase scenes; its source is in
+[`demos/`](https://github.com/kevinroast/kevs3d/tree/master/phoria2/demos). The design and the
+reasoning behind the API are in [`API-DESIGN.md`](https://github.com/kevinroast/kevs3d/blob/master/phoria2/API-DESIGN.md).
+
+## Licence
+
+MIT - see [LICENSE](LICENSE). phoria2 is a rewrite of phoria, a 2013 library that drew 3D on the
+canvas 2D context.