minerender 2.1.0-beta.2 → 2.1.0-beta.4

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 CHANGED
@@ -3,6 +3,8 @@
3
3
  A TypeScript library for interactive Minecraft skins, models, blocks, entities, and worlds.
4
4
  V2 is in beta. See the [roadmap](https://github.com/InventivetalentDev/MineRender/blob/main/ROADMAP.md) for feature parity and remaining work.
5
5
 
6
+ Live examples and usage docs: [beta.minerender.org](https://beta.minerender.org/). API reference: [beta-docs.minerender.org](https://beta-docs.minerender.org/).
7
+
6
8
  Install the beta package with its three.js peer:
7
9
 
8
10
  ```sh
@@ -21,7 +23,9 @@ renderer.start();
21
23
 
22
24
  The package provides ESM and CommonJS entries for browsers and Node.js, plus
23
25
  `dist/bundle.js` for the `MineRender` browser global. Node imports require the optional
24
- native `canvas` dependency; headless rendering is still in development.
26
+ native `canvas` dependency. The Node-only `NodeRenderer` creates PNG buffers through
27
+ an injected WebGL 2 context or the optional native `gl` backend. See
28
+ [Node rendering and setup](https://github.com/InventivetalentDev/MineRender/blob/main/packages/minerender/reference/platforms.md#render-a-png-in-nodejs).
25
29
 
26
30
  Requires Node.js 22.12+ or a browser with WebGL 2, Fetch, `AbortSignal.any()`, and `AbortSignal.timeout()`.
27
31