vite-threejs Debug Panel (Tweakpane)

Overview

Creates real-time parameter adjustment panels using Tweakpane. Activated via #debug URL hash.

Core principles:

• Every tunable parameter gets a control
• Colors must use view: 'color'
• Group panels hierarchically (max 3 levels)

Quick Start

javascript
1constructor() {
2  this.experience = new Experience()
3  this.debug = this.experience.debug
4  
5  this.params = { intensity: 1.0, color: '#ffffff' }
6  
7  if (this.debug.active) {
8    this.debugInit()
9  }
10}
11
12debugInit() {
13  this.debugFolder = this.debug.ui.addFolder({
14    title: 'Component Name',
15    expanded: false,
16  })
17  
18  this.debugFolder.addBinding(this.params, 'intensity', {
19    min: 0, max: 10, step: 0.1,
20  })
21}

When to Use

• Creating new 3D components
• Adding ShaderMaterial uniform controls
• Monitoring runtime state
• Adding action buttons

Control Types

Detailed examples: See references/controls.md

ShaderMaterial Integration

All ShaderMaterial uniforms must have debug controls:

javascript
1folder.addBinding(this.params, 'color', { view: 'color' })
2  .on('change', (ev) => {
3    this.material.uniforms.uColor.value.set(ev.value)
4  })

Full patterns: See references/shader-debug.md

Common Mistakes

• ❌ Colors without view: 'color'
• ❌ Direct this.debug.ui extraction
• ❌ Calling debugInit() without checking debug.active
• ❌ Nesting deeper than 3 levels
• ❌ All panels expanded by default

Complete error catalog: See references/common-mistakes.md

Quick Reference

Advanced patterns: See references/advanced-patterns.md