https://github.com/readyplayerme/rpm-unity-sdk-core

This Module contains all the core functionality required for using Ready Player Me avatars in Unity, including avatar loading and creation
https://github.com/readyplayerme/rpm-unity-sdk-core

avatars readyplayerme unity unity3d

Last synced: 6 months ago
JSON representation

This Module contains all the core functionality required for using Ready Player Me avatars in Unity, including avatar loading and creation

• Host: GitHub
• URL: https://github.com/readyplayerme/rpm-unity-sdk-core
• Owner: readyplayerme
• License: mit
• Created: 2022-10-13T14:45:37.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-01T05:34:51.000Z (over 1 year ago)
• Last Synced: 2024-05-02T02:57:53.016Z (over 1 year ago)
• Topics: avatars, readyplayerme, unity, unity3d
• Language: C#
• Homepage:
• Size: 36.6 MB
• Stars: 72
• Watchers: 5
• Forks: 24
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Support: SUPPORT.md

Awesome Lists containing this project

README

          
# Ready Player Me Unity SDK Core

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/readyplayerme/rpm-unity-sdk-core)](https://github.com/readyplayerme/rpm-unity-sdk-core/releases/latest) [![GitHub Discussions](https://img.shields.io/github/discussions/readyplayerme/rpm-unity-sdk-core)](https://github.com/readyplayerme/rpm-unity-sdk-core/discussions) [![Run Integration Tests](https://github.com/readyplayerme/rpm-unity-sdk-core/actions/workflows/integration-test.yml/badge.svg)](https://github.com/readyplayerme/rpm-unity-sdk-core/actions/workflows/integration-test.yml)

This is an open source Unity plugin that contains all the core functionality required for a Ready Player Me avatar integration, and manages all the plugin updates and dependencies including Ready Player Me Avatar Loader and glTFast. 

Please visit the online documentation and join our public `forums` community.

![](https://i.imgur.com/zGamwPM.png) **[Online Documentation]( https://docs.readyplayer.me/ready-player-me/integration-guides/unity )**

![](https://github.com/readyplayerme/rpm-unity-sdk-webview/assets/25016626/130b50db-d6af-4277-9da3-03172bc085eb) **[Forums](https://forum.readyplayer.me/)**

:octocat: **[GitHub Discussions]( https://github.com/readyplayerme/rpm-unity-sdk-core/discussions )**

## Quick Start

The installation steps can be found [here.](Documentation~/QuickStart.md)

## Avatar Creator

### Supported Platforms

- Windows/Mac/Linux Standalone

- Android*

- iOS*

### Sample

Steps for trying out avatar creator sample can be found [here.](Documentation~/AvatarCreatorSample.md).

### Structure

- It provides APIs for creating, customizing and loading the avatar.

- It also contains a sample which demonstrates the usage of the APIs and replicates RPM web avatar creator.

- The documentation of provided sample can be found [here.](Documentation~/SampleStructure.md)

### Customization Guide

A guide for customizing avatar creator can be found [here.](Documentation~/CustomizationGuide.md)

### Note

- Camera support is only provided for Windows and WebGL, using Unity’s webcam native API.

- Unity does not have a native file picker, so we have discontinued support for this feature.

- To add support for file picker (for selfies) you have to implement it yourself