Workspaces are grouped by sub-domain. Each arrow shows what one sub-domain provides to another.
Note
Every workspace name below drops the @jolly-pixel/ scope: network is @jolly-pixel/network.
- network - Rooms, peers and state sync for the collaborative editors
- accounts - User accounts and session tokens for JollyPixel servers
- history - Command documents and per-person undo history that survives collaboration
- studio - One project, its assets and one editor per tab
- server - A project's assets, accounts and HTTP API, served to the studio
- editor.host - Shared launch, session and runtime boot for the editors
- preferences - Preference scopes, validation and overrides for the studio and the editors
Each editor is an editor.<name> workspace, and the formats it owns (the asset kinds it reads and writes, and that asset-server stores) live in asset.<name> workspaces linked from each extension. Editors also read the formats their documents link, such as the .pixelart textures used by voxel maps and models.
- Voxel map - Voxel-terrain editor for
.voxelmap.jsonworlds and.blockset.jsonblocksets - Voxel model - Low-polygon 3D model editor for
.voxelmodel.jsonmodels and.voxelanim.jsonanimation sets - Pixel art - Pixel-art texture editor for
.pixelarttextures, built onpixel-draw.renderer - Terrain 🚧 - Heightfield terrain editor for
.terrain.jsonterrains - Scene 🚧 - Actors, components and environment, saved as
.scene.jsonscenes - Sound 🚧 - Plays and loops
.oggsounds converted from dropped audio files - Model 🚧 - Read-only viewer that previews
.glb,.gltf,.fbxand.objmodels and plays their animations - Texture 🚧 - Read-only viewer for
.png,.jpg,.webp,.gifand.bmpimages; shows the header of.ktx2textures - Script 🚧 - Collaborative code editor for
.tsand.jsscripts, whose behaviors and scene properties feed the scene's Script component
- ui - Design system (declarative UI components and a facade API)
- resize-handle - Resize handles and splitters
- console - Command palette and developer console for the editors
- lantern - Guided tours for the editors
- asset - Asset references, catalogs and loading orchestration for browser and Node.js
- asset-server - Event-sourced asset projection, reconciliation and catalog delivery
- asset-source - Physical asset storage (filesystem, memory, IndexedDB)
- event-store - Append-only event log (event sourcing)
Planned. It will turn a project's assets into the catalog manifest the runtime loads.
- runtime - Game runtime for web browsers and Electron
- engine - Minimal ECS framework on top of Three.js
- loop - Frame scheduling and time primitives (FrameScheduler, GameLoop)
- controls - Input controls (screen, mouse, touchpad, keyboard, gamepad)
- scripting - Compiles, outlines and loads the game's TypeScript scripts and TSL shaders
- physics - Engine-neutral physics contract and engine components (PhysicsSystem, RigidBody)
- physics.rapier - Rapier backend for physics
- voxel.renderer - Voxel engine and renderer
- terrain.renderer - Heightfield terrain engine and renderer 🚧
- pixel-draw.renderer - Pixel-art canvas drawing and rendering
Generic packages used by more than one sub-domain.
- three - Three.js components and utilities (grid, transform controls, selection highlight...)
- color - Color parsing, palettes, color spaces and conversions
- image - PNG codecs and browser raster decoding
- utils - Small standalone helpers
- bench - Benchmarking harness and CLI
- cdp - Chrome DevTools Protocol recording, page probes and profile readers for perf harnesses
- e2e - Playwright config, locators and editor fixtures for e2e suites
- golem - Connects a local AI agent to a running JollyPixel studio as a peer
- golem-kit - The contract an asset package implements to give golems intent methods for its kind
Public packages are published on npm and can be installed with npm or yarn. The studio, editors, formats, tooling and 🚧 renderers are private workspaces.
$ npm i @jolly-pixel/engine
# or
$ yarn add @jolly-pixel/engineTo install and compile all workspaces, just run the following command at the root
$ pnpm install
$ pnpm run buildstudio is the full application
$ pnpm --filter @jolly-pixel/studio devRun tests for one workspace, then run the repository type checks:
$ pnpm --filter <workspace> test
$ pnpm run typecheckLint all workspaces with oxlint (the script also checks package exports and CSS):
$ pnpm run lintEach public package has its own prepublishOnly script that builds the TypeScript source before publishing.
$ pnpm publish --filter <workspace>Thanks goes to these wonderful people (emoji key):
Thomas.G 💻 📖 🐛 |
Alexandre Malaj 💻 📖 🐛 |
PierreDemailly 💻 |
Clement Gombauld 💻 |
MIT