https://github.com/kinecttovr/plugin_relay

Amethyst Tracking Relay plugin pair
https://github.com/kinecttovr/plugin_relay

amethyst-plugin

Last synced: about 2 months ago
JSON representation

Amethyst Tracking Relay plugin pair

• Host: GitHub
• URL: https://github.com/kinecttovr/plugin_relay
• Owner: KinectToVR
• License: mit
• Created: 2024-09-17T18:29:03.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-14T11:02:28.000Z (3 months ago)
• Last Synced: 2024-11-05T07:35:24.281Z (about 2 months ago)
• Topics: amethyst-plugin
• Language: C#
• Homepage:
• Size: 44.9 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


Amethyst Tracking Relay

Amethyst

plugin



## **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 Tracking Relay to forward tracking data.

Both the handler and the plugin itself ([available here](https://github.com/KinectToVR/plugin_Relay/tree/main/plugin_Relay)) are written in C#

## **Downloads**

You're going to find built plugins in [repo Releases](https://github.com/KinectToVR/plugin_Relay/releases/latest).

## **Build & Deploy**

Both build and deployment instructions [are available here](https://github.com/KinectToVR/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.


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).