Files
Plugin/README.md
T

42 lines
2.4 KiB
Markdown
Raw Normal View History

2022-11-04 15:23:56 +01:00
# The SenseGlove Unreal Engine Plugin
2022-11-02 22:43:14 +01:00
## Getting Started
### Documentation
For the official documentation please visit the [The SenseGlove Unreal Engine Handbook](https://unreal.docs.senseglove.com/).
2022-11-02 22:43:14 +01:00
### Extra Resources
2022-11-02 22:43:14 +01:00
2024-08-07 18:31:06 +02:00
For examples, demo scenes, tutorials, and extra resources please checkout [the SenseGlove Unreal Engine Handbook on the Epic Marketplace](https://www.unrealengine.com/marketplace/en-US/product/the-senseglove-unreal-engine-plugin), or [the Extra Resources section](Handbook/src/appendix/extra-resources.md) of the [The SenseGlove Unreal Engine Handbook](Handbook/).
2022-11-02 22:43:14 +01:00
### How to Download and Install
2022-11-02 22:43:14 +01:00
Various instructions on [how to download and install the SenseGlove Unreal Engine Plugin](Handbook/src/getting-started/installation/README.md) is 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).
2022-11-02 22:43:14 +01:00
### Platform Support Matrix
2022-11-02 22:43:14 +01:00
We maintain [a platform support matrix](Handbook/src/appendix/platform-support-matrix.md) which constantly changes as we move forward towards our development goals.
### Planned Features Completion Status
We also maintain [a list of planned features and their completion status](Handbook/src/appendix/planned-features-completion-status.md) as a kind of roadmap for this plugin.
### Changelog
[A detailed changelog for this project](Handbook/src/appendix/changelog.md) is maintained as well. Please consult the changelog before upgrading to any newer release.
### Directory Structure
For the list of modules, directory structure, and how this plugin is organized please visit [the directory structure section](Handbook/src/appendix/directory-structure.md).
2022-11-02 22:43:14 +01:00
## Licenses
### SenseGlove Unreal Engine Plug-in License
The SenseGlove plug-in for Unreal Engine is licensed under the terms of the [MIT License](Handbook/src/license/senseglove-unreal-engine-plugin.md).
2022-11-02 22:43:14 +01:00
### Third-Party Licenses
Please note that while the SenseGlove Unreal Engine Plugin is made available under the MIT License, it utilizes a few third-party libraries with permissive free licenses as well, in order to power various components. For a list of these libraries and their own respective open-source licenses take a look at [the third-party licenses](Handbook/src/license/third-party.md), please.