Get Three.js Guide
get-three-js-guideLoad implementation guidance for Three.js and React Three Fiber tasks: plan, build, debug, optimize, audit 3D scenes, and find shader effects.
Instructions
Load implementation guidance for Three.js and React Three Fiber projects.
Use this while planning, building, debugging, or optimizing 3D web scenes. It covers Three.js fundamentals, geometries, materials, textures, lights and shadows, models and 3D text, particles, physics with Rapier, performance, postprocessing, React Three Fiber and its drei helper catalog, WebGPU and TSL node materials, shader fundamentals, and copyable shader effect recipes. It also covers auditing existing scenes: establish a repeatable baseline, trace resource ownership and repeated work, decide when demand rendering fits, and validate changes in the running scene. Before you model an object from code, load the building-procedural-objects topic: it covers parts that must touch, stay clear, stay in one piece and rest on the ground, faces that point outward, surfaces that must not flicker, and readable text. Preserve the examples when adapting them so the surrounding invariants remain visible to the coding agent.
This complements the design tools: use get-ui-principle for visual decisions and get-ux-principle for product behavior.
You can either:
Request a known topic: get-three-js-guide({ topic: "fundamentals" })
Use an alias: get-three-js-guide({ topic: "webgpu and tsl" })
Search for the current task or code example: get-three-js-guide({ query: "code example for a dissolve shader effect" })
Audit an existing scene: get-three-js-guide({ topic: "auditing-and-fixing-a-scene" })
Model an object whose parts fit together: get-three-js-guide({ topic: "building-procedural-objects" })
Get the full topic index: get-three-js-guide({})
Prefer query search when you do not know the topic name. Use maxTokens to keep responses focused (recommended: 5000-10000).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Natural language description of the Three.js or React Three Fiber task or problem. | |
| topic | No | Specific Three.js topic or alias, e.g. fundamentals, shader-effects-recipes, drei-catalog, webgpu-and-tsl. | |
| context | No | Optional. One sentence on WHY you are calling this and what the user asked for (e.g. 'adding nav icons for the fintech dashboard'). Used only for usage analytics; does not change the result. | |
| maxTokens | No | Maximum tokens to return. Truncates content to fit. Recommended: 5000-10000. |