minerender 2.1.0-alpha.0 → 2.1.0-alpha.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 (94) hide show
  1. package/README.md +0 -2
  2. package/dist/browser/index.d.mts +1 -1
  3. package/dist/browser/index.d.ts +1 -1
  4. package/dist/browser/index.js +5 -5
  5. package/dist/browser/index.js.map +1 -1
  6. package/dist/browser/index.mjs +5 -5
  7. package/dist/browser/index.mjs.map +1 -1
  8. package/dist/bundle.js +490 -490
  9. package/dist/bundle.js.map +1 -1
  10. package/dist/node/index.d.mts +1 -1
  11. package/dist/node/index.d.ts +1 -1
  12. package/dist/node/index.js +5 -5
  13. package/dist/node/index.js.map +1 -1
  14. package/dist/node/index.mjs +5 -5
  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,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,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,26 +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.
25
-
26
- Requires Node.js 22+ or a browser with Fetch, `AbortSignal.any()`, and `AbortSignal.timeout()`.
@@ -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.