minerender 2.1.0-alpha.75 → 2.1.0-alpha.77

package/README.md

@@ -62,3 +62,60 @@ Filter expressions use JavaScript regular expressions with substring matching.
 Namespace and path matches can come from different rules, following vanilla's
 filter behavior. Paths include the asset type and extension, such as
 `textures/block/stone.png`. Java-only regular expression syntax is not supported.
+
+## Load an editable scene
+
+The web scene editor saves versioned JSON that the library can load directly:
+
+```ts
+import { AssetLoader, Renderer, SceneDocumentLoader } from "minerender";
+
+const response = await fetch("./scene.json");
+if (!response.ok) throw new Error("Could not fetch scene.json");
+const definition = SceneDocumentLoader.parse(await response.json());
+if (definition.minecraftVersion) AssetLoader.setVersion(definition.minecraftVersion);
+
+const renderer = new Renderer({
+    controls: { enabled: true },
+    ...(definition.camera ? { camera: {
+        position: definition.camera.position,
+        lookingAt: definition.camera.target
+    } } : {})
+});
+renderer.appendTo(document.body);
+const scene = await SceneDocumentLoader.load(renderer.scene, definition);
+const unsubscribe = renderer.onFrame(({ delta }) => scene.advanceAnimations(delta));
+renderer.start();
+
+// Release the scene when its view closes.
+function dispose() {
+    unsubscribe();
+    scene.dispose();
+    renderer.dispose();
+}
+```
+
+A minimal document contains a format, schema version, and object definitions:
+
+```json
+{
+  "format": "minerender-scene",
+  "version": 1,
+  "minecraftVersion": "1.21.11",
+  "objects": [
+    {
+      "id": "stairs",
+      "type": "block",
+      "asset": "minecraft:oak_stairs",
+      "state": { "facing": "east", "half": "bottom", "shape": "straight" },
+      "position": [0, 0, 0],
+      "rotation": [0, 0, 0]
+    }
+  ]
+}
+```
+
+Supported object types are `skin`, `block`, `item`, `model`, `entity`, and `gui`.
+Positions use model units (16 per block); JSON rotations use radians.
+
+Callers apply the saved camera settings and select the matching asset version.