LogoLogo
WebsiteBlogForumsSign up
  • Welcome
  • How Ready Player Me works
  • FAQ
  • 👩‍💻Integration Guides
    • Overview
    • Unity
      • Quickstart
      • Avatar Creator Integration
        • WebView Avatar Creator
          • Avatar Creator for Android & iOS
          • Avatar Creator for WebGL
        • Build your own Avatar Creator
          • Start with the sample
          • Elements
            • Asset Selection Element
            • Color Selection Element
            • Template Selection Element
            • Body Shapes Selection Element
            • Gender Selection Element
            • Avatar List Element
            • Photo Capture Element
            • Signup Element
            • Login Element
            • Logout Element
          • User Management
      • Load 2D Renders
      • Avatar Loader Window
      • Setup Multiplayer
      • Setup for XR (Beta)
        • Setup the Player Avatar
        • Setup Meta Movement SDK
        • Setup Final IK
        • Setup XR Hands
          • RpmHandDriver script
        • Facial Animations
        • VR Avatar Creator
      • Animations
        • Ready Player Me Animation Library
        • Mixamo Animations
      • Optimize
        • Avatar Configuration
        • Avatar Caching
        • Defer Agents
      • Code Samples
        • Loading 3D Avatars
        • Loading 2D Avatars
        • Avatar Creator (WebGL)
        • Avatar Creator (Desktop)
        • Avatar Creator (Mobile)
        • Distance-based LODs
      • Troubleshooting
        • Editor UI Window Issues
        • Avatar loading issues
        • iOS issues
        • WebGL issues
        • Firewall issues
        • Updating the SDK
          • Unity SDK 3.0.0 Migration guide
          • Unity SDK 4.0.0 Migration guide
          • Unity SDK 5.0.0
          • Unity SDK 7.0.0
          • WebView 2.0 Migration
        • Package installation issues
      • Help us improve the Unity SDK
      • FAQ for Unity
      • Early Access Features
    • Unreal Engine
      • Quickstart
        • Import SDK Manually
      • Avatar Creator Integration
        • Build your own Avatar Creator
          • Sample Structure
          • Customization Guide
        • WebView Avatar Creator
      • Load Avatars
      • Animations
        • Ready Player Me Animation Library
        • Loading Mixamo animations
        • Mannequin animation retargeting
        • Blender FBX export to UE
        • Oculus Lipsync integration
      • Optimize
        • Avatar configuration
        • Avatar caching
        • Avatar preloading
      • Code Samples
        • Unreal Engine 5 samples
        • Lyra project integration example
        • VR Avatars
        • Unreal Engine 4
      • Troubleshooting
        • Project compilation issues
        • Missing materials on built applications
        • Avatar loading issues
        • Animation issues
        • Unreal SDK breaking changes
        • Avatar lighting issues
        • Updating from earlier versions
          • Unreal SDK 3.0.0 Migration guide
        • Auto LOD issues
      • Help us improve the Unreal Engine SDK
      • FAQ for Unreal Engine
      • Early Access Features
    • React
      • Quickstart
    • React Native
    • iOS Native
    • Android Native
    • Web Integration
      • Quickstart
      • User Management
        • Guest Accounts
        • Account Linking
      • Avatar Creator integration
      • Optimize
    • API Integration
      • Quickstart
      • Custom Avatar Creator
      • User management
        • Ready Player Me Account
        • Anonymous Accounts
    • UX/UI Guidelines
      • Summary & quick tips
      • UX and UI guidelines and essentials
        • Foundation for good user experience
          • Layout
          • Colors
          • Typography
          • Icons
          • Dark mode and light mode
        • Mobile best practices
          • Layout
        • Making Ready Player Me feel native
          • Seamless Avatar Integration
          • Consistent Branding
          • Responsive Layout
          • Performance Optimization
        • Discoverability of the avatar editor
          • Onboarding tutorial
          • Clear navigation
          • Contextual Placement
  • 🖌️Customizing Guides
    • Studio (Developer Dashboard)
    • Avatar Creator Appearance
      • Avatar URLs
      • Avatar Shortcodes
    • Upload and Manage Custom Assets
      • Asset Manager in Studio
      • Configure in Studio
      • Manage custom assets using the API
      • Unlocking assets through API (Beta)
    • Create Custom Assets
      • Fullbody Outfits
        • Checking Skin Weights
      • Tops, Bottoms, Shoes
        • Editing templates
      • Hairstyle
      • Headwear
      • Facewear
      • Glasses
      • Hero Characters
      • Modeling Guidelines
  • 🔃API Reference
    • REST API
      • Authentication
      • Avatars
        • GET - 3D avatar
        • GET - 2D Render of an Avatar
        • GET - Metadata
        • PUT - Equip an asset
        • PUT - Unequip an asset
      • Assets
        • Asset Entity Properties
        • POST - Create Asset
        • GET - List Assets
        • PATCH - Update Asset
        • POST - Upload Asset Files
        • POST - Add Asset to Application
        • DELETE - Remove Asset from Application
        • PUT - Unlock asset for a user
        • PUT - Lock asset for a user
      • Users
        • POST - Create User
      • Auth
        • GET - Token
      • Changelog
    • Avatars
      • Full-body avatars
      • Full-body XR avatars
      • Half-body avatars
      • Morph targets
        • Apple ARKit
        • Oculus OVR LipSync
    • Avatar Creator
  • 🔉Support
    • Forums
    • Licensing & Privacy
Powered by GitBook
On this page
  • 1. Create your custom facewear
  • Materials & Texture Maps
  • 2. Export the asset
  • 3. Upload and validate your asset
  • File Requirements
  • Ready Player Me Studio
  • API

Was this helpful?

  1. Customizing Guides
  2. Create Custom Assets

Facewear

Create custom facewear for Ready Player Me avatars.

PreviousHeadwearNextGlasses

Last updated 1 year ago

Was this helpful?

This document explains how to create facewear that meets Ready Player Me technical specifications and functions properly in your application. The facewear asset type is any asset that mainly covers areas of the face (but are not glasses), like masks and bandanas.

1. Create your custom facewear

  • Use Blender to open the facewear-bandana-03.blend.

  • Inspect this example and familiarize yourself with the details as your design must match the same requirements.

  • If your facewear does cover the neck or clavicle area and needs to deform with motion of the head, you can assign skin weights to the joints in the provided template file.

Technical Requirements
  • Triangle count: max. 2000

  • Object name: Wolf3D_Facewear

  • Mesh name: Wolf3D_Facewear

  • Material name: Wolf3D_Facewear

  • Basecolor map: Optional Use sRGB (IEC 61966-2-1 Default RGB color space) when editing the image.

  • Normal map: Optional OpenGL tangent space normal map, +Y up.

  • Metallic-Roughness map: Optional

  • Emissive map: Optional

  • Texture Resolution: max. 2048 x 2048 pixels Texture resolutions must be square and power-of-two, e.g. 128x128, 256x256, 512x512.

  • Texture files format: PNG/JPEG For PNG images, use 24 bits per pixel (RGB) or 32 bits per pixel (RGBA). Do not use palettes (8-bit color indexed). Do not include metadata or color profile information in the image files to avoid errors.

  • Individual texture file size: max. 4 MB

  • Vertex colors: No

  • Skin weights: Optional No more than 4 influences per vertex. Weights must be normalized.

Asset Limitations

Be aware that facewear meshes will pass through other meshes of the avatar, e.g. body or the torso garment, during animation and not react physically accurate (or at all) to colliding geometry.

Materials & Texture Maps

  • The materials use the metalness PBR workflow.

  • Keep the shading network of the material as simple as possible.

  • Enable Backface Culling (single-sided materials). Only use double-sided materials when absolutely necessary. Otherwise, leave the box checked.

2. Export the asset

  • Export the hair model into glTF Embedded (.glb). Below are the required export settings using Blender.

  • Only include the headwear model in the export, not the head reference.

Starting with Blender 4, objects placed in a glTF_not_exported collection are excluded from the export.

Do not use custom glTF-Extensions extensions in the file, e.g. Draco mesh compression.

3. Upload and validate your asset

File Requirements

  • File type: .GLB

  • File Size: max. 10 MB

  • Icon file size: max. 1 MB

Ready Player Me Studio

In the Type selection, you must select Facewear as the asset type.

In the Gender selection, choose Neutral to make them available to all stereotypes.

Upload the necessary files and Save. The asset is only saved when it passes validation. If any errors are detected regarding the compliance with the requirements, you'll get a notification and more information.

API

When you want to push your assets to your organization at Ready Player Me, use thePOST - Create AssetAPI endpoint with the data.type set to facewear. Once the asset is created, the files will be stored by Ready Player Me.

If you don't have the files yet available at a public URL for use with the Create Asset API endpoint, you can use the temporary storage solution provided by us via the POST - Upload Asset Filesendpoint.

Download template facewear-bandana (). The template project contains a reference head model and a facewear model.

Create a headwear model as a single object. It should fit the provided head model reference in the facewear-bandana-03.blend template project. ->

Furthermore, if you need to support deformations of the facewear for animations of the face, e.g. a talking avatar, you can add blendshapes to the facewear. Check the documentation on .

Occlusion map: Optional We recommend to pack the occlusion map into the red-channel of the metallicRoughnessTexture. See on how to export it.

Using the interface, you can navigate to the Asset Manager, and then choose Add new asset, or directly go to .

Once the export is complete, open Ready Player Me Studio () and upload your creation. The asset will be validated on upload. Learn more .

🖌️
Download
Check out modeling guidelines
morph targets
Blender documentation
Ready Player Me Studio
https://studio.readyplayer.me/asset-management/new
Asset Manager
Asset Manager in Studio
Example bandanas on Ready Player Me Avatars
Export Settings in Blender