revise documentation to point to fab instead of ue marketplace
This commit is contained in:
Mamadou Babaei
+1
-1
@@ -88,4 +88,4 @@ SG_RSYNC_SSH_BINARY_PATH_WINDOWS := $(SG_RSYNC_BIN_PATH_WINDOWS)\ssh.exe
|
|||||||
|
|
||||||
### make pack
|
### make pack
|
||||||
|
|
||||||
This target is meant to be used by the `sgum-packager` utility located in the [Packager](../Packager) folder in order to deploy the documentation in various formats along with the plugin to the Unreal Engine Marketplace.
|
This target is meant to be used by the `sgum-packager` utility located in the [Packager](../Packager) folder in order to deploy the documentation in various formats along with the plugin to [Fab](https://www.fab.com/).
|
||||||
|
|||||||
@@ -7,4 +7,4 @@ This handbook is an ongoing effort and a work in progress to document the SenseG
|
|||||||
Due to superior formatting and frequent updates, we recommend [the online version of the handbook]({{ #sg-handbook-revision-url }}); nonetheless, it's available in [PDF format]({{ #sg-handbook-pdf-url }}) as well.
|
Due to superior formatting and frequent updates, we recommend [the online version of the handbook]({{ #sg-handbook-revision-url }}); nonetheless, it's available in [PDF format]({{ #sg-handbook-pdf-url }}) as well.
|
||||||
|
|
||||||
> [!TIP]
|
> [!TIP]
|
||||||
> Feel free to check out [the SenseGlove Unreal Engine Plugin landing page on the UE Marketplace](https://www.unrealengine.com/marketplace/en-US/product/the-senseglove-unreal-engine-plugin) as well.
|
> Feel free to check out [the SenseGlove Unreal Engine Plugin landing page on Fab](https://www.fab.com/listings/62bcdd2a-0bb1-4f34-b7b8-c5e7c9313099) as well.
|
||||||
|
|||||||
@@ -11,8 +11,8 @@ Welcom to the SenseGlove Unreal Engine Handbook!
|
|||||||
# 🚀 Getting Started
|
# 🚀 Getting Started
|
||||||
|
|
||||||
- [Installation](getting-started/installation/README.md)
|
- [Installation](getting-started/installation/README.md)
|
||||||
- [Through the Epic Games Launcher](getting-started/installation/epic-games-launcher.md)
|
- [Via the Epic Games Launcher](getting-started/installation/epic-games-launcher.md)
|
||||||
- [Through Microsoft Azure DevOps Repositories](getting-started/installation/microsoft-azure-devops-repositories.md)
|
- [Via Microsoft Azure DevOps Repositories](getting-started/installation/microsoft-azure-devops-repositories.md)
|
||||||
- [Enabling and Verifying the Plugin Version](getting-started/plugin-verify-version-enable/README.md)
|
- [Enabling and Verifying the Plugin Version](getting-started/plugin-verify-version-enable/README.md)
|
||||||
- [SenseCom](getting-started/sensecom/README.md)
|
- [SenseCom](getting-started/sensecom/README.md)
|
||||||
- [SenseCom on GNU/Linux](getting-started/sensecom/gnu-linux/README.md)
|
- [SenseCom on GNU/Linux](getting-started/sensecom/gnu-linux/README.md)
|
||||||
|
|||||||
@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
|
|||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
## [Unreleased]
|
||||||
|
|
||||||
|
This patch release focuses exclusively on updates to the documentation.
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
|
||||||
|
- Updated all URLs, screenshots, and tutorials to reflect the transition from the Unreal Engine Marketplace to Fab, Epic’s new unified content marketplace.
|
||||||
|
- Revised documentation now points to the new home of the SenseGlove Unreal Engine Plugin on Fab, ensuring users have access to the latest resources and information.
|
||||||
|
|
||||||
## [2.2.0] - 2024-10-22
|
## [2.2.0] - 2024-10-22
|
||||||
|
|
||||||
This is a minor release with some breaking API and ABI changes, focusing mainly on migrating away from the deprecated `FXRMotionControllerData` in favor of `FXRMotionControllerState` and `FXRHandTrackingState` on Unreal Engine `5.5+`.
|
This is a minor release with some breaking API and ABI changes, focusing mainly on migrating away from the deprecated `FXRMotionControllerData` in favor of `FXRMotionControllerState` and `FXRHandTrackingState` on Unreal Engine `5.5+`.
|
||||||
|
|||||||
@@ -7,7 +7,7 @@
|
|||||||
│
|
│
|
||||||
├── Documentation (this will be generated by running the <code>make</code> command inside the Handbook directory)
|
├── Documentation (this will be generated by running the <code>make</code> command inside the Handbook directory)
|
||||||
│
|
│
|
||||||
├── Handbook (this is the mdBook source code, used to generate the Documentation folder and not distributed to the Unreal Engine Marketplace)
|
├── Handbook (this is the mdBook source code, used to generate the Documentation folder and not distributed to [Fab](https://www.fab.com/))
|
||||||
│
|
│
|
||||||
├── Resources
|
├── Resources
|
||||||
│
|
│
|
||||||
|
|||||||
@@ -1,19 +1,19 @@
|
|||||||
## Platform Support Matrix
|
## Platform Support Matrix
|
||||||
|
|
||||||
| | **Windows (MSVC 2017)** | **Windows (MSVC 2019)** | **Windows (MSVC 2022)** | **Linux x86-64 (Native Toolchain)** | **Linux AArch64 (Native Toolchain)** | **Meta Quest Stand-alone (Android NDK)** | **HTC VIVE Stand-alone (Android NDK)** | **UE Marketplace Version** | **Azure DevOps Version** |
|
| | **Windows (MSVC 2017)** | **Windows (MSVC 2019)** | **Windows (MSVC 2022)** | **Linux x86-64 (Native Toolchain)** | **Linux AArch64 (Native Toolchain)** | **Meta Quest Stand-alone (Android NDK)** | **HTC VIVE Stand-alone (Android NDK)** | **Fab** | **Azure DevOps Version** |
|
||||||
|:--------:|:-----------------------:|:-----------------------:|:-----------------------:|:-----------------------------------:|:------------------------------------:|:----------------------------------------:|:--------------------------------------:|:--------------------------:|:------------------------:|
|
|:--------:|:-----------------------:|:-----------------------:|:-----------------------:|:-----------------------------------:|:------------------------------------:|:----------------------------------------:|:--------------------------------------:|:--------:|:------------------------:|
|
||||||
| **5.5** | ❌ | ❌ | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x (r25b) | ❓ | ❌ | ✅ v2.2.0 |
|
| **5.5** | ❌ | ❌ | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x (r25b) | ❓ | ❌ | ✅ v2.2.0 |
|
||||||
| **5.4** | ❌ | ❌ | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x (r25b) | ❓ | ✅ v2.1.2 | ✅ v2.2.0 |
|
| **5.4** | ❌ | ❌ | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x (r25b) | ❓ | ✅ v2.2.0 | ✅ v2.2.0 |
|
||||||
| **5.3** | ❌ | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x (r25b) | ❓ | ✅ v2.1.2 | ✅ v2.2.0 |
|
| **5.3** | ❌ | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x (r25b) | ❓ | ✅ v2.2.0 | ✅ v2.2.0 |
|
||||||
| **5.2** | ❌ | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x (r25b) | ❓ | ✅ v2.1.2 | ✅ v2.2.0 |
|
| **5.2** | ❌ | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x | ✅ v2.2.x (r25b) | ❓ | ✅ v2.2.0 | ✅ v2.2.0 |
|
||||||
| **5.1** | ❌ | ⚠️ v2.0.x | ⚠️ v2.0.x | ⚠️ v2.0.x | ⚠️ v2.0.x | ⚠️ v2.0.x (r25b) | ❓ | ⚠️ v2.0.1 | ⚠️ v2.0.2 |
|
| **5.1** | ❌ | ⚠️ v2.0.x | ⚠️ v2.0.x | ⚠️ v2.0.x | ⚠️ v2.0.x | ⚠️ v2.0.x (r25b) | ❓ | ⚠️ v2.0.0 | ⚠️ v2.0.2 |
|
||||||
| **5.0** | ❌ | ⚠️ v1.6.x | ⚠️ v1.6.x | ⚠️ v1.6.x | ⚠️ v1.6.x | ⚠️ v1.6.x (r21e) | ❓ | ⚠️ v1.6.1 | ⚠️ v1.6.1 |
|
| **5.0** | ❌ | ⚠️ v1.6.x | ⚠️ v1.6.x | ⚠️ v1.6.x | ⚠️ v1.6.x | ⚠️ v1.6.x (r21e) | ❓ | ⚠️ v1.6.1 | ⚠️ v1.6.1 |
|
||||||
| **4.27** | ⚠️ v1.4.x | ⚠️ v1.4.x | ⚠️ v1.4.x | ⚠️ v1.4.x | ⚠️ v1.4.x | ⚠️ v1.4.x (r21e) | ❓ | ⚠️ v1.3.1 | ⚠️ v1.4.3 |
|
| **4.27** | ⚠️ v1.4.x | ⚠️ v1.4.x | ⚠️ v1.4.x | ⚠️ v1.4.x | ⚠️ v1.4.x | ⚠️ v1.4.x (r21e) | ❓ | ⚠️ v1.3.1 | ⚠️ v1.4.3 |
|
||||||
| **4.26** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 |
|
| **4.26** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 |
|
||||||
| **4.25** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 |
|
| **4.25** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 |
|
||||||
| **4.24** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 |
|
| **4.24** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 |
|
||||||
| **4.23** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 |
|
| **4.23** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 |
|
||||||
| **4.22** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 |
|
| **4.22** | ⚠️ v1.0.x | ⚠️ v1.0.x | ❌ | ⚠️ v1.0.x | ❌ | ❌ | ❌ | ❌ | ⚠️ v1.0.4 |
|
||||||
|
|
||||||
* <code>✅</code> Supported
|
* <code>✅</code> Supported
|
||||||
* <code>⚠️</code> Not supported by the latest release and might be lacking features
|
* <code>⚠️</code> Not supported by the latest release and might be lacking features
|
||||||
@@ -21,7 +21,6 @@
|
|||||||
* <code>❓</code> Unknown or untested
|
* <code>❓</code> Unknown or untested
|
||||||
|
|
||||||
Remarks:
|
Remarks:
|
||||||
* With the Fab content marketplace scheduled to launch at an unspecified date in October 2024, and the fact that the Unreal Engine Marketplace no longer accepting any new submissions starting from October 1, any releases made during the transition from the Unreal Engine Marketplace to Fab will only be accessible through the [SenseGlove Microsoft Azure repositories](../getting-started/installation/microsoft-azure-devops-repositories.md).
|
|
||||||
* Per [Epic's Marketplace Guidelines](https://www.unrealengine.com/en-US/marketplace-guidelines) in regards to Code Plugins (sections `2.6.3`.d and `3.1.b`), we are only able to distribute or update the SenseGlove plugin for the last `3` stable versions of Unreal Engine. As a result, we won't be able to publish updates or bug fixes for the older versions of the Engine except on rare occasions and only through our official repository on Microsoft Azure DevOps.
|
* Per [Epic's Marketplace Guidelines](https://www.unrealengine.com/en-US/marketplace-guidelines) in regards to Code Plugins (sections `2.6.3`.d and `3.1.b`), we are only able to distribute or update the SenseGlove plugin for the last `3` stable versions of Unreal Engine. As a result, we won't be able to publish updates or bug fixes for the older versions of the Engine except on rare occasions and only through our official repository on Microsoft Azure DevOps.
|
||||||
* All third-party libraries on Windows built against Windows SDK `10.0`.
|
* All third-party libraries on Windows built against Windows SDK `10.0`.
|
||||||
* Oculus and VIVE support is only provided through the recommended Android NDK versions by Epic Games.
|
* Oculus and VIVE support is only provided through the recommended Android NDK versions by Epic Games.
|
||||||
|
|||||||
@@ -2,13 +2,13 @@
|
|||||||
|
|
||||||
The SenseGlove Unreal Engine Plugin could be installed using various methods:
|
The SenseGlove Unreal Engine Plugin could be installed using various methods:
|
||||||
|
|
||||||
- Through [the Epic Games Launcher](https://store.epicgames.com/en-US/download) by navigating to [the SenseGlove Unreal Engine Plugin landing page on the Unreal Engine Marketplace](https://www.unrealengine.com/marketplace/en-US/product/the-senseglove-unreal-engine-plugin).
|
- Via [the Epic Games Launcher](https://store.epicgames.com/en-US/download) by navigating to [the SenseGlove Unreal Engine Plugin landing page on Fab](https://www.fab.com/listings/62bcdd2a-0bb1-4f34-b7b8-c5e7c9313099).
|
||||||
- Through [the SenseGlove Unreal Engine Plugin Microsoft Azure DevOps repository](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal).
|
- Via [the SenseGlove Unreal Engine Plugin Microsoft Azure DevOps repository](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal).
|
||||||
|
|
||||||
In the following chapters, we discover each of those methods:
|
In the following chapters, we discover each of those methods:
|
||||||
|
|
||||||
- [Installation through the Epic Games Launcher](epic-games-launcher.md)
|
- [Installation via the Epic Games Launcher](epic-games-launcher.md)
|
||||||
- [Installation through Microsoft Azure DevOps Repositories](microsoft-azure-devops-repositories.md)
|
- [Installation via Microsoft Azure DevOps Repositories](microsoft-azure-devops-repositories.md)
|
||||||
|
|
||||||
## Video Tutorials
|
## Video Tutorials
|
||||||
|
|
||||||
|
|||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
LFS
Executable
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
@@ -1,46 +1,68 @@
|
|||||||
# Plugin Installation through the Epic Games Launcher
|
# Plugin Installation via the Epic Games Launcher
|
||||||
|
|
||||||
Before we start the plugin installation through [the Epic Games Launcher](https://store.epicgames.com/en-US/download) please make sure you have [a signed-in Epic Games account on your installed Epic Games Launcher and a supported Unreal Engine version already installed](https://dev.epicgames.com/documentation/en-us/unreal-engine/installing-unreal-engine). The supported engine versions are listed on [the Platform Support Matrix](../../appendix/platform-support-matrix.md).
|
Before beginning the plugin installation via [the Epic Games Launcher](https://store.epicgames.com/en-US/download), ensure you have [signed into your Epic Games account on the Epic Games Launcher](https://store.epicgames.com/en-US/download) and that you have a [supported version of Unreal Engine installed](https://dev.epicgames.com/documentation/en-us/unreal-engine/installing-unreal-engine). Supported engine versions can be found in the [Platform Support Matrix](../../appendix/platform-support-matrix.md).
|
||||||
|
|
||||||
1. Run the Epic Games Launcher.
|
1. Run the Epic Games Launcher.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
2. Navigate to the `Marketplace` tab.
|
2. Navigate to the `Fab` tab and click `Start exploring` button which in turn opens your default web browser pointing to the [Fab home page](https://www.fab.com/).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
3. On the `Marketplace` tab, inside the search box, start typing `SenseGlove` which filters the plugin matching that search phrase in real-time. Select `The SenseGlove Unreal Engine Plugin`.
|
3. On the [Fab home page](https://www.fab.com/), enter the term `SenseGlove` in the search box and press Enter. Alternatively, you can go directly to the [SenseGlove Unreal Engine Plugin landing page on Fab](https://www.fab.com/listings/62bcdd2a-0bb1-4f34-b7b8-c5e7c9313099) directly instead of taking the above two steps.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
4. Once on [the SenseGlove Unreal Engine Plugin marketplace page](https://www.unrealengine.com/marketplace/en-US/product/the-senseglove-unreal-engine-plugin), click on the `Install to Engine` button.
|
4. Click on the `SenseGlove Unreal Engine Plugin` in the search results to navigate to its dedicated page.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
5. You'll be prompted to choose a compatible engine version. Select your desired engine version and hit this `Install` button.
|
5. On the [SenseGlove Unreal Engine Plugin landing page on Fab](https://www.fab.com/listings/62bcdd2a-0bb1-4f34-b7b8-c5e7c9313099) click the `Download` button.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
6. The launcher will show the download and installation progress. Please wait for it to finish.
|
6. If this is your first download from Fab, you will need to agree to the Fab End User License Agreement (EULA) before proceeding.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
7. While the download and installation are in progress you can see the progress in more detail by clicking on the `Downloads` section on the sidebar.
|
7. After clicking `Download`, a pop-up will notify you that the plugin is available in your Vault in the Epic Games Launcher, or the Fab UE5 Plugin.
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> According to the
|
||||||
|
> [Fab launch announcement](https://www.unrealengine.com/en-US/blog/fab-epics-new-unified-content-marketplace-launches-today):
|
||||||
|
>
|
||||||
|
> The Fab integration in UEFN is undergoing maintenance and will be back online shortly, and the Fab integration in the Unreal Engine 5 Editor is coming soon.
|
||||||
|
|
||||||
8. Once the download and installation are done, you can head to the `Library` tab to verify the installation. In case you have lots of assets or plugins installed, you could search the term `SenseGlove` inside the search box for the `Vault` section and you should be able to see that the SenseGlove Unreal Engine Plugin has been added to your vault.
|
|
||||||
|
|
||||||
|
8. Go back to the Epic Games Launcher, navigate to the `Library` tab, and in the `Fab Library` section, click the `Refresh Fab items` button.
|
||||||
|
|
||||||
9. If you click on the `Installed Plugins` link under the engine you've just installed the plugin to, you should be able to see the SenseGlove Unreal Engine Plugin listed as installed.
|
|
||||||
|
|
||||||
|
9. Once the Fab library is refreshed and synchronized, use the Vault search box to find the `SenseGlove Unreal Engine Plugin`. Click the `Install to Engine` button.
|
||||||
|
|
||||||
10. One last confirmation could be navigating to `YourEngineInstallationPath/Engine/Plugins/Marketplace` directory. The SenseGlove Unreal Engine Plugin source and binaries can be found inside this directory. This is especially useful in case one desires to copy the plugin for example to their own project's source code to run it at the project level instead of running it at the engine level.
|
|
||||||
|
|
||||||
|
10. You'll be prompted to choose a compatible engine version. Select your desired engine version from the list, then click `Install`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
11. The Epic Games Launcher will show the plugin's download and installation progress. Please wait for it to complete.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
12. While the download and installation are in progress, you can see the progress in more details by clicking on the `Downloads` section on the sidebar.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
13. Once the download and installation are complete, verify its installation by clicking `Installed Plugins` under the engine you've just installed it to. The SenseGlove plugin should appear as installed among other currently installed plugins.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
14. One last confirmation could be navigating to `YourEngineInstallationPath/Engine/Plugins/Marketplace` directory. The SenseGlove Unreal Engine Plugin source and binaries can be found inside this directory. This is especially useful in case one desires to copy the plugin for example to their own project's source code to run it at the project level instead of running it at the engine level.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
> [!WARNING]
|
> [!WARNING]
|
||||||
> Please note that it is best practice to install the plugin either at the
|
> Please note that it is best practice to install the plugin either at the
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
# Plugin Installation through Microsoft Azure DevOps Repositories
|
# Plugin Installation via Microsoft Azure DevOps Repositories
|
||||||
|
|
||||||
While [plugin installation through the Epic Games Launcher](epic-games-launcher.md) is the most convenient method for most users to obtain and install the latest version of [the SenseGlove Unreal Engine Plugin marketplace page](https://www.unrealengine.com/marketplace/en-US/product/the-senseglove-unreal-engine-plugin), there might be valid reasons to instead download and install the plugin directly from [the SenseGlove Unreal Engine Plugin Microsoft Azure DevOps Repository](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal). These reasons may include:
|
While [plugin installation via the Epic Games Launcher](epic-games-launcher.md) is the most convenient method for most users to obtain and install the latest version of [the SenseGlove Unreal Engine Plugin via Fab](https://www.fab.com/listings/62bcdd2a-0bb1-4f34-b7b8-c5e7c9313099), there might be valid reasons to instead download and install the plugin directly from [the SenseGlove Unreal Engine Plugin Microsoft Azure DevOps Repository](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal). These reasons may include:
|
||||||
|
|
||||||
- Downloading an older version that is no longer available on [the Unreal Engine Marketplace](https://www.unrealengine.com/marketplace/en-US/store).
|
- Downloading an older version that is no longer available on [Fab](https://www.fab.com/).
|
||||||
- Downloading a recent version that has been submitted to the Unreal Engine Marketplace, but is still awaiting approval and publication by the Unreal Engine Marketplace Team.
|
- Downloading a recent version that has been submitted to Fab, but is still awaiting approval and publication by the Fab Team.
|
||||||
- Downloading an under-development, unstable release of the plugin for testing purposes.
|
- Downloading an under-development, unstable release of the plugin for testing purposes.
|
||||||
- Or, any other specific needs that require direct access to the repository.
|
- Or, any other specific needs that require direct access to the repository.
|
||||||
|
|
||||||
@@ -17,11 +17,11 @@ To download a specific version of the plugin, follow these steps:
|
|||||||
|
|
||||||
2. Locate the branch dropdown menu at the top of the page, just below the navigation bar, and next to the `Copy to clipboard` icon. There you'll find a dropdown menu. By default, it usually selects the [master](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal?path=%2F&version=GBmaster&_a=contents) branch.
|
2. Locate the branch dropdown menu at the top of the page, just below the navigation bar, and next to the `Copy to clipboard` icon. There you'll find a dropdown menu. By default, it usually selects the [master](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal?path=%2F&version=GBmaster&_a=contents) branch.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
3. Use the dropdown menu to choose a desired branch containing the source code for a specific version of Unreal Engine or a specific release of the plugin marked with a release tag.
|
3. Use the dropdown menu to choose a desired branch containing the source code for a specific version of Unreal Engine or a specific release of the plugin marked with a release tag.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> A branch named with engine version numbers, such as `5.4`, `5.3`, etc.,
|
> A branch named with engine version numbers, such as `5.4`, `5.3`, etc.,
|
||||||
@@ -49,7 +49,7 @@ To download a specific version of the plugin, follow these steps:
|
|||||||
|
|
||||||
4. After selecting your desired branch or tag, click on the kebab menu (three vertical dots) located at the top right of the screen and choose `Download as Zip` to obtain the source code for that branch or tag.
|
4. After selecting your desired branch or tag, click on the kebab menu (three vertical dots) located at the top right of the screen and choose `Download as Zip` to obtain the source code for that branch or tag.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Download a Specific Version for a Specifc Unreal Engine Version
|
## Download a Specific Version for a Specifc Unreal Engine Version
|
||||||
|
|
||||||
@@ -57,17 +57,17 @@ As mentioned earlier, due to breaking changes between Unreal Engine versions, it
|
|||||||
|
|
||||||
1. First, choose the appropriate branch for your desired Unreal Engine version from the branch dropdown menu, as discussed earlier. Then navigate to the `History` tab.
|
1. First, choose the appropriate branch for your desired Unreal Engine version from the branch dropdown menu, as discussed earlier. Then navigate to the `History` tab.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
2. Look through the commit history for a commit message that says `bump the plugin version to vX.X.X` as all releases are finalized with this exact commit message and the plugin version. Next, click on the commit message for the version you are looking for.
|
2. Look via the commit history for a commit message that says `bump the plugin version to vX.X.X` as all releases are finalized with this exact commit message and the plugin version. Next, click on the commit message for the version you are looking for.
|
||||||
|
|
||||||
3. Once you've selected the correct commit, click on the `Browse Files` button next to the kebab menu (three vertical dots) at the top right of the screen.
|
3. Once you've selected the correct commit, click on the `Browse Files` button next to the kebab menu (three vertical dots) at the top right of the screen.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
4. You should now be in the `Content` tab, with the branch dropdown menu displaying the commit hash instead of a branch name or tag. Click on the kebab menu (three vertical dots) again, and select `Download as Zip`. This will give you a zip file containing the exact release you need, compatible with your chosen Unreal Engine version.
|
4. You should now be in the `Content` tab, with the branch dropdown menu displaying the commit hash instead of a branch name or tag. Click on the kebab menu (three vertical dots) again, and select `Download as Zip`. This will give you a zip file containing the exact release you need, compatible with your chosen Unreal Engine version.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Download the Bleeding-edge Development Branch
|
## Download the Bleeding-edge Development Branch
|
||||||
|
|
||||||
@@ -86,7 +86,7 @@ As mentioned earlier, due to breaking changes between Unreal Engine versions, it
|
|||||||
|
|
||||||
Downloading the [`dev`](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal?path=%2F&version=GBdev&_a=contents) branch is as easy as choosing the `dev` branch from the branch dropdown menu (as discussed earlier) and then choosing `Download as Zip` from the kebab menu (three vertical dots).
|
Downloading the [`dev`](https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal?path=%2F&version=GBdev&_a=contents) branch is as easy as choosing the `dev` branch from the branch dropdown menu (as discussed earlier) and then choosing `Download as Zip` from the kebab menu (three vertical dots).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@@ -211,11 +211,11 @@ MyCppProject
|
|||||||
|
|
||||||
For a Blueprint-only project, on Microsoft Windows simply double-clicking the project's `.uproject` file should present you with a pop-up informing you that some binary modules are missing.
|
For a Blueprint-only project, on Microsoft Windows simply double-clicking the project's `.uproject` file should present you with a pop-up informing you that some binary modules are missing.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
After confirming, the build process will start automatically, and a dialog indicating the build progress will be shown:
|
After confirming, the build process will start automatically, and a dialog indicating the build progress will be shown:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Once finished successfully, the project will be loaded.
|
Once finished successfully, the project will be loaded.
|
||||||
|
|
||||||
@@ -224,11 +224,11 @@ Once finished successfully, the project will be loaded.
|
|||||||
|
|
||||||
For C++ projects, on Microsoft Windows, right-click on your C++ `.uproject` file and choose `Generate Visual Studio project files`:
|
For C++ projects, on Microsoft Windows, right-click on your C++ `.uproject` file and choose `Generate Visual Studio project files`:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
A dialog will pop up shows you the progress of generating the Visual Studio project files:
|
A dialog will pop up shows you the progress of generating the Visual Studio project files:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Once the project files are generated, open up the C++ project in your preferred C++ IDE and build the project. After this, the project can be loaded in the Unreal Editor.
|
Once the project files are generated, open up the C++ project in your preferred C++ IDE and build the project. After this, the project can be loaded in the Unreal Editor.
|
||||||
|
|
||||||
|
|||||||
@@ -7,8 +7,8 @@ To help you navigate the SenseGlove Unreal Engine Handbook, we have organized th
|
|||||||
This section covers the basics of the SenseGlove Unreal Engine Plugin:
|
This section covers the basics of the SenseGlove Unreal Engine Plugin:
|
||||||
|
|
||||||
- [Installation](../getting-started/installation/)
|
- [Installation](../getting-started/installation/)
|
||||||
- [Through the Epic Games Launcher](../getting-started/installation/epic-games-launcher.md)
|
- [Via the Epic Games Launcher](../getting-started/installation/epic-games-launcher.md)
|
||||||
- [Through Microsoft Azure DevOps Repositories](../getting-started/installation/microsoft-azure-devops-repositories.md)
|
- [Via Microsoft Azure DevOps Repositories](../getting-started/installation/microsoft-azure-devops-repositories.md)
|
||||||
- [Enabling and Verifying the Plugin Version](../getting-started/plugin-verify-version-enable/)
|
- [Enabling and Verifying the Plugin Version](../getting-started/plugin-verify-version-enable/)
|
||||||
- [SenseCom](../getting-started/sensecom/)
|
- [SenseCom](../getting-started/sensecom/)
|
||||||
- [SenseCom on GNU/Linux](../getting-started/sensecom/gnu-linux/)
|
- [SenseCom on GNU/Linux](../getting-started/sensecom/gnu-linux/)
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ For examples, demo scenes, tutorials, and extra resources please check out [the
|
|||||||
|
|
||||||
Various instructions on [how to download and install the SenseGlove Unreal Engine Plugin](Handbook/src/getting-started/installation/README.md) are available. It could either be installed through [the Epic Games Launcher](Handbook/src/getting-started/installation/epic-games-launcher.md), or [through Microsoft Azure DevOps repositories](Handbook/src/getting-started/installation/microsoft-azure-devops-repositories.md).
|
Various instructions on [how to download and install the SenseGlove Unreal Engine Plugin](Handbook/src/getting-started/installation/README.md) are available. It could either be installed through [the Epic Games Launcher](Handbook/src/getting-started/installation/epic-games-launcher.md), or [through Microsoft Azure DevOps repositories](Handbook/src/getting-started/installation/microsoft-azure-devops-repositories.md).
|
||||||
|
|
||||||
For more information, visit [the SenseGlove Unreal Engine Handbook on the Epic Marketplace](https://www.unrealengine.com/marketplace/en-US/product/the-senseglove-unreal-engine-plugin).
|
For more information, visit [the SenseGlove Unreal Engine Plugin on Fab](https://www.fab.com/listings/62bcdd2a-0bb1-4f34-b7b8-c5e7c9313099).
|
||||||
|
|
||||||
### Platform Support Matrix
|
### Platform Support Matrix
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user