https://github.com/kimihikoakayasaki/plugin_joycon
https://github.com/kimihikoakayasaki/plugin_joycon
amethyst-plugin
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kimihikoakayasaki/plugin_joycon
- Owner: KimihikoAkayasaki
- License: mit
- Created: 2025-07-12T11:19:29.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2025-07-12T11:35:38.000Z (11 months ago)
- Last Synced: 2025-07-12T13:21:47.846Z (11 months ago)
- Topics: amethyst-plugin
- Language: C#
- Homepage:
- Size: 137 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
JoyCon
Amethyst
device plugin
## **License**
This project is licensed under the GNU GPL v3 License
## **Overview**
This repo is a mixed implementation of the `ITrackingDevice` interface,
providing Amethyst support for JoyCon (EX), using the JoyCon.NET API.
[The bound API](https://github.com/Timocop/JoyConEx-CAPI.NET), and [the plugin itself](https://github.com/KinectToVR/plugin_JoyCon/tree/main/plugin_JoyCon) are written in C# with marshalled dependencies.
## **Downloads**
You're going to find built plugins in [repo Releases](https://github.com/KinectToVR/plugin_JoyCon/releases/latest).
## **Build & Deploy**
Both build and deployment instructions [are available here](https://github.com/KinectToVR/plugin_JoyCon/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_JoyCon` → `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_JoyCon\\plugin_JoyCon\\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).