agentleFS
hamzzaqureshihamzzaqureshi/gravidex/.claude/skills/threeui/SKILL.md

threeui

Skill1 starsChanged 8 days agoMITView on GitHub

3D, WebGL, and Three.js interactive UI component intelligence. 104 production-grade Three.js components, shaders, interactive backgrounds, 3D buttons, hero scenes, kinetic typography, and landing pages from DesignCode / ThreeUI. Provides instant search, shader code retrieval, WebGL lifecycle management, 60fps performance optimization, and React/Next.js integration.

The file

We split this skill into the rules it gives an agent

7 rules. About 0 are common, 0 are distinctive, and 7 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 7

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use this skill whenever the task involves 3D, WebGL, Three.js, Canvas, or Shader engineering:

    line 14
  2. Very specific:

    Run scripts/threeui.py search "<keyword>" to find verified, authored implementations rather than hallucinating Three.js scenes from scratch.

    line 79
  3. Very specific:

    Run scripts/threeui.py info <id> to understand the available configuration knobs (speed, noiseScale, mouseAmount, camera, color).

    line 82
  4. Very specific:

    When delivering code, ALWAYS adhere to the following Three.js / WebGL rules:

    line 85
  5. Very specific:

    Add "use client"; to WebGL components.

    line 93
  6. Very specific:

    Always dispose geometries, materials, textures, and cancel requestAnimationFrame on unmount to prevent GPU memory leaks:

    line 99
  7. Very specific:

    Use an IntersectionObserver to stop the render loop when the canvas is outside the viewport.

    line 110

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

ThreeUI - 3D & WebGL Component Intelligence

Production-grade 3D, WebGL, and Three.js design intelligence derived from DesignCode's ThreeUI library. Contains 104 production-tested Three.js components, custom GLSL shaders, raymarched surfaces, interactive buttons, kinetic typography, and full 3D landing experiences across 9 categories.


When to Apply

Use this skill whenever the task involves 3D, WebGL, Three.js, Canvas, or Shader engineering:

  • Adding interactive 3D hero scenes, animated backgrounds, or particle systems
  • Building raymarched liquid metal buttons, glowing glass CTAs, or tactile toggles
  • Implementing kinetic typography, morphing glyphs, or audio/particle wordmarks
  • Integrating Three.js / WebGL into React or Next.js App Router applications
  • Auditing and fixing WebGL memory leaks, context loss, layout thrashing, or low FPS

Skip this skill for standard flat CSS layouts, generic 2D forms, or non-visual backend services.


Catalog Categories (104 Components)

CategoryCountHighlights
Backgrounds29liquid-form (Velox silver raymarching), bell-field, flow-field, crt, halo, elements, constellation-field, stream-convergence
Buttons & CTAs20liquid-metal-button (Prismatic WebGL 2), plasma-button, ignition-button, induction-button, dot-border-button, lumen-cta
Three.js Scenes20globe (layered FBM energy orb), laser, japanese-tower, temple-night, landscape, bookshelf, structure-flow
Text Animation14typography-vortex, semantic-bloom, particle-wordmark, audio-wordmark, morphing-glyph-cloud, neon-typography
UI Elements9animated-top-dock, spark-badge, performance-gauges, connectivity-graph, uplink-loader, diagnostics-panel
CSS Effects5dark-glass, glassmorphism-cta, spinning-border-button, sliding-text-cta
Hero Sections3sylva-hero, complete-shelf-landing-page, bestsellers-book-showcase
Landing Pages2kage-landing-page, meng-to-sketchbook-landing-page
Sections2editorial-intro-section, newsletter-footer-section

For the complete catalog of all 104 components with descriptions, props, and runtimes, read component-catalog.md.


CLI Search & Extraction Engine

The bundled tool scripts/threeui.py is zero-dependency (Python 3 stdlib only) and provides instant local search, inspection, and code extraction:

# 1. Search components by keyword or effect
python3 scripts/threeui.py search "liquid"
python3 scripts/threeui.py search "wave" --category Backgrounds
python3 scripts/threeui.py search "button" --limit 5

# 2. View component details, uniforms, and controls
python3 scripts/threeui.py info liquid-form
python3 scripts/threeui.py info spark-badge

# 3. View/dump complete source code (TSX + GLSL shaders)
python3 scripts/threeui.py code liquid-form

# 4. Export component files directly into user's project
python3 scripts/threeui.py export liquid-form --output-dir ./src/components/threeui

# 5. List categories and component counts
python3 scripts/threeui.py categories

Core Operational Workflow

Step 1: Identify the Visual Intent

Determine what 3D effect best fits the project:

  • Atmospheric Background: Raymarched liquid (liquid-form), floating simplex noise (flow-field), matrix CRT (crt), or celestial particles (constellation-field).
  • High-Impact CTA: Liquid metal button (liquid-metal-button), plasma button (plasma-button), or glassmorphism glow pill.
  • Hero Centerpiece: 3D globe / energy orb (energy-orb), laser grid (laser), or living world scene (sylva-hero).
  • Kinetic Wordmark: Audio/Particle responsive typography (particle-wordmark).

Step 2: Query the Catalog

Run scripts/threeui.py search "<keyword>" to find verified, authored implementations rather than hallucinating Three.js scenes from scratch.

Step 3: Inspect Uniforms & Controls

Run scripts/threeui.py info <id> to understand the available configuration knobs (speed, noiseScale, mouseAmount, camera, color).

Step 4: Implement with Strict Production Guardrails

When delivering code, ALWAYS adhere to the following Three.js / WebGL rules:

  1. DPR Clamping (Crucial for 60 FPS):
    const dpr = Math.min(window.devicePixelRatio || 1, 1.5); // 1.5 for heavy shaders, 2.0 max
    renderer.setPixelRatio(dpr);
  2. Next.js SSR Boundary: Add "use client"; to WebGL components. In Server Components, import dynamically with { ssr: false }:
    import dynamic from "next/dynamic";
    const LiquidForm = dynamic(() => import("./LiquidFormBackground").then(m => m.LiquidFormBackground), { ssr: false });
  3. Strict Resource Disposal: Always dispose geometries, materials, textures, and cancel requestAnimationFrame on unmount to prevent GPU memory leaks:
    return () => {
      cancelAnimationFrame(animId);
      geometry.dispose();
      material.dispose();
      renderer.dispose();
      renderer.forceContextLoss();
    };
  4. Pause When Offscreen: Use an IntersectionObserver to stop the render loop when the canvas is outside the viewport.

Detailed Architectural Guides

  • threejs-core.md — Three.js lifecycle, render loops, responsive ResizeObserver, context loss recovery, and disposal contracts.
  • shader-glsl.md — GLSL vertex/fragment shaders, uniforms, 2D/3D simplex noise, raymarching SDFs, and Fresnel lighting.
  • react-integration.md — React & Next.js App Router integration, Canvas refs, R3F patterns, and dynamic SSR imports.
  • component-catalog.md — Full directory of all 104 components with descriptions and props.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.