shaderz
v1.0.1
Published
CLI tool to add beautiful WebGL shaders to your React/Next.js project
Maintainers
Readme
Shaderz CLI
Add beautiful WebGL shaders to your React/Next.js project with a simple CLI.
Installation
npm install shaderzOr use with npx (no installation required):
npx shaderz addUsage
Interactive Installation
Install shaders interactively by selecting from a list:
npx shaderz addThis will:
- Show a checkbox list of all available shaders
- Let you select multiple shaders with Space
- Install selected shaders to
components/shaders/ - Copy video files to
public/videos/(for video shaders) - Check and remind you to install required dependencies
- Show usage examples
Available Shaders
WebGL Shaders:
liquid-orange- Flowing liquid shader with warm orange tonesocean-waves- Dynamic ocean waves shaderneon-fluid- Vibrant neon fluid shadergradient-waves- Smooth gradient waves shadercosmic-nebula- Space-themed nebula shaderglossy-ribbon- Glossy ribbon flow shadersilk-flow- Smooth silk flow shaderglass-twist- Glass twist effect shaderplasma- Classic plasma shader
Video Background:
glossy-film- MP4 video background (copies video to public/videos/)
Usage in Your Project
After installation:
import LiquidOrangeShader from '@/components/shaders/LiquidOrangeShader';
function App() {
return (
<div className="relative w-full h-screen">
<LiquidOrangeShader />
{/* Your content */}
</div>
);
}Video Background
import VideoBackground from '@/components/shaders/VideoBackground';
function App() {
return (
<div className="relative w-full h-screen">
<VideoBackground src="/videos/glossy-film.mp4" />
{/* Your content */}
</div>
);
}Requirements
- React 18+ or 19+
- No additional dependencies required (WebGL is built into modern browsers)
- Video shader requires the video file to be in public/videos/ (automatically handled by CLI)
License
MIT © harsh and shubham
