Skip to content

Commit 514192b

Browse files
matas-bitbybit-devmatas-bitbybit-dev
committed
llms.txt
1 parent b351227 commit 514192b

File tree

3 files changed

+387
-0
lines changed

3 files changed

+387
-0
lines changed

‎docs/static/llms.txt‎

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
# Bitbybit Documentation
2+
3+
> Learn how to use the Bitbybit 3D creative coding platform—from visual programming to TypeScript APIs and NPM package integration. Build parametric 3D models, product configurators, and CAD applications directly in the browser.
4+
5+
This is the official documentation site for Bitbybit. The platform enables designers and developers to create 3D geometry using visual programming or TypeScript code, with integration for BabylonJS, Three.js, and PlayCanvas game engines.
6+
7+
## Quick Links
8+
9+
- Main Platform: https://bitbybit.dev
10+
- TypeScript API Reference: https://docs.bitbybit.dev
11+
- GitHub Repository: https://github.com/bitbybit-dev/bitbybit
12+
13+
## Getting Started
14+
15+
- Welcome Guide: https://learn.bitbybit.dev/learn/intro
16+
- Platform Overview: https://learn.bitbybit.dev/learn/getting-started/overview
17+
- Open Source Approach: https://learn.bitbybit.dev/learn/open-source-approach
18+
19+
## NPM Packages
20+
21+
Integration guides for embedding Bitbybit in your web applications.
22+
23+
### Quick Start
24+
25+
```bash
26+
npx @bitbybit-dev/create-app my-project
27+
```
28+
29+
Choose your game engine (BabylonJS, Three.js, or PlayCanvas) and start coding immediately.
30+
31+
### Overview
32+
33+
- Introduction: https://learn.bitbybit.dev/learn/npm-packages/intro
34+
- Engine Agnostic Core: https://learn.bitbybit.dev/learn/npm-packages/game-engine-agnostic
35+
36+
### Game Engine Integration
37+
38+
- Three.js Integration: https://learn.bitbybit.dev/learn/npm-packages/threejs
39+
- BabylonJS Integration: https://learn.bitbybit.dev/learn/npm-packages/babylonjs
40+
- PlayCanvas Integration: https://learn.bitbybit.dev/learn/npm-packages/playcanvas
41+
42+
### All NPM Packages
43+
44+
Game Engine Packages:
45+
- @bitbybit-dev/babylonjs - BabylonJS visualization and drawing
46+
- @bitbybit-dev/threejs - Three.js visualization and drawing
47+
- @bitbybit-dev/playcanvas - PlayCanvas visualization and drawing
48+
49+
Core Packages:
50+
- @bitbybit-dev/core - Combined CAD kernel features
51+
- @bitbybit-dev/base - Base algorithms (vector math, transformations)
52+
53+
CAD Kernel Packages (Main Thread):
54+
- @bitbybit-dev/occt - OpenCascade for industrial B-rep CAD
55+
- @bitbybit-dev/jscad - JSCAD for CSG modeling
56+
- @bitbybit-dev/manifold - Manifold for fast mesh booleans
57+
58+
Web Worker Packages (Non-blocking, Recommended):
59+
- @bitbybit-dev/occt-worker - OpenCascade via web worker
60+
- @bitbybit-dev/jscad-worker - JSCAD via web worker
61+
- @bitbybit-dev/manifold-worker - Manifold via web worker
62+
63+
## Runners
64+
65+
Script runners for executing Bitbybit scripts in your applications:
66+
67+
- Runners Overview: https://learn.bitbybit.dev/learn/runners
68+
- BabylonJS Full Runner: https://learn.bitbybit.dev/learn/runners/engines/babylonjs/full-runner
69+
- Three.js Full Runner: https://learn.bitbybit.dev/learn/runners/engines/threejs/full-runner
70+
- PlayCanvas Full Runner: https://learn.bitbybit.dev/learn/runners/engines/playcanvas/full-runner
71+
72+
## Code Editor
73+
74+
TypeScript programming guides:
75+
76+
- Code Introduction: https://learn.bitbybit.dev/learn/code/intro
77+
78+
## 3D Bits (Shopify App)
79+
80+
Add 3D product configurators to Shopify stores:
81+
82+
- 3D Bits Introduction: https://learn.bitbybit.dev/learn/3d-bits/intro
83+
- Shopify App: https://apps.shopify.com/3d-bits-1
84+
85+
## AI Integration
86+
87+
Using AI assistants with Bitbybit for enhanced coding workflows.
88+
89+
### Documentation
90+
91+
- AI Introduction: https://learn.bitbybit.dev/learn/using-ai-with-bitbybit/intro
92+
- Context7 MCP Integration: https://learn.bitbybit.dev/learn/using-ai-with-bitbybit/mcp/context-7
93+
94+
### AI Context Files (v0.21.0)
95+
96+
Attach these files to your AI coding assistant for Bitbybit API knowledge.
97+
98+
#### Beginner Context (Monaco Editor)
99+
100+
For online TypeScript editor at bitbybit.dev:
101+
- Full Context (116k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v0.21.0/bitbybit-babylon-monaco-ai-context-v0.21.0.md
102+
103+
#### BabylonJS Context
104+
105+
- Full (116k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v0.21.0/bitbybit-babylon-ai-context-v0.21.0.md
106+
- Lite (114k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v0.21.0/bitbybit-babylon-no-comment-min-ai-v0.21.0.txt
107+
108+
#### Three.js Context
109+
110+
- Full (95k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v0.21.0/bitbybit-three-ai-context-v0.21.0.md
111+
- Lite (82k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v0.21.0/bitbybit-three-no-comment-min-ai-v0.21.0.txt
112+
113+
#### PlayCanvas Context
114+
115+
- Full (94k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v0.21.0/bitbybit-playcanvas-ai-context-v0.21.0.md
116+
- Lite (82k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v0.21.0/bitbybit-playcanvas-no-comment-min-ai-v0.21.0.txt
117+
118+
### MCP Server
119+
120+
Context7 MCP provides live AI context with always up-to-date documentation:
121+
122+
- Context7 Library: https://context7.com/bitbybit-dev/bitbybit
123+
124+
VS Code MCP Setup:
125+
```json
126+
{
127+
"servers": [
128+
{
129+
"command": "npx",
130+
"args": ["-y", "@upstash/context7-mcp@latest"],
131+
"env": {
132+
"DEFAULT_MINIMUM_TOKENS": "10000"
133+
}
134+
}
135+
]
136+
}
137+
```
138+
139+
## GitHub & Contributing
140+
141+
- Main Repository: https://github.com/bitbybit-dev/bitbybit
142+
- Contributing Guide: https://learn.bitbybit.dev/learn/github
143+
- Unit Testing Guide: https://learn.bitbybit.dev/learn/github/unit-tests
144+
- Live Test Coverage: https://learn.bitbybit.dev/learn/github/live-unit-test-coverage
145+
146+
## Blog
147+
148+
Latest updates, tutorials, and announcements:
149+
150+
- Blog: https://learn.bitbybit.dev/blog
151+
- PlayCanvas Support Announcement: https://learn.bitbybit.dev/blog/playcanvas-support
152+
153+
## Security
154+
155+
- Hosting & CDN: https://learn.bitbybit.dev/learn/hosting-and-cdn
156+
157+
## Community
158+
159+
- Discord: https://discord.gg/GSe3VMe
160+
- YouTube: https://www.youtube.com/@bitbybitdev
161+
- LinkedIn: https://www.linkedin.com/company/bitbybit-dev
162+
- X/Twitter: https://x.com/bitbybit_dev
163+
164+
## Key Concepts
165+
166+
### Geometry Kernels
167+
168+
Bitbybit supports multiple CAD kernels:
169+
170+
- **OpenCascade (OCCT)**: Industrial-grade B-rep kernel for precise CAD operations, boolean operations, fillets, chamfers, STEP export
171+
- **JSCAD**: JavaScript-based CSG modeling for simple shapes
172+
- **Manifold**: Fast mesh boolean operations for real-time applications
173+
174+
### Game Engines
175+
176+
Visualization and rendering:
177+
178+
- **BabylonJS**: Full-featured WebGL engine with PBR, physics, audio
179+
- **Three.js**: Lightweight, popular 3D library with vast ecosystem
180+
- **PlayCanvas**: Professional engine with online collaborative editor
181+
182+
### Editors
183+
184+
- **Monaco (TypeScript)**: Full IntelliSense, professional coding
185+
- **Rete**: Node-based visual programming
186+
- **Blockly**: Block-based visual programming for beginners
187+
188+
### Web Workers
189+
190+
All geometry kernels have web worker variants (-worker packages) for non-blocking UI:
191+
- Asynchronous operations that don't freeze the browser
192+
- Recommended for production applications
193+
- Same API as main thread packages
194+
195+
## Optional
196+
197+
- Main site llms.txt: https://bitbybit.dev/llms.txt

‎docs/static/robots.txt‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
User-agent: *
2+
Allow: /
3+
4+
Sitemap: https://learn.bitbybit.dev/sitemap.xml
5+
6+
# LLM Context
7+
# For AI assistants and language models
8+
llms.txt: https://learn.bitbybit.dev/llms.txt

‎llms.txt‎

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
# Bitbybit Monorepo
2+
3+
> Open-source 3D CAD algorithms and NPM packages for web-based parametric modeling and visualization. Build once, run anywhere—no installation required.
4+
5+
This monorepo contains the open-source core of Bitbybit platform, including multiple NPM packages for integrating 3D CAD capabilities into web applications using BabylonJS, Three.js, or PlayCanvas game engines.
6+
7+
## Repository
8+
9+
- GitHub: https://github.com/bitbybit-dev/bitbybit
10+
- License: MIT
11+
12+
## Documentation
13+
14+
- Learn Bitbybit: https://learn.bitbybit.dev
15+
- TypeScript API Reference: https://docs.bitbybit.dev
16+
- Main Platform: https://bitbybit.dev
17+
18+
## Quick Start
19+
20+
```bash
21+
npx @bitbybit-dev/create-app my-project
22+
```
23+
24+
Choose your game engine and start coding immediately.
25+
26+
## NPM Packages
27+
28+
### Game Engine Integrations
29+
30+
| Package | Description | NPM |
31+
|---------|-------------|-----|
32+
| @bitbybit-dev/babylonjs | BabylonJS visualization and drawing | https://www.npmjs.com/package/@bitbybit-dev/babylonjs |
33+
| @bitbybit-dev/threejs | Three.js visualization and drawing | https://www.npmjs.com/package/@bitbybit-dev/threejs |
34+
| @bitbybit-dev/playcanvas | PlayCanvas visualization and drawing | https://www.npmjs.com/package/@bitbybit-dev/playcanvas |
35+
36+
### Core Packages
37+
38+
| Package | Description | NPM |
39+
|---------|-------------|-----|
40+
| @bitbybit-dev/core | Combined CAD kernel features | https://www.npmjs.com/package/@bitbybit-dev/core |
41+
| @bitbybit-dev/base | Base algorithms (vector math, transforms) | https://www.npmjs.com/package/@bitbybit-dev/base |
42+
43+
### CAD Kernel Packages (Main Thread)
44+
45+
| Package | Description | NPM |
46+
|---------|-------------|-----|
47+
| @bitbybit-dev/occt | OpenCascade B-rep CAD wrapper | https://www.npmjs.com/package/@bitbybit-dev/occt |
48+
| @bitbybit-dev/jscad | JSCAD CSG modeling wrapper | https://www.npmjs.com/package/@bitbybit-dev/jscad |
49+
| @bitbybit-dev/manifold | Manifold mesh booleans wrapper | https://www.npmjs.com/package/@bitbybit-dev/manifold |
50+
51+
### Web Worker Packages (Non-blocking, Recommended)
52+
53+
These packages run geometry computations in web workers for non-blocking UI. Same API as main thread packages, but all operations are asynchronous.
54+
55+
| Package | Description | NPM |
56+
|---------|-------------|-----|
57+
| @bitbybit-dev/occt-worker | OpenCascade via web worker | https://www.npmjs.com/package/@bitbybit-dev/occt-worker |
58+
| @bitbybit-dev/jscad-worker | JSCAD via web worker | https://www.npmjs.com/package/@bitbybit-dev/jscad-worker |
59+
| @bitbybit-dev/manifold-worker | Manifold via web worker | https://www.npmjs.com/package/@bitbybit-dev/manifold-worker |
60+
61+
## Package Structure
62+
63+
```
64+
packages/
65+
└── dev/
66+
├── babylonjs/ # BabylonJS integration
67+
├── threejs/ # Three.js integration
68+
├── playcanvas/ # PlayCanvas integration
69+
├── core/ # Core combining all kernels
70+
├── base/ # Base algorithms
71+
├── occt/ # OpenCascade wrapper
72+
├── occt-worker/ # OCCT web worker
73+
├── jscad/ # JSCAD wrapper
74+
├── jscad-worker/ # JSCAD web worker
75+
├── manifold/ # Manifold wrapper
76+
├── manifold-worker/ # Manifold web worker
77+
└── create-app/ # Project scaffolding CLI
78+
```
79+
80+
## AI Context
81+
82+
For AI coding assistants, use these resources to get comprehensive Bitbybit API knowledge.
83+
84+
### AI Prompt Context Files (v0.21.0)
85+
86+
#### Beginner Context (Monaco Editor)
87+
For online TypeScript editor at bitbybit.dev:
88+
- Full Context (116k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v0.21.0/bitbybit-babylon-monaco-ai-context-v0.21.0.md
89+
90+
#### BabylonJS Context
91+
- Full (116k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v0.21.0/bitbybit-babylon-ai-context-v0.21.0.md
92+
- Lite (114k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v0.21.0/bitbybit-babylon-no-comment-min-ai-v0.21.0.txt
93+
94+
#### Three.js Context
95+
- Full (95k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v0.21.0/bitbybit-three-ai-context-v0.21.0.md
96+
- Lite (82k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v0.21.0/bitbybit-three-no-comment-min-ai-v0.21.0.txt
97+
98+
#### PlayCanvas Context
99+
- Full (94k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v0.21.0/bitbybit-playcanvas-ai-context-v0.21.0.md
100+
- Lite (82k tokens): https://app.bitbybit.dev/assets/ai-prompt-context/v0.21.0/bitbybit-playcanvas-no-comment-min-ai-v0.21.0.txt
101+
102+
### Context7 MCP (Recommended)
103+
104+
Live AI context with always up-to-date documentation. Works with Claude, Gemini, Grok.
105+
106+
Add to your `.vscode/mcp.json`:
107+
108+
```json
109+
{
110+
"servers": [
111+
{
112+
"command": "npx",
113+
"args": ["-y", "@upstash/context7-mcp@latest"],
114+
"env": {
115+
"DEFAULT_MINIMUM_TOKENS": "10000"
116+
}
117+
}
118+
]
119+
}
120+
```
121+
122+
- Context7 Library: https://context7.com/bitbybit-dev/bitbybit
123+
- Integration Guide: https://learn.bitbybit.dev/learn/using-ai-with-bitbybit/mcp/context-7
124+
125+
## Integration Guides
126+
127+
- Three.js: https://learn.bitbybit.dev/learn/npm-packages/threejs
128+
- BabylonJS: https://learn.bitbybit.dev/learn/npm-packages/babylonjs
129+
- PlayCanvas: https://learn.bitbybit.dev/learn/npm-packages/playcanvas
130+
- Engine Agnostic: https://learn.bitbybit.dev/learn/npm-packages/game-engine-agnostic
131+
132+
## Geometry Kernels
133+
134+
### OpenCascade (OCCT)
135+
Industrial-grade B-rep kernel:
136+
- Boundary representation for exact geometry
137+
- Boolean operations (union, difference, intersection)
138+
- Fillets, chamfers, shell, offset operations
139+
- STEP/IGES import/export
140+
- Sweeps, lofts, pipes, revolutions
141+
142+
### JSCAD
143+
JavaScript-based CSG modeling:
144+
- Constructive solid geometry operations
145+
- Lightweight for simple shapes
146+
- STL export for 3D printing
147+
148+
### Manifold
149+
Fast mesh boolean operations:
150+
- Optimized for real-time operations
151+
- GPU-accelerated
152+
- Ideal for interactive applications
153+
154+
## Example Applications
155+
156+
- Laptop Holder: https://github.com/bitbybit-dev/app-examples/tree/main/angular/laptop-holder
157+
- Cup Configurator: https://github.com/bitbybit-dev/app-examples/tree/main/react/cup
158+
- Live Demos: https://app-store.bitbybit.dev
159+
160+
## Contributing
161+
162+
- Contributing Guide: CONTRIBUTING.md
163+
- Code of Conduct: CODE_OF_CONDUCT.md
164+
- Unit Testing Guide: UNIT_TESTING_GUIDE.md
165+
166+
## Community
167+
168+
- Discord: https://discord.gg/GSe3VMe
169+
- YouTube: https://www.youtube.com/@bitbybitdev
170+
171+
## Support the Project
172+
173+
Your contributions allow this project to exist:
174+
175+
- Silver/Gold Plans: https://bitbybit.dev/auth/pick-plan
176+
- 3D Bits Shopify App: https://apps.shopify.com/3d-bits-1
177+
- Crafts Shop: https://crafts.bitbybit.dev
178+
179+
## Related llms.txt Files
180+
181+
- Main Platform: https://bitbybit.dev/llms.txt
182+
- Documentation: https://learn.bitbybit.dev/llms.txt

0 commit comments

Comments
 (0)