Skip to content

Latest commit

 

History

History
41 lines (35 loc) · 2.06 KB

README.md

File metadata and controls

41 lines (35 loc) · 2.06 KB
Raw

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 provided by VRChat, and the plugin itself are written in C#

Downloads

You're going to find built plugins in repo Releases.

Build & Deploy

Both build and deployment instructions are available here.

  • 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 
    {
 "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 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 for more docs sometime.

The build and publishment workflow is the same as in this repo (excluding vendor deps).