Initial commit

Author: meruune

README.md

@@ -0,0 +1,40 @@
+<h1 dir=auto>
+<b>Kinect One (Fake)</b>
+<a style="color:#9966cc;" href="https://github.com/KinectToVR/Amethyst">Amethyst</a>
+<text>device plugin</text>
+</h1>
+
+## **License**
+This project is licensed under the GNU GPL v3 License 
+
+## **Overview**
+This repo is a pure implementation of the `ITrackingDevice` interface,  
+providing Amethyst support for the Xbox One Kinect, as a fake device.  
+Both the handler and the plugin itself ([available here](https://github.com/KimihikoAkayasaki/plugin_Relay/tree/main/plugin_Relay)) are written in C#
+
+## **Downloads**
+You're going to find built plugins in [repo Releases](https://github.com/KimihikoAkayasaki/plugin_Relay/releases/latest).
+
+## **Build & Deploy**
+Both build and deployment instructions [are available here](https://github.com/KimihikoAkayasaki/plugin_Relay/blob/main/.github/workflows/build.yml).
+ - Open in Visual Studio and publish using the prepared publish profile  
+   (`plugin_Relay` → `Publish` → `Publish` → `Open folder`)
+ - Copy the published plugin to the `plugins` folder of your local Amethyst installation  
+   or register by adding it to `$env:AppData\Amethyst\amethystpaths.k2path`
+   ```jsonc
+   {
+    "external_plugins": [
+        // Add the published plugin path here, this is an example:
+        "F:\\source\\repos\\plugin_Relay\\plugin_Relay\\bin\\Release\\Publish"
+    ]
+   }
+   ```
+
+## **Wanna make one too? (K2API Devices Docs)**
+[This repository](https://github.com/KinectToVR/Amethyst.Plugins.Templates) contains templates for plugin types supported by Amethyst.<br>
+Install the templates by `dotnet new install Amethyst.Plugins.Templates::1.2.0`  
+and use them in Visual Studio (recommended) or straight from the DotNet CLI.  
+The project templates already contain most of the needed documentation,  
+although please feel free to check out [the official wesite](https://docs.k2vr.tech/) for more docs sometime.
+
+The build and publishment workflow is the same as in this repo (excluding vendor deps).