From 4389ae8ecc9874b78262306401b16a83941ae817 Mon Sep 17 00:00:00 2001 From: Malcolm Nixon Date: Tue, 23 Apr 2024 19:28:08 -0400 Subject: [PATCH] Add avatar download instructions. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 4c86585..b46965a 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,18 @@ RpmLoader.load_web("65fa409029044c117cbd3e3c") RpmLoader.load_file("C:/temp/66039f031791600d6e5147b0.glb", "66039f031791600d6e5147b0") ``` +### Avatar Format + +All avatars must be in the `T` pose or the avatar will be corrupted. The `load_web` method provides the following download parameters: + +| Parameter | Value | +| :---- | :---- | +| `quality` | `low` / `medium` / `high` | +| `pose` | `T` | +| `morphTargets` | `Default` / `ARKit` | + +See the [ReadyPlayerMe 3D Avatars Rest API](https://docs.readyplayer.me/ready-player-me/api-reference/rest-api/avatars/get-3d-avatars) documentation for a complete list of parameters. + ## Licensing Code in this repository is licensed under the MIT license.