# Bitbybit Platform

> Bitbybit is a web-based 3D creative coding platform for building parametric models, product configurators, and CAD applications directly in the browser. Build once, run anywhere—no installation required.

Bitbybit enables designers and developers to create 3D geometry using visual programming (Rete node-based, Blockly block-based) or TypeScript code. The platform integrates with popular game engines (BabylonJS, Three.js, PlayCanvas) and provides open-source NPM packages for embedding 3D CAD functionality into custom web applications.

## Core Philosophy

- **Zero Installation**: Everything runs in the browser—no plugins, no downloads
- **Industrial CAD Power**: OpenCascade (OCCT) kernel for professional-grade precision
- **Export Anywhere**: STEP, STL, OBJ, GLTF exports for manufacturing, 3D printing, web
- **Open Source Core**: MIT-licensed NPM packages for full integration flexibility

## Main Site

- Homepage: https://bitbybit.dev
- TypeScript Editor: https://bitbybit.dev/app?editor=typescript
- Visual Programming (Rete): https://bitbybit.dev/app?editor=rete
- Visual Programming (Blockly): https://bitbybit.dev/app?editor=blockly
- 3D Models Library: https://bitbybit.dev/3d-models
- Sign Up: https://bitbybit.dev/auth/sign-up
- Pricing & Plans: https://bitbybit.dev/auth/pick-plan

## Documentation & Learning

- Documentation Site: https://learn.bitbybit.dev
- Welcome Guide: https://learn.bitbybit.dev/learn/intro
- Getting Started: https://learn.bitbybit.dev/learn/getting-started/overview
- TypeScript API Reference: https://docs.bitbybit.dev
- Blog: https://learn.bitbybit.dev/blog
- Open Source Approach: https://learn.bitbybit.dev/learn/open-source-approach

## NPM Packages

Bitbybit provides open-source NPM packages for integrating 3D CAD capabilities into web applications.

### Game Engine Integrations

These packages provide drawing, visualization, and scene management for each game engine:

- @bitbybit-dev/babylonjs: https://learn.bitbybit.dev/learn/npm-packages/babylonjs
  - NPM: https://www.npmjs.com/package/@bitbybit-dev/babylonjs
  - Full-featured WebGL engine with advanced PBR rendering, physics, and audio
  
- @bitbybit-dev/threejs: https://learn.bitbybit.dev/learn/npm-packages/threejs
  - NPM: https://www.npmjs.com/package/@bitbybit-dev/threejs
  - Lightweight and versatile 3D library with vast community ecosystem
  
- @bitbybit-dev/playcanvas: https://learn.bitbybit.dev/learn/npm-packages/playcanvas
  - NPM: https://www.npmjs.com/package/@bitbybit-dev/playcanvas
  - Professional-grade engine with online editor and collaboration tools

### Core Packages

- @bitbybit-dev/core: https://www.npmjs.com/package/@bitbybit-dev/core
  - Assembles various packages and provides additional features combining all CAD kernels
  
- @bitbybit-dev/base: https://www.npmjs.com/package/@bitbybit-dev/base
  - Base algorithms: vector math, transformations, utilities

### CAD Geometry Kernels

Main thread packages (blocking):

- @bitbybit-dev/occt: https://www.npmjs.com/package/@bitbybit-dev/occt
  - OpenCascade wrapper for industrial B-rep CAD operations
  
- @bitbybit-dev/jscad: https://www.npmjs.com/package/@bitbybit-dev/jscad
  - JSCAD wrapper for JavaScript-based CSG modeling
  
- @bitbybit-dev/manifold: https://www.npmjs.com/package/@bitbybit-dev/manifold
  - Manifold wrapper for fast mesh boolean operations

### Web Worker Packages (Non-blocking, Recommended)

These packages run geometry computations in web workers for non-blocking UI:

- @bitbybit-dev/occt-worker: https://www.npmjs.com/package/@bitbybit-dev/occt-worker
  - OpenCascade via web worker—asynchronous, non-blocking CAD operations
  
- @bitbybit-dev/jscad-worker: https://www.npmjs.com/package/@bitbybit-dev/jscad-worker
  - JSCAD via web worker—asynchronous CSG operations
  
- @bitbybit-dev/manifold-worker: https://www.npmjs.com/package/@bitbybit-dev/manifold-worker
  - Manifold via web worker—asynchronous mesh booleans

### Project Scaffolding

Quick Start CLI:
```
npx @bitbybit-dev/create-app my-project
```
Choose your game engine (BabylonJS, Three.js, or PlayCanvas) and start coding immediately.

## AI Integration

Bitbybit provides comprehensive AI coding assistance through context files and MCP integration. Bitbybit does not provide proprietary LLMs—instead, it integrates seamlessly with leading AI services.

### AI Prompt Context Files (v1.1.1)

Attach these files to your AI coding assistant for instant Bitbybit API knowledge.

#### Beginner Context (Monaco Editor)

For users coding in the online TypeScript editor at bitbybit.dev:

- Full Context (116k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v1.1.1/bitbybit-babylon-monaco-ai-context-v1.1.1.md

#### BabylonJS Context

For NPM package integration with BabylonJS:

- Full Context (116k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v1.1.1/bitbybit-babylon-ai-context-v1.1.1.md
- Lite Context (114k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v1.1.1/bitbybit-babylon-no-comment-min-ai-v1.1.1.md

#### Three.js Context

For NPM package integration with Three.js:

- Full Context (95k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v1.1.1/bitbybit-three-ai-context-v1.1.1.md
- Lite Context (82k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v1.1.1/bitbybit-three-no-comment-min-ai-v1.1.1.md

#### PlayCanvas Context

For NPM package integration with PlayCanvas:

- Full Context (94k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v1.1.1/bitbybit-playcanvas-ai-context-v1.1.1.md
- Lite Context (82k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v1.1.1/bitbybit-playcanvas-no-comment-min-ai-v1.1.1.md

### Model Context Protocol (MCP)

Context7 MCP provides live AI context integration with always up-to-date documentation. Works with Claude, Gemini, Grok, and other MCP-compatible AI assistants.

- Context7 Integration Guide: https://learn.bitbybit.dev/learn/using-ai-with-bitbybit/mcp/context-7
- Context7 Library: https://context7.com/bitbybit-dev/bitbybit

MCP Setup (VS Code):
```json
{
    "servers": [
        {
            "command": "npx",
            "args": ["-y", "@upstash/context7-mcp@latest"],
            "env": {
                "DEFAULT_MINIMUM_TOKENS": "10000"
            }
        }
    ]
}
```

### AI Documentation

- Using AI with Bitbybit: https://learn.bitbybit.dev/learn/using-ai-with-bitbybit/intro

## Geometry Kernels

Bitbybit supports multiple CAD kernels for different use cases:

### OpenCascade (OCCT)

Industrial-grade B-rep kernel for precise CAD operations:
- Boundary representation (B-rep) for exact geometry
- Boolean operations (union, difference, intersection)
- Fillets, chamfers, shell, offset operations
- STEP/IGES import/export for CAD interoperability
- Sweeps, lofts, pipes, revolutions

### JSCAD

JavaScript-based CSG modeling:
- Constructive solid geometry operations
- Lightweight and fast for simple shapes
- STL export for 3D printing

### Manifold

Fast mesh boolean operations:
- Optimized for real-time mesh booleans
- GPU-accelerated operations
- Ideal for game development and interactive applications

## Game Engine Integration

### BabylonJS

Full-featured WebGL engine:
- Advanced PBR rendering with image-based lighting
- Physics engines (Havok, Cannon, Oimo)
- Audio, particle systems, animations
- Node material editor
- XR/VR support

### Three.js

Lightweight 3D library:
- Vast community and ecosystem
- Easy to learn
- Great for web integration
- Extensive loader support

### PlayCanvas

Professional game engine:
- Online collaborative editor
- Real-time collaboration tools
- Mobile optimization
- WebGPU support

## Visual Programming Editors

### Rete Editor (Node-based)

Visual node-based programming for complex workflows:
- Connect nodes with wires
- Real-time preview
- Custom node creation
- Export to JSON

### Blockly Editor (Block-based)

Drag-and-drop blocks for beginners:
- Snap-together programming
- Color-coded categories
- Great for learning
- Generates TypeScript code

### Monaco Editor (TypeScript)

Professional code editing:
- Full IntelliSense and autocomplete
- TypeScript type checking
- Syntax highlighting
- API documentation integration

## Export Formats

- **STEP**: Industry-standard CAD exchange format
- **STL**: 3D printing and manufacturing
- **OBJ**: General 3D model format
- **GLTF/GLB**: Web-optimized 3D format
- **IGES**: Legacy CAD format

## Open Source

- GitHub Repository: https://github.com/bitbybit-dev/bitbybit
- MIT License for core packages
- Example Applications: https://github.com/bitbybit-dev/app-examples
- Contributing Guide: https://github.com/bitbybit-dev/bitbybit/blob/develop/CONTRIBUTING.md

### Example Applications

- Laptop Holder: https://app-store.bitbybit.dev/laptop-holder
  - Angular: https://github.com/bitbybit-dev/app-examples/tree/main/angular/laptop-holder
  - React: https://github.com/bitbybit-dev/app-examples/tree/main/react/laptop-holder
  
- Cup Configurator: https://app-store.bitbybit.dev/cup
  - React: https://github.com/bitbybit-dev/app-examples/tree/main/react/cup

## 3D Bits Shopify App

Add 3D product configurators to your Shopify store:

- Shopify App: https://apps.shopify.com/3d-bits-1
- Documentation: https://learn.bitbybit.dev/learn/3d-bits/intro
- Crafts Shop (Demo): https://crafts.bitbybit.dev

## Script Runners

Run Bitbybit scripts in your applications:

- Runners Overview: https://learn.bitbybit.dev/learn/runners
- BabylonJS Full Runner: https://learn.bitbybit.dev/learn/runners/engines/babylonjs/full-runner
- Three.js Full Runner: https://learn.bitbybit.dev/learn/runners/engines/threejs/full-runner
- PlayCanvas Full Runner: https://learn.bitbybit.dev/learn/runners/engines/playcanvas/full-runner

## Community

- Discord: https://discord.gg/GSe3VMe
- YouTube: https://www.youtube.com/@bitbybitdev
- LinkedIn: https://www.linkedin.com/company/bitbybit-dev
- X/Twitter: https://x.com/bitbybit_dev
- Instagram: https://www.instagram.com/bitbybit.dev
- Facebook: https://fb.me/bitbybitdev
- Pinterest: https://www.pinterest.com/bitbybit_dev

## Support the Project

Your contributions allow this project to exist:

- Silver/Gold Plans: https://bitbybit.dev/auth/pick-plan
- 3D Bits Shopify App: https://apps.shopify.com/3d-bits-1
- Crafts Shop: https://crafts.bitbybit.dev

## Security

- Hosting & CDN: https://learn.bitbybit.dev/learn/hosting-and-cdn

## Optional

- Documentation llms.txt: https://learn.bitbybit.dev/llms.txt