https://github.com/kinecttovr/plugin_osc

OSC Endpoint for Amethyst.NET
https://github.com/kinecttovr/plugin_osc

amethyst-plugin

Last synced: about 2 months ago
JSON representation

OSC Endpoint for Amethyst.NET

• Host: GitHub
• URL: https://github.com/kinecttovr/plugin_osc
• Owner: KinectToVR
• License: mit
• Created: 2022-12-11T21:35:46.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-17T17:13:30.000Z (6 months ago)
• Last Synced: 2024-10-29T10:33:16.313Z (2 months ago)
• Topics: amethyst-plugin
• Language: C#
• Homepage:
• Size: 188 KB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


OSC (OscQuery)

Amethyst

service plugin



## **License**

This project is licensed under the GNU GPL v3 License 

## **Overview**

This repo is a pure implementation of the `IServiceEndpoint` interface,  

providing Amethyst support for OSC (VRChat), using CoreOSC and OscQuery.  

[The bound API](https://github.com/KinectToVR/plugin_OSC/tree/main/vendor/vrc-oscquery-lib) provided by VRChat, and [the plugin itself](https://github.com/KinectToVR/plugin_OSC/tree/main/plugin_OSC) are written in C#

## **Downloads**

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

## **Build & Deploy**

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

 - Initialize git submodules: `git submodule update --init --recursive`

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

   (`plugin_OSC` → `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_OSC\\plugin_OSC\\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).