Merge branch 'develop' into release/v4.0.0

readyplayerme · Nov 1, 2023 · 1c5cb0d · 1c5cb0d
2 parents 2b4650f + 50abeea
commit 1c5cb0d
Show file tree

Hide file tree

Showing 4 changed files with 93 additions and 23 deletions.
diff --git a/Documentation~/AvatarCreatorSample.md b/Documentation~/AvatarCreatorSample.md
@@ -0,0 +1,9 @@
+## Avatar Creator Sample
+
+**1.** Import sample from package manager window, you will have samples folder with AvatarCreatorSamples in it.
+![image](https://github.com/readyplayerme/rpm-unity-sdk-core/assets/1121080/d6904d21-596b-431a-abbc-4e9d7f88bd34)
+
+**2.**  Open AvatarCreatorSample scene and run it.
+![image](https://github.com/readyplayerme/rpm-unity-sdk-core/assets/1121080/8ec2fe62-5186-4dc6-a809-e46728ff13d9)
+
+**Important! AppID and subdomain should be set in settings and AppID must belong to the subdomain you set otherwise authorization will fail.**
diff --git a/Documentation~/CustomizationGuide.md.meta b/Documentation~/CustomizationGuide.md.meta
diff --git a/Documentation~/QuickStart.md b/Documentation~/QuickStart.md
@@ -1,10 +1,12 @@
-## Quick Start
+# Quick Start
 
-## Importing Package
+### Requirements
+- Unity Version 2020.3 or higher
+- [Git](https://git-scm.com) needs to be installed to fetch the Unity package. [Download here](https://git-scm.com/downloads)
 
-**1.** To add the new Ready Player Me Unity Avatar Creator to your project you can use the Unity Package Manager to import the package directly from the Git URL.
+**1.** To add the new Ready Player Me Unity SDK to your project you can use the Unity Package Manager to import the package directly from the Git URL.
 
-**2.** With your Unity Project open open up the Package Manager window by going to `Window > Package Manager`.
+**2.** With your Unity Project open, open up the Package Manager window by going to `Window > Package Manager`.
 
 ![open-package-manager](https://user-images.githubusercontent.com/7085672/206432665-da233187-06ad-40b5-a25e-660c97d6726f.png)
 
@@ -14,18 +16,70 @@
 
 **4.** Paste in this url
 
-`https://github.com/readyplayerme/rpm-unity-sdk-avatar-creator.git`
+`https://github.com/readyplayerme/rpm-unity-sdk-core.git`
 
 ![paste-git-url](https://user-images.githubusercontent.com/7085672/206432731-f9e0d161-7843-4d6e-8851-47b1f3bfb3bc.png)
 
 **5.** Click add and wait for the import process to finish.
-![image](https://user-images.githubusercontent.com/1121080/216085330-d09e1578-5192-4900-8dd5-27264acec484.png)
 
-**6.** Next import samples, you will have samples folder with AvatarCreatorExample scene.
+After the process is complete you project will have imported these packages:
 
-![image](https://user-images.githubusercontent.com/1121080/216086222-a5165359-e660-45fa-895a-b7fed7dd70d6.png)
+- **Ready Player Me Core**
+- **Ready Player Me WebView**
+- **glTFast**
 
-**7.** Set subdomain & AppID in CoreSettings scriptable object. **Important! AppID must belong to the subdomain you set otherwise authorization will fail.**
+![image](https://github.com/readyplayerme/rpm-unity-sdk-core/assets/1121080/234ff559-cb19-4b39-bb14-a5621db1811b)
 
-**8.** Run and test.
-![image](https://user-images.githubusercontent.com/1121080/216086593-df4a9e24-25c1-42d6-8b7f-4946352fdebb.png)
+## Alternate Installation
+
+### Using Git URL
+
+1. Navigate to your project's Packages folder and open the manifest.json file.
+2. Add this line below the `"dependencies": {` line
+    - ```json title="Packages/manifest.json"
+      "com.readyplayerme.core": "https://github.com/readyplayerme/rpm-unity-sdk-core.git",
+      ```
+3. UPM should now install the package.
+
+### OpenUPM (using command line)
+
+1. The package is available on the [openupm registry](https://openupm.com).
+2. Execute the openum command.
+    - ```
+      openupm add com.readyplayerme.core
+      ```
+### OpenUPM (using editor)
+
+1. Open `Edit | Project Settings | Package Manager`
+2. Add a new Scoped Registry (or edit the existing OpenUPM entry)
+   - ```
+     Name     package.openupm.com
+     URL      https://package.openupm.com
+     Scope(s) com.readyplayerme.core
+     ```
+3. Click Save (or Apply)
+4. Open Window/Package Manager
+5. Click +
+6. Select Add package by name... or Add package from git URL...
+7. Paste `com.readyplayerme.core` into name
+8. Click Add
+
+### OpenUPM (using manifest)
+
+1. Add this to manifest
+   - ```{
+     "scopedRegistries": [
+        {
+            "name": "package.openupm.com",
+            "url": "https://package.openupm.com",
+            "scopes": [
+                "com.readyplayerme.core"
+            ]
+        }
+     ],
+     "dependencies": {
+        "com.readyplayerme.core": "3.4.0"
+       }
+     }
+     ```
+
diff --git a/README.md b/README.md
@@ -12,21 +12,31 @@ Please visit the online documentation and join our public `discord` community.
 
 :octocat: **[GitHub Discussions]( https://github.com/readyplayerme/rpm-unity-sdk-core/discussions )**
 
-## Quick Start 
+## Quick Start
+The installation steps can be found [here.](Documentation~/QuickStart.md)
 
-### Requirements
-- Unity Version 2020.3 or higher
-- [Git](https://git-scm.com) needs to be installed to fetch the Unity package. [Download here](https://git-scm.com/downloads)
+## Avatar Creator
 
-**1.** To add the new Ready Player Me Unity SDK to your project you can use the Unity Package Manager to import the package directly from the Git URL. 
+### Supported Platforms
+- Windows/Mac/Linux Standalone
+- Android*
+- iOS*
 
-**2.** With your Unity Project open, open up the Package Manager window by going to `Window > Package Manager`.
+### Sample
+Steps for trying out avatar creator sample can be found [here.](Documentation~/AvatarCreatorSample.md).
 
-![open-package-manager](https://user-images.githubusercontent.com/7085672/206432665-da233187-06ad-40b5-a25e-660c97d6726f.png)
+### 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)
 
-**3.** In the **Package Manager** window click on the + icon in the top left corner and select Add Package From Git URL.
+### Customization Guide
+A guide for customizing avatar creator can be found [here.](Documentation~/CustomizationGuide.md)
 
-![add-package-from-ur;](https://user-images.githubusercontent.com/7085672/206432698-8ecde741-4259-486f-9c77-d63fbc9a6cde.png)
+### 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
 
 **4.** Paste in this url