https://github.com/kinecttovr/plugin_owotrackvr

Amethyst.NET plugin for owoTrackVR
https://github.com/kinecttovr/plugin_owotrackvr

amethyst-plugin

Last synced: about 2 months ago
JSON representation

Amethyst.NET plugin for owoTrackVR

• Host: GitHub
• URL: https://github.com/kinecttovr/plugin_owotrackvr
• Owner: KinectToVR
• License: mit
• Created: 2022-12-15T12:26:01.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-07-17T17:13:19.000Z (6 months ago)
• Last Synced: 2024-10-29T10:25:58.904Z (2 months ago)
• Topics: amethyst-plugin
• Language: C#
• Homepage:
• Size: 83 KB
• Stars: 1
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


owoTrackVR

Amethyst

device plugin



## **License**

This project is licensed under the GNU GPL v3 License 

## **Overview**

This repo is a projected implementation of the `ITrackingDevice` interface,  

providing Amethyst support for owoTrackVR, using the [official handler code](https://github.com/abb128/owo-track-overlay).  

[The device handler](https://github.com/KinectToVR/plugin_owoTrackVR/tree/master/DeviceHandler) is written in C++/WinRT, and [the plugin itself](https://github.com/KinectToVR/plugin_owoTrackVR/tree/master/plugin_owoTrackVR) is written in C#

## **Downloads**

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

## **Build & Deploy**

Both build and deployment instructions [are available here](https://github.com/KinectToVR/plugin_owoTrackVR/blob/master/.github/workflows/build.yml).

 - Open in Visual Studio and publish using the prepared publish profile  

   (`plugin_owoTrackVR` → `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_owoTrackVR\\plugin_owoTrackVR\\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).