40 lines
2.2 KiB
Markdown
40 lines
2.2 KiB
Markdown
|
# Ready Player Me Unity SDK Core
|
|||
|
|
|
|||
|
|
[](https://github.com/readyplayerme/rpm-unity-sdk-core/releases/latest) [](https://github.com/readyplayerme/rpm-unity-sdk-core/discussions) [](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.
|
|||
|
|
|
|||
|
|
 **[Online Documentation]( https://docs.readyplayer.me/ready-player-me/integration-guides/unity )**
|
|||
|
|
|
|||
|
|
 **[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
|