Skip to content

About

Official SDKs (.NET, Node, Python) for writing FocusRGB plugins

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

FocusRGB SDK

FocusRGB logo

Official SDKs in FocusRGB-SDK for writing FocusRGB plugins. A plugin is a separate process that FocusRGB starts and talks to directly over stdin/stdout using newline-delimited JSON-RPC. These SDKs implement that protocol so plugin authors don't have to.

The protocol itself is defined in the main repository, not here: sdk/spec/ holds the normative spec and JSON schemas, and its conformance kit checks any plugin in any language. Each SDK here is tested against a tagged version of that spec.

Language Package Status
.NET (C#) FocusRgb.PluginSdk on nuget.org 1.2 in development
Node.js @focusrgb/plugin-sdk on npm, with focusrgb-node-runner planned
Python focusrgb-plugin-sdk on PyPI, with focusrgb-python-runner planned

Migration in progress. This repository was split out of FocusRGB/FocusRGB with its history. The .NET SDK, its public protocol types, template, tests and package tooling are here; the Node and Python SDKs will follow. See FocusRGB#84.

Layout

FocusRGB-SDK.slnx  .NET SDK solution
dotnet/      FocusRgb.PluginSdk (+ its message types) and tests
templates/   dotnet new template for a standalone plugin repository
tools/       package reproducibility, consumer, and tagged-spec conformance checks

Licensed under MIT.

Assisted-by: Claude Assisted-by: OpenAI Codex

About

Official SDKs (.NET, Node, Python) for writing FocusRGB plugins

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages