JollyPixel

Monorepo for the collaborative 3D HTML5 game maker

Requirements

• Node.js version 24 or higher
• npm v7+ for workspaces

Available packages

Click on one of the links to access the documentation of the package:

• @jolly-pixel/engine - ECS framework on top of Three.js
• @jolly-pixel/runtime - Runtime for the engine / ECS
• @jolly-pixel/network - The shared wire for JollyPixel's multiplayer editors
• @jolly-pixel/voxel.renderer - Voxel Engine and Renderer
• @jolly-pixel/pixel-draw.renderer - Pixel Art draw renderer
• @jolly-pixel/fs-tree - Robust, stylable tree view widget for HTML5 apps with drag'n'drop support
• @jolly-pixel/resize-handle - Robust resize handles / splitters for your HTML5 apps and websites

These packages are available in the Node Package Repository and can be easily installed with npm or yarn.

$ npm i @jolly-pixel/engine
# or
$ yarn add @jolly-pixel/engine

Available editors

• Voxel Map: 3D Voxel Terrain editor
• Voxel Model: Low-poly/voxel 3D model editor

Build

To install and compile all workspaces, just run the following command at the root

$ npm install
$ npm run build

Test

Running test with npm workspace:

$ npm run test -w <workspace>

Linter

Running ESLint for all workspaces

$ npm run lint

Publishing package

Each packages has his own prepublishOnly to build TypeScript source before publishing.

$ npm publish -w <workspace>

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Thomas.G 💻 📖 🐛 ⚠️ 🛡️

Alexandre Malaj 💻 📖 🐛

PierreDemailly 💻

Clement Gombauld 💻

License

MIT