diff --git a/Handbook/src/SUMMARY.md b/Handbook/src/SUMMARY.md index 9a7e5fe5..be9a271c 100644 --- a/Handbook/src/SUMMARY.md +++ b/Handbook/src/SUMMARY.md @@ -10,10 +10,10 @@ Welcom to the SenseGlove Unreal Engine Handbook! # 🚀 Getting Started -- [Installation](getting-started/installation.md) - - [Install through the Epic Launcher]() - - [Install through Microsoft Azure DevOps]() -- [Checking the Plugin Version]() +- [Installation](getting-started/installation/README.md) + - [Through the Epic Games Launcher](getting-started/installation/epic-games-launcher.md) + - [Through Microsoft Azure DevOps Repositories](getting-started/installation/microsoft-azure-devops-repositories.md) +- [Verify the Plugin Version](getting-started/verify-plugin-version.md) - [SenseCom]() - [SenseCom on GNU/Linux]() - [Connect to Nova gloves using Blueman Bluetooth Manager]() diff --git a/Handbook/src/getting-started/installation/README.md b/Handbook/src/getting-started/installation/README.md index 25267fe2..0532b4cc 100644 --- a/Handbook/src/getting-started/installation/README.md +++ b/Handbook/src/getting-started/installation/README.md @@ -1 +1,22 @@ -# Installation +# Plugin Installation + +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). +- Through [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: + +- [Installation through the Epic Games Launcher](epic-games-launcher.md) +- [Installation through Microsoft Azure DevOps Repositories](microsoft-azure-devops-repositories.md) + +We also have older videos demonstrating both installation methods on Microsoft Windows and GNU Linux in more detail. + +- [Plugin installation guide for Microsoft Windows](https://youtu.be/QqWeRHNceqY): + + + +- [Plugin and examples installation guide for GNU/Linux](https://youtu.be/1T7LAGp3e6I): + + diff --git a/Handbook/src/getting-started/installation/epic-games-launcher-001.png b/Handbook/src/getting-started/installation/epic-games-launcher-001.png new file mode 100755 index 00000000..72aac7e4 --- /dev/null +++ b/Handbook/src/getting-started/installation/epic-games-launcher-001.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0dda98796f2f6bfe8a934110d2ab7f534fc42e263b71c39697fc94a7406be88c +size 782449 diff --git a/Handbook/src/getting-started/installation/epic-games-launcher-002.png b/Handbook/src/getting-started/installation/epic-games-launcher-002.png new file mode 100755 index 00000000..4a2f4906 --- /dev/null +++ b/Handbook/src/getting-started/installation/epic-games-launcher-002.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eeb410c70a268b729acd53e8897f42ea53d31a0a8f5b258012eea0d86f47dab0 +size 1400479 diff --git a/Handbook/src/getting-started/installation/epic-games-launcher-003.png b/Handbook/src/getting-started/installation/epic-games-launcher-003.png new file mode 100755 index 00000000..fb4cc2a2 --- /dev/null +++ b/Handbook/src/getting-started/installation/epic-games-launcher-003.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:17472ebf888d79b0909f83dec5d8379598c28b3514582a2fa3115bae760d9af4 +size 1407599 diff --git a/Handbook/src/getting-started/installation/epic-games-launcher-004.png b/Handbook/src/getting-started/installation/epic-games-launcher-004.png new file mode 100755 index 00000000..3e5b430b --- /dev/null +++ b/Handbook/src/getting-started/installation/epic-games-launcher-004.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:690cf9af1992acedd0cc39396a3499dfcd7b4b4795eabe634d3a9629b55ca174 +size 499900 diff --git a/Handbook/src/getting-started/installation/epic-games-launcher-005.png b/Handbook/src/getting-started/installation/epic-games-launcher-005.png new file mode 100755 index 00000000..ced0623d --- /dev/null +++ b/Handbook/src/getting-started/installation/epic-games-launcher-005.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:45e3c1af739a3e46ae11ce5f377819bcad0b3f76804cf068da831553acec6676 +size 212462 diff --git a/Handbook/src/getting-started/installation/epic-games-launcher-006.png b/Handbook/src/getting-started/installation/epic-games-launcher-006.png new file mode 100755 index 00000000..f4f11f5b --- /dev/null +++ b/Handbook/src/getting-started/installation/epic-games-launcher-006.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:57deab574ac9bf2a2ec6b9be7793dd5729e071457f263b5753db33a2c18f6126 +size 475915 diff --git a/Handbook/src/getting-started/installation/epic-games-launcher-007.png b/Handbook/src/getting-started/installation/epic-games-launcher-007.png new file mode 100755 index 00000000..dd37d94b --- /dev/null +++ b/Handbook/src/getting-started/installation/epic-games-launcher-007.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cdcbf36097aa6b64af29fa50469fcecad7484e79ed75c87a2bd436a411346aed +size 238763 diff --git a/Handbook/src/getting-started/installation/epic-games-launcher-008.png b/Handbook/src/getting-started/installation/epic-games-launcher-008.png new file mode 100755 index 00000000..07bf89c7 --- /dev/null +++ b/Handbook/src/getting-started/installation/epic-games-launcher-008.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ce0742e02678dce3d9baf929d4f332efa8d56e74b855e8daf163173ef35a56c0 +size 196427 diff --git a/Handbook/src/getting-started/installation/epic-games-launcher-009.png b/Handbook/src/getting-started/installation/epic-games-launcher-009.png new file mode 100755 index 00000000..20391ea9 --- /dev/null +++ b/Handbook/src/getting-started/installation/epic-games-launcher-009.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e101133f3d4c70846dcb8cac36e4451af1d3dca558a04a6fe67a864dcce77993 +size 168715 diff --git a/Handbook/src/getting-started/installation/epic-games-launcher-010.png b/Handbook/src/getting-started/installation/epic-games-launcher-010.png new file mode 100755 index 00000000..6c6b7cfa --- /dev/null +++ b/Handbook/src/getting-started/installation/epic-games-launcher-010.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:38df4bc2772c1b460b82690a1e05e25b8b3c75d01a068d5ba70fbe68a705d6b1 +size 92351 diff --git a/Handbook/src/getting-started/installation/epic-games-launcher.md b/Handbook/src/getting-started/installation/epic-games-launcher.md new file mode 100644 index 00000000..966464ed --- /dev/null +++ b/Handbook/src/getting-started/installation/epic-games-launcher.md @@ -0,0 +1,44 @@ +# Plugin Installation through 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). + +1. Run the Epic Games Launcher. + +![Plugin installation through the Epic Games Launcher - step 1](epic-games-launcher-001.png "Plugin installation through the Epic Games Launcher - step 1") + +2. Navigate to the `Marketplace` tab. + +![Plugin installation through the Epic Games Launcher - step 2](epic-games-launcher-002.png "Plugin installation through the Epic Games Launcher - step 2") + +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`. + +![Plugin installation through the Epic Games Launcher - step 3](epic-games-launcher-003.png "Plugin installation through the Epic Games Launcher - step 3") + +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. + +![Plugin installation through the Epic Games Launcher - step 4](epic-games-launcher-004.png "Plugin installation through the Epic Games Launcher - step 4") + +5. You'll be prompted to choose a compatible engine version. Select your desired engine version and hit this `Install` button. + +![Plugin installation through the Epic Games Launcher - step 5](epic-games-launcher-005.png "Plugin installation through the Epic Games Launcher - step 5") + +6. The launcher will show the download and installation progress. Please wait for it to finish. + +![Plugin installation through the Epic Games Launcher - step 6](epic-games-launcher-006.png "Plugin installation through the Epic Games Launcher - step 6") + +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. + +![Plugin installation through the Epic Games Launcher - step 7](epic-games-launcher-007.png "Plugin installation through the Epic Games Launcher - step 7") + +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. + +![Plugin installation through the Epic Games Launcher - step 8](epic-games-launcher-008.png "Plugin installation through the Epic Games Launcher - step 8") + +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. + +![Plugin installation through the Epic Games Launcher - step 9](epic-games-launcher-009.png "Plugin installation through the Epic Games Launcher - step 9") + +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. Please beware that it's best practice to keep the plugin either at the project level or the engine level, not both, as it may create various kinds of issues. Especially if the version of the plugin installed at the engine level differs from the one installed at the plugin level. A guide on [verifying the plugin version](../../getting-started/verify-plugin-version.md) exist as well. + +![Plugin installation through the Epic Games Launcher - step 10](epic-games-launcher-010.png "Plugin installation through the Epic Games Launcher - step 10") + diff --git a/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories.md b/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories.md new file mode 100644 index 00000000..af08bf58 --- /dev/null +++ b/Handbook/src/getting-started/installation/microsoft-azure-devops-repositories.md @@ -0,0 +1 @@ +# Plugin Installation through Microsoft Azure DevOps Repositories diff --git a/Handbook/src/getting-started/plugin-version.md b/Handbook/src/getting-started/plugin-version.md deleted file mode 100644 index 3a1d4375..00000000 --- a/Handbook/src/getting-started/plugin-version.md +++ /dev/null @@ -1 +0,0 @@ -# Plugin Version diff --git a/Handbook/src/getting-started/verify-plugin-version.md b/Handbook/src/getting-started/verify-plugin-version.md new file mode 100644 index 00000000..deeec76f --- /dev/null +++ b/Handbook/src/getting-started/verify-plugin-version.md @@ -0,0 +1 @@ +# Veirfying the Plugin Version