@bitbybit-dev/playcanvas
v1.1.1
Published
Bit By Bit Developers PlayCanvas CAD Library to Program Geometry
Maintainers
Readme
@bitbybit-dev/playcanvas
PlayCanvas game engine integration for Bitbybit - draw and interact with CAD geometry from OCCT, JSCAD, and Manifold kernels directly in your PlayCanvas applications.
Overview
This package connects Bitbybit's powerful CAD kernels to the PlayCanvas rendering engine. It includes playcanvas as a dependency, so you don't need to install PlayCanvas separately. Create parametric 3D models with professional CAD operations and render them with PlayCanvas's high-performance WebGL engine.
Quick Start
The fastest way to scaffold a PlayCanvas + Bitbybit project:
npx @bitbybit-dev/create-app my-project --engine playcanvas
cd my-project
npm install
npm run devThis creates a complete Vite + TypeScript project with all three CAD kernels (OCCT, JSCAD, Manifold) pre-configured and rendering through PlayCanvas. Learn more about the CLI.
Need Server-Side CAD?
The CLI first asks you to choose between a Frontend app or a CAD Cloud app. Select "cloud" to scaffold a full-stack project with a backend (Hono on Cloudflare Workers, Node.js Express, or ASP.NET Core) and a React + Three.js frontend. Your API key stays on the server and the frontend proxies requests through your backend:
npx @bitbybit-dev/create-app my-cloud-project --type cloudChoose from 5 backend templates: Hono + SDK, Hono + REST, Node.js + SDK, Node.js + REST, or .NET + REST. Each includes ready-to-run examples with model generation, batch operations, and CAD pipelines. Learn more.
Learn
| Topic | Link | |-------|------| | Quick Start Tutorial | https://learn.bitbybit.dev/learn/npm-packages/playcanvas/start-with-playcanvas | | About PlayCanvas Integration | https://learn.bitbybit.dev/learn/npm-packages/playcanvas/about-playcanvas | | Advanced Parametric Model | https://learn.bitbybit.dev/learn/npm-packages/playcanvas/advanced-parametric-3d-model | | Hex House Concept | https://learn.bitbybit.dev/learn/npm-packages/playcanvas/hex-house-concept | | PlayCanvas Engine Setup | https://learn.bitbybit.dev/learn/getting-started/engines/playcanvas | | AI-Assisted Development | https://learn.bitbybit.dev/learn/using-ai-with-bitbybit/intro |
Links
| Resource | URL | |----------|-----| | GitHub | https://github.com/bitbybit-dev/bitbybit/tree/master/packages/dev/playcanvas | | Monorepo | https://github.com/bitbybit-dev/bitbybit | | NPM | https://www.npmjs.com/package/@bitbybit-dev/playcanvas | | Documentation | https://learn.bitbybit.dev/learn/npm-packages/playcanvas/start-with-playcanvas | | Unit Test Coverage | https://tests.bitbybit.dev/playcanvas |
Example Applications
| App | Source Code | |-----|-------------| | Hex Shell | GitHub | | Starter Template | GitHub | | Terrace Furniture (BabylonJS) | Closed source |
Development
# Build package
npm run build-p
# Run unit tests with coverage
npm run test-c
# Run live unit tests with coverage on save
npm run test-c-lBitbybit Platform
Beyond NPM packages, Bitbybit offers:
- Visual Programming Editors - Rete & Blockly drag-and-drop 3D modeling, plus a Monaco TypeScript editor
- CAD Cloud API - Build full pipelines that compose all Bitbybit algorithms, where each step can reference outputs of previous steps. Supports parametric model generation, STEP-to-glTF conversion, and complex CAD workflows via HTTP
- Bitbybit Studio - A growing visual dashboard where API Key users can generate models, convert files, build pipelines with a GUI, inspect tasks, and preview 3D results
- 3D Bits for Shopify - Interactive 3D product configurators for e-commerce
- Script Runners - Execute visual scripts directly on your website
- AI-Assisted Development - Context files for GitHub Copilot, Claude, and ChatGPT
- Business & Enterprise - We help businesses and enterprises develop custom applications and spin up optimized CAD tenant workflows on our managed servers
Support the Project
This package is part of the open-source Bitbybit ecosystem. Your subscription helps fund continued development.
⭐ Subscribe - Silver or Gold plan | Get API Key for CAD Cloud
Community
Major Dependencies
PlayCanvas, OpenCascade, JSCAD, Manifold, Verbnurbs
License
MIT © Bit By Bit Developers
