Machine-readable API documentation optimized for AI assistants. Use this file to give Claude, ChatGPT, Cursor, or other AI tools accurate knowledge about Three Blocks.
llms.txt is a standardized format (similar to robots.txt) that provides AI assistants with structured documentation about a project. We provide two files:
Lightweight navigation index optimized for quick context loading.
Complete API reference with all details in a single file.
Tip: Use llms.txt for quick context when the AI needs an overview. Use llms-full.txt when you need detailed API information.
Add the documentation to your project's context for AI-assisted coding.
Option 1: Project Rules
Create .cursor/rules/three-blocks.mdc:
---
description: Three Blocks API
globs: **/*.{js,ts,jsx,tsx}
alwaysApply: true
---
@https://threejs-blocks.com/llm/core/llms.txtOption 2: Manual Context
Download llms.txt and add it to your project, then reference it with @llms.txt in chat.
Add custom instructions for GitHub Copilot Chat.
Instructions File
Create .github/copilot-instructions.md:
# Three Blocks Context
When working with Three Blocks (@three-blocks/core),
refer to the API documentation at:
https://threejs-blocks.com/llm/core/llms.txt
Key imports:
- `import { Boids, SPH, Text } from '@three-blocks/core'`
- Always use `three/webgpu` for WebGPU features
Or paste the llms.txt content directly in chat with #file.
Configure Cascade with Three Blocks documentation context.
Global Rules
Create .windsurfrules:
When working with Three Blocks, use the
API reference from: https://threejs-blocks.com/llm/core/llms.txt
Always import from '@three-blocks/core' and
use 'three/webgpu' for WebGPU renderer.Memory
Add llms.txt to Windsurf's Memories for persistent context across sessions.
Project Instructions
Create CLAUDE.md in your project root:
# Three Blocks Project
## Documentation
For Three Blocks API reference, fetch:
https://threejs-blocks.com/llm/core/llms.txt
## Key Patterns
- Use `three/webgpu` for WebGPU renderer
- Import from `@three-blocks/core`
- GPU compute requires WebGPU supportInline Context
Fetch docs directly in your prompt:
Using the Three Blocks documentation from
https://threejs-blocks.com/llm/core/llms-full.txt, help me
implement thousands of boids flying around the scene.
Use llms.txt for overview or llms-full.txt for complete API details.
Create a custom GPT with Three Blocks knowledge:
llms.txt from above llms.txt as a knowledge file For one-off questions, paste the URL in your prompt:
Read the Three Blocks API docs from https://threejs-blocks.com/llm/core/llms.txt and help me create a boids simulation with custom flocking behavior.Most AI assistants will fetch and parse the documentation automatically.