UnrealEngine/Plugin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

revamp the main readme file with the latest information and instructions

Browse Source
This commit is contained in:
Mamadou Babaei
2024-08-16 16:44:29 +02:00
parent 29905ef100
commit 34b62b30d0
1 changed files with 20 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+20 -28
View File
@@ -1,42 +1,34 @@
# 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.
## Platform Support Matrix
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
We maintain [a detailed changelog for this project](Handbook/src/appendix/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/appendix/directory-structure.md).
## Getting Started
## Documentation
### Documentation
[The Blueprints documentation is hosted on SenseGlove Docs](https://senseglove.gitlab.io/unreal-blueprint-docs/).
For the official documentation please visit the [The SenseGlove Unreal Engine Handbook](https://unreal.docs.senseglove.com/).
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).
### Extra Resources
Also, you could refer to the header files in every module for extensive documentation, or the equivalent Blueprints documentation.
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).
The following modules are intended to be used by the C++ users of this plugin:
### How to Download and Install
* SenseGloveConnect module which only uses a very small subset of the Core SGConnect libary.
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).
* SenseGloveCore module which is mostly a one-on-one wrapper call to most of the SGCoreCpp library with slight differences.
### Platform Support Matrix
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).
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).
## Licenses