https://github.com/kimihikoakayasaki/plugin_touchlink

Amethyst.NET plugin for TouchLink
https://github.com/kimihikoakayasaki/plugin_touchlink

amethyst-plugin

Last synced: 3 months ago
JSON representation

Amethyst.NET plugin for TouchLink

• Host: GitHub
• URL: https://github.com/kimihikoakayasaki/plugin_touchlink
• Owner: KimihikoAkayasaki
• License: mit
• Created: 2022-10-01T13:29:51.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-07-17T17:14:39.000Z (6 months ago)
• Last Synced: 2024-07-17T21:09:53.714Z (6 months ago)
• Topics: amethyst-plugin
• Language: C++
• Homepage:
• Size: 83 KB
• Stars: 2
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        



TouchLink

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 Oculus (OVR) devices, using the [Oculus OVR SDK](https://developer.oculus.com/downloads/package/oculus-sdk-for-windows/).  

[The device handler](DeviceHandler) is written in C++/WinRT, and [the plugin itself](plugin_TouchLink) is written in C#

## **Downloads**

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

## **Build & Deploy**

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

 - Download the [Oculus OVR SDK](https://developer.oculus.com/downloads/package/oculus-sdk-for-windows/) and unzip it to `\external\OVRSDK`

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

   (`plugin_TouchLink` → `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_TouchLink\\plugin_TouchLink\\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).