From e3246e94f606780a1952ec4ff304e6aec28630a6 Mon Sep 17 00:00:00 2001 From: vontell Date: Tue, 24 Sep 2024 15:55:15 -0400 Subject: [PATCH 1/5] Release 0.0.28 --- docs/changelog.mdx | 22 ++++++++++++++++++++++ docs/overview.md | 4 ++-- docs/quickstart.mdx | 4 ++-- docs/tutorials/building-your-first-bot.mdx | 4 ++-- package.json | 2 +- src/pages/index.tsx | 2 +- 6 files changed, 30 insertions(+), 8 deletions(-) diff --git a/docs/changelog.mdx b/docs/changelog.mdx index 674df16..f8865d3 100644 --- a/docs/changelog.mdx +++ b/docs/changelog.mdx @@ -4,6 +4,28 @@ sidebar_label: 'Changelog' # Changelog +## Release 0.0.28 + +_September 23, 2024_ + +**New Features** + +- Bot Sequences can now be created, edited, and deleted directly from the in-game overlay +- Bot segments that rely on image sources can now load images from paths vs just raw data +- Direct login is no longer supported for the SDK; API keys are now required +- Bot Sequences are now reloaded automatically from disk when played +- Object detection bot segments can now define a confidence threshold (text queries only) + +**Bug Fixes** + +- Improved language and explanations within the website +- Properly handle failing behaviour segments that dont load or timeout +- Use of computer-vision capabilities now requires authentication +- Sprite rendering within the SDK has been improved +- Fixed a bug where the overlay would throw a null exception when opening for the first time +- Fixed issues where the game would hang when starting +- Data from the end of a segment is now properly saved + ## Release 0.0.27 _September 9, 2024_ diff --git a/docs/overview.md b/docs/overview.md index d380e28..15eb0a2 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -43,7 +43,7 @@ clicking **Add package from git URL** in the **Package Manager** window (this wi in the **Window > Package Manager** menu) and pasting in the following URL. ``` -https://github.com/Regression-Games/RGUnityBots.git?path=src/gg.regression.unity.bots#v0.0.27 +https://github.com/Regression-Games/RGUnityBots.git?path=src/gg.regression.unity.bots#v0.0.28 ``` - Note that this package utilizes TextMeshPro. If you are prompted by Unity to add TextMeshPro assets to your project, please add them. @@ -51,7 +51,7 @@ https://github.com/Regression-Games/RGUnityBots.git?path=src/gg.regression.unity - If your game utilizes Unity's ECS, we now have an extension package available to support it. Install this package after installing the core RGUnityBots package: ``` -https://github.com/Regression-Games/RGUnityBots/tree/main/src/gg.regression.unity.bots.ecs#v0.0.27 +https://github.com/Regression-Games/RGUnityBots/tree/main/src/gg.regression.unity.bots.ecs#v0.0.28 ![Screenshot of the package imported into the project](tutorials/img/building-your-first-bot/tutorial-1-package.png) diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index ec04783..6fa3acb 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -25,7 +25,7 @@ clicking **Add package from git URL** in the **Package Manager** window (this wi in the **Window > Package Manager** menu) and pasting in the following URL. ``` -https://github.com/Regression-Games/RGUnityBots.git?path=src/gg.regression.unity.bots#v0.0.27 +https://github.com/Regression-Games/RGUnityBots.git?path=src/gg.regression.unity.bots#v0.0.28 ``` - Note that this package uses the new Unity Input System, and will likely ask you to restart the editor - **please select yes to restart**. @@ -34,7 +34,7 @@ https://github.com/Regression-Games/RGUnityBots.git?path=src/gg.regression.unity - If your game utilizes Unity's ECS, we now have an extension package available to support it. Install this package after installing the core RGUnityBots package: ``` -https://github.com/Regression-Games/RGUnityBots/tree/main/src/gg.regression.unity.bots.ecs#v0.0.27 +https://github.com/Regression-Games/RGUnityBots/tree/main/src/gg.regression.unity.bots.ecs#v0.0.28 ``` diff --git a/docs/tutorials/building-your-first-bot.mdx b/docs/tutorials/building-your-first-bot.mdx index 3dca3eb..2afb83c 100644 --- a/docs/tutorials/building-your-first-bot.mdx +++ b/docs/tutorials/building-your-first-bot.mdx @@ -42,7 +42,7 @@ You can find [our package on GitHub](https://github.com/Regression-Games/RGUnity the **Package Manager** window (**Window** > **Package Manager**) and click **Add package from git URL**. Then, paste the following URL: ``` -https://github.com/Regression-Games/RGUnityBots.git?path=src/gg.regression.unity.bots#v0.0.27 +https://github.com/Regression-Games/RGUnityBots.git?path=src/gg.regression.unity.bots#v0.0.28 ``` :::info @@ -54,7 +54,7 @@ https://github.com/Regression-Games/RGUnityBots.git?path=src/gg.regression.unity If your game utilizes Unity's ECS, we now have an extension package available to support it. ``` -https://github.com/Regression-Games/RGUnityBots/tree/main/src/gg.regression.unity.bots.ecs#v0.0.27 +https://github.com/Regression-Games/RGUnityBots/tree/main/src/gg.regression.unity.bots.ecs#v0.0.28 ``` Install this package in addition to / after installing the core RGUnityBots package. diff --git a/package.json b/package.json index 4e25800..b6870a8 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "regression-docs", - "version": "0.0.27", + "version": "0.0.28", "private": true, "scripts": { "docusaurus": "docusaurus", diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 7afcbac..4f6f395 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -23,7 +23,7 @@ const HomepageHeader = () => (
Get started immediately by adding the package to Unity:
- 
https://github.com/Regression-Games/RGUnityBots.git?path=src/gg.regression.unity.bots#v0.0.27
+ 
https://github.com/Regression-Games/RGUnityBots.git?path=src/gg.regression.unity.bots#v0.0.28
From 75a260d908e42f3b6e7f4c04c4147e16f5987160 Mon Sep 17 00:00:00 2001 From: vontell Date: Tue, 24 Sep 2024 17:11:49 -0400 Subject: [PATCH 2/5] Fix URL for ECS package --- docs/quickstart.mdx | 2 +- docs/tutorials/building-your-first-bot.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 6fa3acb..7e7029a 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -34,7 +34,7 @@ https://github.com/Regression-Games/RGUnityBots.git?path=src/gg.regression.unity - If your game utilizes Unity's ECS, we now have an extension package available to support it. Install this package after installing the core RGUnityBots package: ``` -https://github.com/Regression-Games/RGUnityBots/tree/main/src/gg.regression.unity.bots.ecs#v0.0.28 +https://github.com/Regression-Games/RGUnityBots.git?path=src/gg.regression.unity.bots.ecs#v0.0.28 ``` diff --git a/docs/tutorials/building-your-first-bot.mdx b/docs/tutorials/building-your-first-bot.mdx index 2afb83c..67bba1b 100644 --- a/docs/tutorials/building-your-first-bot.mdx +++ b/docs/tutorials/building-your-first-bot.mdx @@ -54,7 +54,7 @@ https://github.com/Regression-Games/RGUnityBots.git?path=src/gg.regression.unity If your game utilizes Unity's ECS, we now have an extension package available to support it. ``` -https://github.com/Regression-Games/RGUnityBots/tree/main/src/gg.regression.unity.bots.ecs#v0.0.28 +https://github.com/Regression-Games/RGUnityBots.git?path=src/gg.regression.unity.bots.ecs#v0.0.28 ``` Install this package in addition to / after installing the core RGUnityBots package. From 04492a0c7dc864afe9302446be4511641522ed95 Mon Sep 17 00:00:00 2001 From: Aaron Vontell Date: Wed, 25 Sep 2024 09:17:18 -0400 Subject: [PATCH 3/5] Update docs/changelog.mdx Co-authored-by: RG-nAmKcAz <112959031+RG-nAmKcAz@users.noreply.github.com> --- docs/changelog.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelog.mdx b/docs/changelog.mdx index f8865d3..21eb6c0 100644 --- a/docs/changelog.mdx +++ b/docs/changelog.mdx @@ -24,7 +24,7 @@ _September 23, 2024_ - Sprite rendering within the SDK has been improved - Fixed a bug where the overlay would throw a null exception when opening for the first time - Fixed issues where the game would hang when starting -- Data from the end of a segment is now properly saved +- Data for the last segment of a recording is now properly saved ## Release 0.0.27 From 10f15c123e7b2ca6ccfd9ae37c37c214d35dd241 Mon Sep 17 00:00:00 2001 From: Aaron Vontell Date: Wed, 25 Sep 2024 09:17:32 -0400 Subject: [PATCH 4/5] Update docs/changelog.mdx Co-authored-by: RG-nAmKcAz <112959031+RG-nAmKcAz@users.noreply.github.com> --- docs/changelog.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelog.mdx b/docs/changelog.mdx index 21eb6c0..e18f815 100644 --- a/docs/changelog.mdx +++ b/docs/changelog.mdx @@ -23,7 +23,7 @@ _September 23, 2024_ - Use of computer-vision capabilities now requires authentication - Sprite rendering within the SDK has been improved - Fixed a bug where the overlay would throw a null exception when opening for the first time -- Fixed issues where the game would hang when starting +- Fixed issues causing the game to freeze for a few seconds when starting - Data for the last segment of a recording is now properly saved ## Release 0.0.27 From 5ed11aa0e3d03f1e83da058d90d8a53f9a230be8 Mon Sep 17 00:00:00 2001 From: vontell Date: Wed, 25 Sep 2024 09:19:00 -0400 Subject: [PATCH 5/5] Add API key clarification --- docs/changelog.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelog.mdx b/docs/changelog.mdx index e18f815..b08365f 100644 --- a/docs/changelog.mdx +++ b/docs/changelog.mdx @@ -20,7 +20,7 @@ _September 23, 2024_ - Improved language and explanations within the website - Properly handle failing behaviour segments that dont load or timeout -- Use of computer-vision capabilities now requires authentication +- Use of computer-vision capabilities now requires authentication by setting an API key in the SDK settings - Sprite rendering within the SDK has been improved - Fixed a bug where the overlay would throw a null exception when opening for the first time - Fixed issues causing the game to freeze for a few seconds when starting