50 lines
3.3 KiB
Markdown
50 lines
3.3 KiB
Markdown
# The SenseGlove Unreal Engine Plugin
|
|
|
|
## How to Download
|
|
|
|
This repository relies on Git LFS for storing binary blobs (e.g. third-party libraries). Sadly, there is a known issue with Microsoft Azure public LFS repositories that requires credential for LFS checkouts on https (LFS ssh checkouts are not supported at all). Unless, you are part of SenseGlove organization on Microsoft Azure there is no easy way to fully clone this repository using Git. Thus, the best way to download this repository is to use the 'kebab' (three vertical dots) menu next to the clone button, in order to download the whole repository including LFS objects as a unified zip file.
|
|
|
|
## Documentation
|
|
|
|
[The Blueprints documentation is hosted on SenseGlove Docs](https://senseglove.gitlab.io/unreal-blueprint-docs/).
|
|
|
|
For the C++ documentation, since this plugin builds on top of [SGConnect](https://senseglove.gitlab.io/SenseGloveDocs/native/core-api-intro.html#sgconnect) and [SGCoreCpp](https://senseglove.gitlab.io/SenseGloveDocs/native/core-api-intro.html#sgcorecpp) third-party C++ libraries, please refer to [the upstream documentation](https://senseglove.gitlab.io/SenseGloveDocs/native/cpp-reference.html).
|
|
|
|
Also, you could refer to the header files in every module for extensive documentation, or the equivalent Blueprints documentation.
|
|
|
|
The following modules are intended to be used by the C++ users of this plugin:
|
|
|
|
* SenseGloveConnect module which only uses a very small subset of the Core SGConnect libary.
|
|
|
|
* SenseGloveCore module which is mostly a one-on-one wrapper call to most of the SGCoreCpp library with slight differences.
|
|
|
|
Please note that modules postfixed with **Impl** are intended for interal use and are discouraged to be used by the users of the API. The modules postfixed with **Kismet** are exposing the functionality of the equivalent modules to Blueprints. For other modules descriptions, please see [the Directory Structure section](#directory-structure).
|
|
|
|
## Overview
|
|
|
|
### Platform Support Matrix
|
|
|
|
We maintain [a platform support matrix](Handbook/src/overview/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/overview/planned-features-completion-status.md) as a kind of roadmap for this plugin.
|
|
|
|
### Changelog
|
|
|
|
We maintain [a detailed changelog for this project](Handbook/src/overview/changelog.md) 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/overview/directory-structure.md).
|
|
|
|
## 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).
|
|
|
|
### 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.
|