Skip to content

Commit

Permalink
Add avatar download instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
Malcolmnixon committed Apr 23, 2024
1 parent 0b1ae41 commit 4389ae8
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 4389ae8

Please sign in to comment.