Skip to content

livekit-examples/vtuber

Repository files navigation

VTuber LiveStreaming with LiveKit

Sample Gif

This is a demo of a vtuber live streaming app using LiveKit. The app uses your webcam to track your face and posture, applies face and posture data to a 3D avatar, and streams the WebGL canvas to Twitch and/or YouTube.

Online demo

You can try an online demo right now at https://vtuber-demo.livekit.io/.

Running locally

Clone the repo and install dependencies:

git clone [email protected]:livekit-examples/vtuber.git
cd vtuber
yarn

Create a new LiveKit project at http://cloud.livekit.io. Then create a new key in your project settings.

Create a new file at .env.development and add your new API key and secret as well as your project's WebSocket URL (found at the top of http://cloud.livekit.io):

LIVEKIT_API_KEY=<your api key>
LIVEKIT_API_SECRET=<your api secret>
LIVEKIT_WS_URL=wss://<your-project>.livekit.cloud

(Note: this file is in .gitignore. Never commit your API secret to git.)

Then run the development server:

yarn dev

You can test it by opening http://localhost:3000 in a browser.

Deploying for production

This demo is a Next.js app. You can deploy to your Vercel account with one click:

Deploy with Vercel

Refer to the Next.js deployment documentation for more about deploying to a production environment.