diff --git a/.github/latest.md b/.github/latest.md index f0b6a4ed..07e09e88 100644 --- a/.github/latest.md +++ b/.github/latest.md @@ -1,9 +1,12 @@ ## Changelog +### Breaking Changes +- Merge avatar creator into core by @ryuuk in [#135](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/135). +- AvatarProcessor no longer searches and replaces existing avatar by @rk132 in [#138](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/138) + ### Added -- moved core iframe and url logic from WebView package @harrisonhough in [#125](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/125) +- show Avatar Creator sample button in guide by @ryuuk in [#141](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/141) ### Updated -- refactored core settings handler @harrisonhough in [#124](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/124) -- centred all editor window content @harrisonhough in [#122](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/122) +- merged related samples into single folders by @harrisonhough in [#139](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/139) diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml index c501d9ce..084ded36 100644 --- a/.github/workflows/integration-test.yml +++ b/.github/workflows/integration-test.yml @@ -1,4 +1,4 @@ -name: Run Integration Tests +name: Integration Tests on: push: diff --git a/CHANGELOG.md b/CHANGELOG.md index abc3b447..3d1b9bb1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,18 @@ All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [4.0.0] - 2023.11.01 + +### Breaking Changes +- Merge avatar creator into core by @ryuuk in [#135](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/135). +- AvatarProcessor no longer searches and replaces existing avatar by @rk132 in [#138](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/138) + +### Added +- show Avatar Creator sample button in guide by @ryuuk in [#141](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/141) + +### Updated +- merged related samples into single folders by @harrisonhough in [#139](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/139) + ## [3.4.0] - 2023.10.24 ### Added diff --git a/Editor/Analytics/Constants.cs b/Editor/Analytics/Constants.cs index af7ad3e9..73b4373b 100644 --- a/Editor/Analytics/Constants.cs +++ b/Editor/Analytics/Constants.cs @@ -68,6 +68,7 @@ public static class Links public const string DOCS_LOAD_AVATAR = "https://docs.readyplayer.me/ready-player-me/integration-guides/unity/load-avatars#save-avatars-as-npcs-in-your-project"; public const string DOCS_AVATAR_CONFIG_LINK = "https://docs.readyplayer.me/ready-player-me/integration-guides/unity/optimize/avatar-configuration"; public const string DOCS_AVATAR_CACHING = "https://docs.readyplayer.me/ready-player-me/integration-guides/unity/optimize/avatar-caching"; + public const string APP_ID = "https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/custom-avatar-creator#prerequisites"; } } } diff --git a/Editor/Module Management/ModuleList.cs b/Editor/Module Management/ModuleList.cs index 430ccf36..76b306f4 100644 --- a/Editor/Module Management/ModuleList.cs +++ b/Editor/Module Management/ModuleList.cs @@ -14,7 +14,7 @@ public static class ModuleList name = "com.readyplayerme.core", gitUrl = "https://github.com/readyplayerme/rpm-unity-sdk-core.git", branch = "", - version = "3.3.0" + version = "4.0.0" }; /// diff --git a/Editor/UI/EditorWindows/SettingsWindow/SettingsEditor.cs b/Editor/UI/EditorWindows/SettingsWindow/SettingsEditor.cs index 7fc855ed..1435c56e 100644 --- a/Editor/UI/EditorWindows/SettingsWindow/SettingsEditor.cs +++ b/Editor/UI/EditorWindows/SettingsWindow/SettingsEditor.cs @@ -37,8 +37,8 @@ public class SettingsEditor : EditorWindow private const string ANALYTICS_PRIVACY_URL = "https://docs.readyplayer.me/ready-player-me/integration-guides/unity/help-us-improve-the-unity-sdk"; - private const string DOCS_URL = "https://bit.ly/UnitySDKDocs"; - private const string FAQ_URL = "https://docs.readyplayer.me/overview/frequently-asked-questions/game-engine-faq"; + private const string DOCS_URL = "https://docs.readyplayer.me/ready-player-me/integration-guides/unity"; + private const string FAQ_URL = "https://docs.readyplayer.me/ready-player-me/integration-guides/unity/faq-for-unity"; private const string DISCORD_URL = "https://bit.ly/UnitySDKDiscord"; private const string PRIVACY_POLICY_LABEL = "PrivacyPolicyLabel"; diff --git a/Editor/UI/EditorWindows/Templates/AppIdTemplate.cs b/Editor/UI/EditorWindows/Templates/AppIdTemplate.cs index 768ae134..cf500cbc 100644 --- a/Editor/UI/EditorWindows/Templates/AppIdTemplate.cs +++ b/Editor/UI/EditorWindows/Templates/AppIdTemplate.cs @@ -36,7 +36,7 @@ public AppIdTemplate() private static void OnAppIdHelpClicked() { AnalyticsEditorLogger.EventLogger.LogFindOutMore(HelpSubject.Subdomain); - Application.OpenURL(Constants.Links.DOCS_PARTNERS_LINK); + Application.OpenURL(Constants.Links.APP_ID); } private void OnAppIdFocusOut(FocusOutEvent _) diff --git a/README.md b/README.md index 5b63086d..fc2f1d87 100644 --- a/README.md +++ b/README.md @@ -37,3 +37,73 @@ A guide for customizing avatar creator can be found [here.](Documentation~/Custo - [*]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 + +`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. + +After the process is complete you project will have imported these packages: + +- **Ready Player Me Core** +- **Ready Player Me WebView** +- **glTFast** + +![image](https://github.com/readyplayerme/rpm-unity-sdk-core/assets/1121080/234ff559-cb19-4b39-bb14-a5621db1811b) + +## 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": "4.0.0" + } + } + ``` + diff --git a/Runtime/Data/ApplicationData.cs b/Runtime/Data/ApplicationData.cs index 6080494d..bbc9106e 100644 --- a/Runtime/Data/ApplicationData.cs +++ b/Runtime/Data/ApplicationData.cs @@ -6,7 +6,7 @@ namespace ReadyPlayerMe.Core { public static class ApplicationData { - private const string SDK_VERSION = "v3.4.0"; + private const string SDK_VERSION = "v4.0.0"; private const string TAG = "ApplicationData"; private const string DEFAULT_RENDER_PIPELINE = "Built-In Render Pipeline"; private static readonly AppData Data; diff --git a/package.json b/package.json index 7e5006fe..20486fa2 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "com.readyplayerme.core", - "version": "3.4.0", + "version": "4.0.0", "displayName": "Ready Player Me Core", "description": "This Module contains all the core functionality required for using Ready Player Me avatars in Unity, including features such as: \n - Module management and automatic package setup logic\n - Avatar loading from .glb files \n - Avatar creation \n - Avatar and 2D render requests \n - Optional Analytics\n - Custom editor windows\n - Sample scenes and assets", "unity": "2020.3", @@ -50,4 +50,4 @@ "path": "Samples~/AvatarCreatorSamples" } ] -} +} \ No newline at end of file