VIEWER_README.md

# FaceLift 3D Interactive Viewer

This package contains an interactive 3D Gaussian Splatting viewer for your generated face model.

## Quick Start

1. **Extract the ZIP file** to a folder
2. **Open `viewer.html`** in a modern web browser (Chrome, Firefox, Edge, Safari)
3. The 3D model will load automatically!

## Controls

### Mouse/Trackpad
- **Left Click + Drag**: Rotate camera
- **Right Click + Drag** (or Ctrl+Drag): Pan camera
- **Scroll**: Zoom in/out
- **Shift + Scroll**: Move up/down

### Keyboard
- **Arrow Keys**: Move forward/back, strafe left/right
- **W/S**: Tilt camera up/down
- **A/D**: Turn camera left/right
- **Q/E**: Roll camera
- **Space**: Jump

### Touch (Mobile)
- **One Finger**: Rotate
- **Two Finger Pinch**: Zoom
- **Two Finger Rotate**: Roll camera
- **Two Finger Pan**: Move

## Browser Requirements

This viewer works best in modern browsers with WebGL support:
- ✅ Chrome/Edge (recommended)
- ✅ Firefox
- ✅ Safari
- ✅ Mobile browsers

## Viewer Technology

This viewer is based on the excellent [antimatter15/splat](https://github.com/antimatter15/splat) project, 
a WebGL-based real-time renderer for 3D Gaussian Splatting.

## Troubleshooting

- **Black screen**: Make sure all three files (`viewer.html`, `viewer.js`, `gaussians.ply`) are in the same folder
- **Model not loading**: Try refreshing the page or opening in a different browser
- **Performance issues**: Close other tabs/applications or try a different browser

## Files Included

- `viewer.html` - The viewer interface
- `viewer.js` - WebGL rendering engine (from antimatter15/splat)
- `gaussians.ply` - Your 3D face model

---

Generated by FaceLift - Single Image 3D Face Reconstruction