Skip to content

Commit

Permalink
Update icon and readme information. (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
Malcolmnixon authored May 8, 2024
1 parent e1b118c commit 86ecd21
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 28 deletions.
27 changes: 9 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,13 @@
![GitHub contributors](https://img.shields.io/github/contributors/Malcolmnixon/GodotReadyPlayerMeAvatar?style=plastic)
![GitHub](https://img.shields.io/github/license/Malcolmnixon/GodotReadyPlayerMeAvatar?style=plastic)

This repository contains a [Ready Player Me](https://readyplayer.me/) avatar
loader for Godot that can load avatars at runtime from the internet or local
files, and can configure them to be driven through the XR tracker system.
This repository contains a [Ready Player Me](https://readyplayer.me/) avatar loader for Godot that can load avatars at runtime from the internet or local files, and can configure them to be driven through the XR tracker system.

![Avatar Demo](/docs/avatar_demo.png)

## Versions

Official releases are tagged and can be found [here](https://github.com/Malcolmnixon/GodotXRAxisStudioTracker/releases).
Official releases are tagged and can be found [here](https://github.com/Malcolmnixon/GodotReadyPlayerMeAvatar/releases).

The following branches are in active development:
| Branch | Description | Godot version |
Expand All @@ -22,34 +20,27 @@ The following branches are in active development:

## Overview

Ready Player Me is an avatar system for games, apps, and VR/AR experiences.
Avatars can be created online through the web interface; and then downloaded
over a REST interface.
Ready Player Me is an avatar system for games, apps, and VR/AR experiences. Avatars can be created online through the web interface; and then downloaded over a REST interface.

The Godot ReadyPlayerMe Avatar plugin supports downloading avatars given
their avatar ID. The avatars are downloaded and parsed in the background
and then provided to the user code as nodes ready for adding to a scene.
The Godot ReadyPlayerMe Avatar plugin supports downloading avatars given their avatar ID. The avatars are downloaded and parsed in the background and then provided to the user code as nodes ready for adding to a scene.

## Usage

The following steps shw how to add the Godot ReadyPlayerMe Avatar plugin to a
project.
The following steps show how to add the Godot ReadyPlayerMe Avatar plugin to a project.

### Enable Plugin

The addon files need to be copied to the `/addons/godot_rpm_avatar` folder of
the Godot project, and then enabled in the Plugins under the Project Settings:
The addon files need to be copied to the `/addons/godot_rpm_avatar` folder of the Godot project, and then enabled in the Plugins under the Project Settings:
![Enable Plugin](/docs/enable_plugin.png)

Once enabled, the `rpm_loader.gd` script will be configured as an autoload
node called `RpmLoader`.
Once enabled, the `rpm_loader.gd` script will be configured as an autoload node called `RpmLoader`.

### Configuring Avatars

An `RpmSettings` resource is used to configure how avatars are loaded:
![RPM Settings](/docs/rpm_settings.png)
* `body_tracker` - The name of the XRBodyTracker to drive the avatar
* `face_tracker` - The name of the XRFaceTracker to drive the avatar
* `body_tracker` - The name of the [XRBodyTracker](https://docs.godotengine.org/en/latest/classes/class_xrbodytracker.html#class-xrbodytracker) to drive the avatar
* `face_tracker` - The name of the [XRFaceTracker](https://docs.godotengine.org/en/latest/classes/class_xrfacetracker.html) to drive the avatar
* `quality` - Quality of the avatar to load

### Load Signals
Expand Down
Binary file added icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 4 additions & 7 deletions icon.svg.import → icon.png.import
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

importer="texture"
type="CompressedTexture2D"
uid="uid://d2w8o4j2irgdk"
path="res://.godot/imported/icon.svg-218a8f2b3041327d8a5756f3a245f83b.ctex"
uid="uid://boqoxgn0lvqmh"
path="res://.godot/imported/icon.png-487276ed1e3a0c39cad0279d744ee560.ctex"
metadata={
"vram_texture": false
}

[deps]

source_file="res://icon.svg"
dest_files=["res://.godot/imported/icon.svg-218a8f2b3041327d8a5756f3a245f83b.ctex"]
source_file="res://icon.png"
dest_files=["res://.godot/imported/icon.png-487276ed1e3a0c39cad0279d744ee560.ctex"]

[params]

Expand All @@ -32,6 +32,3 @@ process/hdr_as_srgb=false
process/hdr_clamp_exposure=false
process/size_limit=0
detect_3d/compress_to=1
svg/scale=1.0
editor/scale_with_editor_scale=false
editor/convert_colors_with_editor_theme=false
1 change: 0 additions & 1 deletion icon.svg

This file was deleted.

2 changes: 1 addition & 1 deletion load_test.tscn
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[gd_scene load_steps=7 format=4 uid="uid://cq8p13kfy4cuf"]
[gd_scene load_steps=7 format=3 uid="uid://cq8p13kfy4cuf"]

[ext_resource type="Script" path="res://load_test.gd" id="1_ha8ec"]
[ext_resource type="Script" path="res://addons/godot_rpm_avatar/rpm_settings.gd" id="2_fq1tk"]
Expand Down
2 changes: 1 addition & 1 deletion project.godot
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ config_version=5
config/name="Godot ReadyPlayerMe Avatar"
run/main_scene="res://load_test.tscn"
config/features=PackedStringArray("4.3", "Mobile")
config/icon="res://icon.svg"
config/icon="res://icon.png"

[autoload]

Expand Down

0 comments on commit 86ecd21

Please sign in to comment.