• Docs · Getting started

From microphone to moving water in four steps

Most rooms are live in under ten minutes. No timeline, no export, no render queue.

Step 01

Add the runtime

Drop one script tag into any page, or install the package if you bundle.

npm install @deepcurrent/runtime

<script src="https://cdn.deepcurrent.example/v2/runtime.js"></script>

Step 02

Connect an audio source

Use the microphone, a file, a stream, or a WebSocket feed of band energies from your desk.

const water = DeepCurrent.mount("#stage", {

source: "microphone", // "file" | "stream" | "bands"

scene: "tidal",

})

Step 03

Pick a scene and palette

Twelve scenes ship with the runtime. Lock a palette to your brand colours.

water.setPalette({ deep: "#020617", beam: "#00F5D4", water: "#2F6BFF" })

water.setScene("aurora", { transition: 1.2 })

Step 04

Go live

Fullscreen for LED walls, kiosk mode for retail, or a transparent canvas for OBS.

water.fullscreen()

water.kiosk({ reloadAt: "04:00" })

water.obs({ transparent: true })

Create a free website with Framer, the website builder loved by startups, designers and agencies.