LLM Documentation

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.

Download llm.txt View Raw
~120KB | Updated: Dec 16, 2025

What is llm.txt?

llms.txt is a standardized format (similar to robots.txt) that provides AI assistants with structured documentation about a project. It contains:

  • Complete API reference for all Three Blocks classes, functions, and TSL nodes
  • Constructor parameters, method signatures, and return types
  • Working code examples for each component
  • Import statements and usage patterns

IDE Integration

Cursor

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/llms.txt

Option 2: Manual Context

Download llms.txt and add it to your project, then reference it with @llms.txt in chat.

VS Code + Copilot

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://three-blocks.com/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.

Windsurf

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/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.

Claude Code & CLI Tools

Claude Code / Anthropic CLI

Project Instructions

Create CLAUDE.md in your project root:

# Three Blocks Project

## Documentation
For Three Blocks API reference, fetch:
https://threejs-blocks.com/llms.txt

## Key Patterns
- Use `three/webgpu` for WebGPU renderer
- Import from `@three-blocks/core`
- GPU compute requires WebGPU support

Inline Context

Fetch docs directly in your prompt:

Using the Three Blocks documentation from
https://threejs-blocks.com/llms.txt, help me
implement thousands of boids flying around the scene.

Claude will fetch and use the documentation automatically when given the URL.

ChatGPT & Web Interfaces

Custom GPT

Create a custom GPT with Three Blocks knowledge:

  1. 1 Download llms.txt from above
  2. 2 Go to ChatGPT → Explore GPTs → Create
  3. 3 Upload llms.txt as a knowledge file
  4. 4 Add instructions to reference the documentation

Quick Context

For one-off questions, paste the URL in your prompt:

Read the Three Blocks API docs from https://threejs-blocks.com/llms.txt and help me create a boids simulation with custom flocking behavior.

Most AI assistants will fetch and parse the documentation automatically.

Direct URL

The documentation is always available at this permanent URL:

https://threejs-blocks.com/llms.txt