/agora-mediapipe-readyplayerme

A demo project showcasing how to use Agora's web SDK with MediaPipe and Ready Player Me.

Primary LanguageJavaScriptMIT LicenseMIT

Agora Virtual Avatars using MediaPipe

The code in this repo demonstrates how to use MediaPipe and Agora to implement responsive virtual avatars within Agora Live Video streams.

For an explination of the code: View GUIDE.md

Demo

build deploy to pages workflow
Ping the token server: << Send Ping >>
Once token server responds, test the build: https://digitallysavvy.github.io/agora-mediapipe-readyplayerme/

Setup

  1. Clone the repo

  2. Copy .env-example file and rename to .env

    cp .env-example .env

  3. Set the APP_ID, and TOKEN_SERVER env variables in the .env file

Test in Dev mode

  1. Follow steps in setup
  2. Open the terminal and navigate to repo folder
  3. Use this command to run dev mode with local webserver:
npm run dev

Build for production

  1. Follow steps in setup

  2. Open the terminal and navigate to repo folder

  3. Use this command to run the build script:

    npm run build

  4. Upload the contents of the new dist folder to your webserver

  5. Make sure the server has your Agora API key, and Agora Token server url are set in the environment variables using the env variables VITE_AGORA_APP_ID & VITE_AGORA_TOKEN_SERVER_URL

Deploy to GitHub Pages

This project is setup with a GitHub actions workflow to deploy the project to GitHub pages, if enabled in the project settings.

To enable GitHub Pages build via GitHub Actions:

  1. Clone or Fork the project (https://github.com/digitallysavvy/agora-mediapipe-readyplayerme/)
  2. Click the project's Settings tab
  3. Click the Pages tab in the left column menu
  4. Under Build and deployment, select GitHub Actions as the Source
  5. Click the Environments tab in the left column menu
  6. Click github-pages from the Environments list
  7. Click Add variable under the Environment variable section
  8. Set the name VITE_AGORA_APP_ID and your Agora AppId as the value.
  9. Repeat step 8 and add VITE_AGORA_TOKEN_SERVER_URL and the url to your agora token service url.
  10. (optional) If you used a different name for your github repo, update the vit.config.js file to update the url if you change the project name