Skip to content

Commit 5bed40e

Browse files
committed
Added minimal plugin docs
1 parent 17ba5fe commit 5bed40e

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Welcome to OpenRGB-Python's documentation!
1313
pages/intro
1414
pages/usage
1515
pages/effects
16+
pages/plugins
1617
pages/advanced
1718
pages/faq
1819
pages/api

docs/pages/plugins.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Plugins
2+
=======
3+
4+
OpenRGB recently (0.81) added support for SDK clients to interact with plugins. This
5+
means that you can control plugins from the SDK. I wrote a basic integration with
6+
the effects plugin as a proof of concept, but it is very flexible and can support more
7+
advanced use cases if someone writes the code. Any plugins that support SDK
8+
interactions will be listed under the :any:`plugins<OpenRGBClient.plugins>`
9+
10+
11+
`OpenRGBEffectsPlugin<https://gitlab.com/OpenRGBDevelopers/OpenRGBEffectsPlugin>`_
12+
-----------------------------------------------------------------------------------
13+
14+

0 commit comments

Comments
 (0)