community-plugins/README_TEMPLATE.md

Plugin Name

Explain in one or two sentences what the plugin does and why someone would use it.

Plugin

Field	Value
ID	<author>/<plugin>
Entries	Bar widget: <widget-id>; panel: <panel-id>; service: <service-id>
Launcher Prefix	/<prefix>

Requirements

Install example-cli on PATH.

Usage

Explain how to add or access every user-facing entry and describe the normal workflow. Use exact labels and ids. For a panel, include its copy-pasteable IPC command:

noctalia msg panel-toggle <author>/<plugin>:<panel-id>

For a launcher provider, explain what to type after /<prefix> and what activating a result does. For a shortcut, say where users add it in Settings.

Settings

Setting	Type	Default	Description
example_setting	bool	false	What changing this setting does.

IPC

noctalia msg plugin <author>/<plugin>:<entry-id> all <event> [payload]

Notes