@readyplayerme/web-3d-viewer

web-3d-viewer

web-3d-viewer is a collection of components for showcasing Ready Player Me avatars and 3D on the web!

Built with three.js, react-three-fiber, drei, three-stdlib and react.

Installation

web-3d-viewer is available as an npm package.

npm install @readyplayerme/web-3d-viewer

Documentation & examples

You can find all code examples of the components and their documentation on our GitHub page.

Here is the first one to get you started:

import React from 'react';
import ReactDOM from 'react-dom';
import { Avatar } from '@readyplayerme/web-3d-viewer';

const modelSrc = 'https://readyplayerme.github.io/web-3d-viewer/male.glb';

function App() {
  return (
    <Avatar modelSrc={modelSrc} />
  );
}

ReactDOM.render(<App />, document.querySelector('#app'));

Validation

Props such as modelSrc, animationSrc, poseSrc and onLoadedAnimation.src are validated before rendering on the scene. Animation source props support both .glb and .fbx formats. All other props mentioned before only support .glb.

Examples on supported resource formats:

• URL resources
  • relative /headwear.glb
  • absolute https://readyplayerme.github.io/web-3d-viewer/male.glb?queryParams=allowed
• Base64 strings
  • data:application/octet-stream;base64
  • data:model/gltf-binary;base64
• Binary input such as model/gltf-binary

License

web-3d-viewer is MIT licensed.