add the epic games launcher installation instructions

This commit is contained in:
Mamadou Babaei
2024-08-16 18:01:47 +02:00
parent bf9ed153f7
commit 089476fddd
16 changed files with 102 additions and 6 deletions
+4 -4
View File
@@ -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]()
@@ -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):
<iframe width="560" height="315" src="https://www.youtube.com/embed/QqWeRHNceqY" frameborder="0" allowfullscreen></iframe>
- [Plugin and examples installation guide for GNU/Linux](https://youtu.be/1T7LAGp3e6I):
<iframe width="560" height="315" src="https://www.youtube.com/embed/1T7LAGp3e6I" frameborder="0" allowfullscreen></iframe>
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.
@@ -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")
@@ -0,0 +1 @@
# Plugin Installation through Microsoft Azure DevOps Repositories
@@ -1 +0,0 @@
# Plugin Version
@@ -0,0 +1 @@
# Veirfying the Plugin Version