minerender 2.1.0-alpha.0 → 2.1.0-alpha.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.
Files changed (94) hide show
  1. package/README.md +0 -2
  2. package/dist/browser/index.d.mts +106 -84
  3. package/dist/browser/index.d.ts +106 -84
  4. package/dist/browser/index.js +1094 -968
  5. package/dist/browser/index.js.map +1 -1
  6. package/dist/browser/index.mjs +1107 -981
  7. package/dist/browser/index.mjs.map +1 -1
  8. package/dist/bundle.js +1045 -921
  9. package/dist/bundle.js.map +1 -1
  10. package/dist/node/index.d.mts +106 -84
  11. package/dist/node/index.d.ts +106 -84
  12. package/dist/node/index.js +1100 -970
  13. package/dist/node/index.js.map +1 -1
  14. package/dist/node/index.mjs +1112 -982
  15. package/dist/node/index.mjs.map +1 -1
  16. package/package.json +5 -5
  17. package/.worktrees/jobqu-review/LICENSE +0 -21
  18. package/.worktrees/jobqu-review/README.md +0 -176
  19. package/.worktrees/v2-asset-sources/LICENSE +0 -21
  20. package/.worktrees/v2-asset-sources/README.md +0 -30
  21. package/.worktrees/v2-asset-sources/examples/script-tag/README.md +0 -13
  22. package/.worktrees/v2-asset-sources/examples/vite/README.md +0 -13
  23. package/.worktrees/v2-asset-sources/packages/minerender/LICENSE +0 -21
  24. package/.worktrees/v2-asset-sources/packages/minerender/README.md +0 -24
  25. package/.worktrees/v2-brightness/LICENSE +0 -21
  26. package/.worktrees/v2-brightness/README.md +0 -30
  27. package/.worktrees/v2-brightness/examples/script-tag/README.md +0 -13
  28. package/.worktrees/v2-brightness/examples/vite/README.md +0 -13
  29. package/.worktrees/v2-brightness/packages/minerender/LICENSE +0 -21
  30. package/.worktrees/v2-brightness/packages/minerender/README.md +0 -24
  31. package/.worktrees/v2-cache-recovery/LICENSE +0 -21
  32. package/.worktrees/v2-cache-recovery/README.md +0 -30
  33. package/.worktrees/v2-cache-recovery/examples/script-tag/README.md +0 -13
  34. package/.worktrees/v2-cache-recovery/examples/vite/README.md +0 -13
  35. package/.worktrees/v2-cache-recovery/packages/minerender/LICENSE +0 -21
  36. package/.worktrees/v2-cache-recovery/packages/minerender/README.md +0 -24
  37. package/.worktrees/v2-ci-stack/LICENSE +0 -21
  38. package/.worktrees/v2-ci-stack/README.md +0 -109
  39. package/.worktrees/v2-ci-stack/examples/script-tag/README.md +0 -15
  40. package/.worktrees/v2-ci-stack/examples/vite/README.md +0 -15
  41. package/.worktrees/v2-ci-stack/packages/minerender/LICENSE +0 -21
  42. package/.worktrees/v2-ci-stack/packages/minerender/README.md +0 -11
  43. package/.worktrees/v2-ci-typescript/LICENSE +0 -21
  44. package/.worktrees/v2-ci-typescript/README.md +0 -11
  45. package/.worktrees/v2-controls/LICENSE +0 -21
  46. package/.worktrees/v2-controls/README.md +0 -30
  47. package/.worktrees/v2-controls/examples/script-tag/README.md +0 -13
  48. package/.worktrees/v2-controls/examples/vite/README.md +0 -13
  49. package/.worktrees/v2-controls/packages/minerender/LICENSE +0 -21
  50. package/.worktrees/v2-controls/packages/minerender/README.md +0 -24
  51. package/.worktrees/v2-dependencies/LICENSE +0 -21
  52. package/.worktrees/v2-dependencies/README.md +0 -30
  53. package/.worktrees/v2-dependencies/examples/script-tag/README.md +0 -13
  54. package/.worktrees/v2-dependencies/examples/vite/README.md +0 -13
  55. package/.worktrees/v2-dependencies/packages/minerender/LICENSE +0 -21
  56. package/.worktrees/v2-dependencies/packages/minerender/README.md +0 -24
  57. package/.worktrees/v2-frame-limit/LICENSE +0 -21
  58. package/.worktrees/v2-frame-limit/README.md +0 -30
  59. package/.worktrees/v2-frame-limit/examples/script-tag/README.md +0 -13
  60. package/.worktrees/v2-frame-limit/examples/vite/README.md +0 -13
  61. package/.worktrees/v2-frame-limit/packages/minerender/LICENSE +0 -21
  62. package/.worktrees/v2-frame-limit/packages/minerender/README.md +0 -24
  63. package/.worktrees/v2-images/LICENSE +0 -21
  64. package/.worktrees/v2-images/README.md +0 -30
  65. package/.worktrees/v2-images/examples/script-tag/README.md +0 -13
  66. package/.worktrees/v2-images/examples/vite/README.md +0 -13
  67. package/.worktrees/v2-images/packages/minerender/LICENSE +0 -21
  68. package/.worktrees/v2-images/packages/minerender/README.md +0 -24
  69. package/.worktrees/v2-lifecycle/LICENSE +0 -21
  70. package/.worktrees/v2-lifecycle/README.md +0 -30
  71. package/.worktrees/v2-lifecycle/examples/script-tag/README.md +0 -13
  72. package/.worktrees/v2-lifecycle/examples/vite/README.md +0 -13
  73. package/.worktrees/v2-lifecycle/packages/minerender/LICENSE +0 -21
  74. package/.worktrees/v2-lifecycle/packages/minerender/README.md +0 -24
  75. package/.worktrees/v2-main-conflicts/LICENSE +0 -21
  76. package/.worktrees/v2-main-conflicts/README.md +0 -11
  77. package/.worktrees/v2-monorepo/LICENSE +0 -21
  78. package/.worktrees/v2-monorepo/README.md +0 -30
  79. package/.worktrees/v2-monorepo/examples/script-tag/README.md +0 -13
  80. package/.worktrees/v2-monorepo/examples/vite/README.md +0 -13
  81. package/.worktrees/v2-monorepo/packages/minerender/LICENSE +0 -21
  82. package/.worktrees/v2-monorepo/packages/minerender/README.md +0 -24
  83. package/.worktrees/v2-requests/LICENSE +0 -21
  84. package/.worktrees/v2-requests/README.md +0 -30
  85. package/.worktrees/v2-requests/examples/script-tag/README.md +0 -13
  86. package/.worktrees/v2-requests/examples/vite/README.md +0 -13
  87. package/.worktrees/v2-requests/packages/minerender/LICENSE +0 -21
  88. package/.worktrees/v2-requests/packages/minerender/README.md +0 -26
  89. package/.worktrees/v2-source-errors/LICENSE +0 -21
  90. package/.worktrees/v2-source-errors/README.md +0 -30
  91. package/.worktrees/v2-source-errors/examples/script-tag/README.md +0 -13
  92. package/.worktrees/v2-source-errors/examples/vite/README.md +0 -13
  93. package/.worktrees/v2-source-errors/packages/minerender/LICENSE +0 -21
  94. package/.worktrees/v2-source-errors/packages/minerender/README.md +0 -26
@@ -1,109 +0,0 @@
1
- # MineRender V2
2
-
3
- Interactive Minecraft renders for browsers and Node.js. This Yarn workspace contains the
4
- `minerender` library, its demo pages, and examples of package and script-tag usage.
5
- V2 is in alpha; [ROADMAP.md](./ROADMAP.md) tracks feature parity and remaining work.
6
-
7
- ## Develop locally
8
-
9
- Use Node.js 22 or 24 with Corepack, then run these commands from the repository root:
10
-
11
- ```sh
12
- corepack enable
13
- yarn install --immutable
14
- yarn build
15
- yarn typecheck
16
- yarn test
17
- ```
18
-
19
- The repository pins Yarn 4.5.3. Install dependencies at the root; workspaces resolve the local
20
- library through `workspace:*`. The library must be built before consumers can resolve its exports.
21
-
22
- | Workspace | Purpose | Start locally |
23
- |---|---|---|
24
- | `packages/minerender` | Public npm package; browser, Node, and IIFE outputs | `yarn build:watch` |
25
- | `apps/web` | Existing demo and manual test pages | `yarn dev:web` |
26
- | `examples/vite` | Vue/Vite consumer with resource-pack ZIP input | `yarn dev:vite` |
27
- | `examples/script-tag` | Plain HTML consuming `window.MineRender` | `yarn dev:script-tag` |
28
-
29
- The `dev:*` commands build the library before starting their local server. The web demos use
30
- port 3000, Vite uses port 5175, and the script-tag example uses port 5174. For library changes,
31
- run `yarn build:watch` in another terminal and reload the consumer. Restart the script-tag server
32
- to copy the updated bundle. Examples fetch Minecraft assets from external services.
33
-
34
- `yarn build:lib` builds only the library. `yarn build:consumers` builds the demos and examples
35
- against the existing library output. `yarn typecheck` checks the library and Vue example;
36
- `yarn test` runs the existing AVA tests. `yarn doc` writes API documentation to
37
- `packages/minerender/docs/`.
38
-
39
- Enable renderer-owned OrbitControls at construction:
40
-
41
- ```ts
42
- const renderer = new Renderer({ controls: { enabled: true } });
43
- if (renderer.controls) {
44
- renderer.controls.enableDamping = true;
45
- }
46
- ```
47
-
48
- Controls use `camera.lookingAt` as their initial orbit target. While the renderer runs, it updates
49
- damping and auto-rotation before deciding whether to redraw. Configure these behaviors through
50
- `renderer.controls`. Controls are off by default; existing manual controls remain supported.
51
-
52
- Set `render.fpsLimit` at construction to limit drawing (60 FPS by default). Zero or a negative
53
- value disables the limit. Idle scenes still wait for a change unless `render.renderAlways` is
54
- enabled. Controls update on every animation callback, including callbacks that skip drawing.
55
-
56
- Rendering uses sRGB output in both composer and direct mode. MineRender's image textures and
57
- canvas atlases are tagged as sRGB; its model shader applies shading in linear light before
58
- converting the result for display. See [Three.js color management](https://threejs.org/manual/pages/color-management.html).
59
-
60
- Use `renderer.stop()` to pause rendering and `renderer.start()` to resume. When a renderer is
61
- no longer needed, call `renderer.dispose()` to remove its canvas, stats, and listeners and release
62
- its rendering resources and built-in controls. Disposal is final and safe to repeat. Dispose caller-owned controls
63
- separately; scene objects are detached without disposing their shared geometry, materials, or textures.
64
-
65
- `AssetLoader.addSource()` gives the added source highest priority. `AssetLoader.get()` tries a
66
- snapshot of that order one source at a time and returns the first defined asset unchanged.
67
- Resource-pack files replace lower-priority files as a whole; model-parent inheritance is separate.
68
- `getAll()` still collects results from every source. A rejecting source rejects the lookup.
69
-
70
- Each hosted source keeps its namespace/root retry behavior. For strict source layering, create
71
- `HostedAssetSource` with `{ retryDefaults: false }`. Cache generation 2 uses fresh persistent
72
- stores so old source-merged assets are not reused; legacy stores are left untouched.
73
-
74
- Image decoding uses the bytes already fetched for URL and resource-pack textures; `ImageInfo.src`
75
- is optional provenance. Async `ImageLoader` methods reject failed requests, invalid dimensions,
76
- and decode errors instead of returning 0×0 placeholders. Failed loads can be retried. The synchronous
77
- `Textures.getImage()` and `Materials.getImage()` methods return a fresh placeholder on the next
78
- lookup after a failure; existing scene objects need the replacement texture or material assigned.
79
-
80
- Item/blockstate lists, default blockstates, and entity model dictionaries share concurrent loads
81
- and cache successful responses. Missing or rejected loads can retry on the next call; valid empty
82
- lists remain cached. After replacing asset sources, use `Caching.clear()` to reset in-memory
83
- caches, including these lookups. Persistent stores are cleared separately. `PersistentCache.getOrLoad()`
84
- skips writes for `null` and `undefined`, while preserving other values.
85
-
86
- The optional `canvas` dependency requires a working native installation for Node imports.
87
- Browser development can proceed if its native build fails. Actual headless rendering still
88
- requires the renderer work described in the roadmap.
89
-
90
- ## Package and compatibility
91
-
92
- Only `packages/minerender` is publishable. Its npm name remains `minerender`, with browser/Node
93
- conditional exports, ESM and CommonJS entries, and the standalone `dist/bundle.js` script.
94
- To inspect the distributable without publishing:
95
-
96
- ```sh
97
- yarn workspace minerender pack --out /tmp/minerender.tgz
98
- ```
99
-
100
- Maintainers can release with `yarn publish:alpha`. It builds the library, increments the alpha
101
- version through Yarn, and publishes with the registry tag `alpha`. Version changes remain in
102
- the working tree; create the release commit and Git tag separately.
103
-
104
- The root website files, generated `docs/`, and legacy assets are retained for compatibility.
105
- They are separate from the workspace builds. The V1 website and its GitHub CDN paths remain
106
- in place while V2 is developed. Source revisions and branch findings are recorded in
107
- [ROADMAP.md](./ROADMAP.md#monorepo-migration--2026-10-03).
108
-
109
- See [AGENTS.md](./AGENTS.md) for architecture and contributor conventions.
@@ -1,15 +0,0 @@
1
- # MineRender script-tag example
2
-
3
- This page loads the library's IIFE bundle through one script tag and uses the `MineRender` global. It renders a skin and a diamond sword with orbit controls. The bundle includes three.js and `OrbitControls`.
4
-
5
- From the repository root:
6
-
7
- 1. Install dependencies with `yarn install`.
8
- 2. Build the library with `yarn workspace minerender build`.
9
- 3. Run `yarn workspace @minerender/example-script-tag dev`, then open `http://127.0.0.1:5174`.
10
-
11
- Run `yarn workspace @minerender/example-script-tag build` to copy the page and library bundle into `examples/script-tag/dist`. You can serve that directory with any static web server. The page fetches Minecraft assets over HTTPS.
12
-
13
- After editing the page or rebuilding the library, restart the development server to copy the updated files.
14
-
15
- The example replaces the library's default vanilla source with `https://assets.mcasset.cloud/1.17.1`; the library's older default URL is retained until the asset-pipeline work.
@@ -1,15 +0,0 @@
1
- # MineRender Vite example
2
-
3
- This Vue example uses ESM imports from the `minerender` workspace. It renders a skin, a diamond sword, and a stone block. Select a resource-pack ZIP to override their vanilla assets.
4
-
5
- From the repository root:
6
-
7
- 1. Install dependencies with `yarn install`.
8
- 2. Build the library with `yarn workspace minerender build`.
9
- 3. Start the example with `yarn workspace @minerender/example-vite dev`, then open `http://127.0.0.1:5175`.
10
-
11
- Run `yarn workspace @minerender/example-vite build` to typecheck the example and generate `examples/vite/dist`. Rebuild the library after changing its source.
12
-
13
- The example fetches Minecraft assets over HTTPS. It keeps the Node polyfill plugin because the library's asset loaders include the NBT parser, which uses `zlib`.
14
-
15
- The example replaces the library's default vanilla source with `https://assets.mcasset.cloud/1.17.1`; the library's older default URL is retained until the asset-pipeline work.
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2018 Haylee Schäfer
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
@@ -1,11 +0,0 @@
1
- [![Build Status](https://travis-ci.org/InventivetalentDev/MineRender.svg?branch=master)](https://travis-ci.org/InventivetalentDev/MineRender)
2
- [![Documentation Coverage](https://docs.minerender.org/badge.svg)](https://docs.minerender.org)
3
-
4
-
5
- ![MineRender](https://minerender.org/img/minerender-x128.png)
6
-
7
- # MineRender
8
- ## Quick, Easy, Interactive 3D/2D Renders of Minecraft
9
-
10
-
11
- [MineRender.org](https://minerender.org/)
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2018 Haylee Schäfer
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
@@ -1,11 +0,0 @@
1
- [![Build Status](https://travis-ci.org/InventivetalentDev/MineRender.svg?branch=master)](https://travis-ci.org/InventivetalentDev/MineRender)
2
- [![Documentation Coverage](https://docs.minerender.org/badge.svg)](https://docs.minerender.org)
3
-
4
-
5
- ![MineRender](https://minerender.org/img/minerender-x128.png)
6
-
7
- # MineRender
8
- ## Quick, Easy, Interactive 3D/2D Renders of Minecraft
9
-
10
-
11
- [MineRender.org](https://minerender.org/)
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2018 Haylee Schäfer
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
@@ -1,30 +0,0 @@
1
- # MineRender V2
2
-
3
- A TypeScript library for rendering Minecraft skins, models, blocks, entities, and worlds.
4
- This monorepo contains the `minerender` package, demo pages, and examples.
5
- V2 is in alpha; see [ROADMAP.md](./ROADMAP.md) for progress and remaining work,
6
- including headless Node rendering.
7
-
8
- ## Develop locally
9
-
10
- Use Node.js 22+ and Yarn 4.5.3 through Corepack. Run these commands from the repository root:
11
-
12
- ```sh
13
- corepack enable
14
- yarn install --immutable
15
- yarn build
16
- ```
17
-
18
- Choose a workspace to work on:
19
-
20
- | Workspace | Purpose | Development command |
21
- |---|---|---|
22
- | [packages/minerender](./packages/minerender) | Public library | `yarn build:watch` |
23
- | [apps/web](./apps/web) | Demo and manual test pages | `yarn dev:web` |
24
- | [examples/vite](./examples/vite) | Vue/Vite example | `yarn dev:vite` |
25
- | [examples/script-tag](./examples/script-tag) | Plain HTML example | `yarn dev:script-tag` |
26
-
27
- The `dev:*` commands build the library before starting their server.
28
- Run `yarn typecheck` and `yarn test` to check your changes.
29
-
30
- See [AGENTS.md](./AGENTS.md) for architecture, contributor conventions, and publishing instructions.
@@ -1,13 +0,0 @@
1
- # MineRender script-tag example
2
-
3
- This page loads the library's IIFE bundle through one script tag and uses the `MineRender` global. It renders a skin and a diamond sword with orbit controls. The bundle includes three.js and `OrbitControls`.
4
-
5
- From the repository root:
6
-
7
- 1. Install dependencies with `yarn install`.
8
- 2. Build the library with `yarn workspace minerender build`.
9
- 3. Run `yarn workspace @minerender/example-script-tag dev`, then open `http://127.0.0.1:5174`.
10
-
11
- Run `yarn workspace @minerender/example-script-tag build` to copy the page and library bundle into `examples/script-tag/dist`. You can serve that directory with any static web server. The page fetches Minecraft assets over HTTPS.
12
-
13
- After editing the page or rebuilding the library, restart the development server to copy the updated files.
@@ -1,13 +0,0 @@
1
- # MineRender Vite example
2
-
3
- This Vue example uses ESM imports from the `minerender` workspace. It renders a skin, a diamond sword, and a stone block. Select a resource-pack ZIP to override their vanilla assets.
4
-
5
- From the repository root:
6
-
7
- 1. Install dependencies with `yarn install`.
8
- 2. Build the library with `yarn workspace minerender build`.
9
- 3. Start the example with `yarn workspace @minerender/example-vite dev`, then open `http://127.0.0.1:5175`.
10
-
11
- Run `yarn workspace @minerender/example-vite build` to typecheck the example and generate `examples/vite/dist`. Rebuild the library after changing its source.
12
-
13
- The example fetches Minecraft assets over HTTPS. It keeps the Node polyfill plugin because the library's asset loaders include the NBT parser, which uses `zlib`.
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2018 Haylee Schäfer
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
@@ -1,24 +0,0 @@
1
- # MineRender V2
2
-
3
- A TypeScript library for interactive Minecraft skins, models, blocks, entities, and worlds.
4
- V2 is in alpha. See the [roadmap](https://github.com/InventivetalentDev/MineRender/blob/main/ROADMAP.md) for feature parity and remaining work.
5
-
6
- Install the alpha package with its three.js peer:
7
-
8
- ```sh
9
- yarn add minerender@alpha three@^0.158.0
10
- ```
11
-
12
- In a browser application:
13
-
14
- ```ts
15
- import { Renderer } from "minerender";
16
-
17
- const renderer = new Renderer();
18
- renderer.appendTo(document.body);
19
- renderer.start();
20
- ```
21
-
22
- The package provides ESM and CommonJS entries for browsers and Node.js, plus
23
- `dist/bundle.js` for the `MineRender` browser global. Node imports require the optional
24
- native `canvas` dependency; headless rendering is still in development.
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2018 Haylee Schäfer
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
@@ -1,30 +0,0 @@
1
- # MineRender V2
2
-
3
- A TypeScript library for rendering Minecraft skins, models, blocks, entities, and worlds.
4
- This monorepo contains the `minerender` package, demo pages, and examples.
5
- V2 is in alpha; see [ROADMAP.md](./ROADMAP.md) for progress and remaining work,
6
- including headless Node rendering.
7
-
8
- ## Develop locally
9
-
10
- Use Node.js 22+ and Yarn 4.5.3 through Corepack. Run these commands from the repository root:
11
-
12
- ```sh
13
- corepack enable
14
- yarn install --immutable
15
- yarn build
16
- ```
17
-
18
- Choose a workspace to work on:
19
-
20
- | Workspace | Purpose | Development command |
21
- |---|---|---|
22
- | [packages/minerender](./packages/minerender) | Public library | `yarn build:watch` |
23
- | [apps/web](./apps/web) | Demo and manual test pages | `yarn dev:web` |
24
- | [examples/vite](./examples/vite) | Vue/Vite example | `yarn dev:vite` |
25
- | [examples/script-tag](./examples/script-tag) | Plain HTML example | `yarn dev:script-tag` |
26
-
27
- The `dev:*` commands build the library before starting their server.
28
- Run `yarn typecheck` and `yarn test` to check your changes.
29
-
30
- See [AGENTS.md](./AGENTS.md) for architecture, contributor conventions, and publishing instructions.
@@ -1,13 +0,0 @@
1
- # MineRender script-tag example
2
-
3
- This page loads the library's IIFE bundle through one script tag and uses the `MineRender` global. It renders a skin and a diamond sword with orbit controls. The bundle includes three.js and `OrbitControls`.
4
-
5
- From the repository root:
6
-
7
- 1. Install dependencies with `yarn install`.
8
- 2. Build the library with `yarn workspace minerender build`.
9
- 3. Run `yarn workspace @minerender/example-script-tag dev`, then open `http://127.0.0.1:5174`.
10
-
11
- Run `yarn workspace @minerender/example-script-tag build` to copy the page and library bundle into `examples/script-tag/dist`. You can serve that directory with any static web server. The page fetches Minecraft assets over HTTPS.
12
-
13
- After editing the page or rebuilding the library, restart the development server to copy the updated files.
@@ -1,13 +0,0 @@
1
- # MineRender Vite example
2
-
3
- This Vue example uses ESM imports from the `minerender` workspace. It renders a skin, a diamond sword, and a stone block. Select a resource-pack ZIP to override their vanilla assets.
4
-
5
- From the repository root:
6
-
7
- 1. Install dependencies with `yarn install`.
8
- 2. Build the library with `yarn workspace minerender build`.
9
- 3. Start the example with `yarn workspace @minerender/example-vite dev`, then open `http://127.0.0.1:5175`.
10
-
11
- Run `yarn workspace @minerender/example-vite build` to typecheck the example and generate `examples/vite/dist`. Rebuild the library after changing its source.
12
-
13
- The example fetches Minecraft assets over HTTPS. It keeps the Node polyfill plugin because the library's asset loaders include the NBT parser, which uses `zlib`.
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2018 Haylee Schäfer
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
@@ -1,24 +0,0 @@
1
- # MineRender V2
2
-
3
- A TypeScript library for interactive Minecraft skins, models, blocks, entities, and worlds.
4
- V2 is in alpha. See the [roadmap](https://github.com/InventivetalentDev/MineRender/blob/main/ROADMAP.md) for feature parity and remaining work.
5
-
6
- Install the alpha package with its three.js peer:
7
-
8
- ```sh
9
- yarn add minerender@alpha three@^0.158.0
10
- ```
11
-
12
- In a browser application:
13
-
14
- ```ts
15
- import { Renderer } from "minerender";
16
-
17
- const renderer = new Renderer();
18
- renderer.appendTo(document.body);
19
- renderer.start();
20
- ```
21
-
22
- The package provides ESM and CommonJS entries for browsers and Node.js, plus
23
- `dist/bundle.js` for the `MineRender` browser global. Node imports require the optional
24
- native `canvas` dependency; headless rendering is still in development.
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2018 Haylee Schäfer
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
@@ -1,30 +0,0 @@
1
- # MineRender V2
2
-
3
- A TypeScript library for rendering Minecraft skins, models, blocks, entities, and worlds.
4
- This monorepo contains the `minerender` package, demo pages, and examples.
5
- V2 is in alpha; see [ROADMAP.md](./ROADMAP.md) for progress and remaining work,
6
- including headless Node rendering.
7
-
8
- ## Develop locally
9
-
10
- Use Node.js 22+ and Yarn 4.5.3 through Corepack. Run these commands from the repository root:
11
-
12
- ```sh
13
- corepack enable
14
- yarn install --immutable
15
- yarn build
16
- ```
17
-
18
- Choose a workspace to work on:
19
-
20
- | Workspace | Purpose | Development command |
21
- |---|---|---|
22
- | [packages/minerender](./packages/minerender) | Public library | `yarn build:watch` |
23
- | [apps/web](./apps/web) | Demo and manual test pages | `yarn dev:web` |
24
- | [examples/vite](./examples/vite) | Vue/Vite example | `yarn dev:vite` |
25
- | [examples/script-tag](./examples/script-tag) | Plain HTML example | `yarn dev:script-tag` |
26
-
27
- The `dev:*` commands build the library before starting their server.
28
- Run `yarn typecheck` and `yarn test` to check your changes.
29
-
30
- See [AGENTS.md](./AGENTS.md) for architecture, contributor conventions, and publishing instructions.
@@ -1,13 +0,0 @@
1
- # MineRender script-tag example
2
-
3
- This page loads the library's IIFE bundle through one script tag and uses the `MineRender` global. It renders a skin and a diamond sword with orbit controls. The bundle includes three.js and `OrbitControls`.
4
-
5
- From the repository root:
6
-
7
- 1. Install dependencies with `yarn install`.
8
- 2. Build the library with `yarn workspace minerender build`.
9
- 3. Run `yarn workspace @minerender/example-script-tag dev`, then open `http://127.0.0.1:5174`.
10
-
11
- Run `yarn workspace @minerender/example-script-tag build` to copy the page and library bundle into `examples/script-tag/dist`. You can serve that directory with any static web server. The page fetches Minecraft assets over HTTPS.
12
-
13
- After editing the page or rebuilding the library, restart the development server to copy the updated files.
@@ -1,13 +0,0 @@
1
- # MineRender Vite example
2
-
3
- This Vue example uses ESM imports from the `minerender` workspace. It renders a skin, a diamond sword, and a stone block. Select a resource-pack ZIP to override their vanilla assets.
4
-
5
- From the repository root:
6
-
7
- 1. Install dependencies with `yarn install`.
8
- 2. Build the library with `yarn workspace minerender build`.
9
- 3. Start the example with `yarn workspace @minerender/example-vite dev`, then open `http://127.0.0.1:5175`.
10
-
11
- Run `yarn workspace @minerender/example-vite build` to typecheck the example and generate `examples/vite/dist`. Rebuild the library after changing its source.
12
-
13
- The example fetches Minecraft assets over HTTPS. It keeps the Node polyfill plugin because the library's asset loaders include the NBT parser, which uses `zlib`.
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2018 Haylee Schäfer
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
@@ -1,24 +0,0 @@
1
- # MineRender V2
2
-
3
- A TypeScript library for interactive Minecraft skins, models, blocks, entities, and worlds.
4
- V2 is in alpha. See the [roadmap](https://github.com/InventivetalentDev/MineRender/blob/main/ROADMAP.md) for feature parity and remaining work.
5
-
6
- Install the alpha package with its three.js peer:
7
-
8
- ```sh
9
- yarn add minerender@alpha three@^0.158.0
10
- ```
11
-
12
- In a browser application:
13
-
14
- ```ts
15
- import { Renderer } from "minerender";
16
-
17
- const renderer = new Renderer();
18
- renderer.appendTo(document.body);
19
- renderer.start();
20
- ```
21
-
22
- The package provides ESM and CommonJS entries for browsers and Node.js, plus
23
- `dist/bundle.js` for the `MineRender` browser global. Node imports require the optional
24
- native `canvas` dependency; headless rendering is still in development.
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2018 Haylee Schäfer
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.