A TypeScript library for rendering Minecraft skins, models, blocks, entities, and worlds.
This monorepo contains the minerender package, demo pages, and examples.
V2 is in beta; see ROADMAP.md for progress and remaining work,
including headless Node rendering.
Use Node.js 22.12+ and Yarn 4.5.3 through Corepack. Run these commands from the repository root:
corepack enable
yarn install --immutable
yarn buildChoose a workspace to work on:
| Workspace | Purpose | Development command |
|---|---|---|
| packages/minerender | Public library | yarn build:watch |
| apps/web | Demo and manual test pages | yarn dev:web |
| apps/site | V2 website with live examples and docs | yarn dev:site |
| examples/vite | Vue/Vite example | yarn dev:vite |
| examples/script-tag | Plain HTML example | yarn dev:script-tag |
The dev:* commands build the library before starting their server.
Run yarn typecheck and yarn test to check your changes.
Run yarn doc to build the API reference into packages/minerender/docs/, or
yarn doc:dev for a live preview. Hand-written pages live in packages/minerender/reference/.
See AGENTS.md for architecture, contributor conventions, and publishing instructions.
- Andre601 for the V2 logo