From 19d6f5543d732a6f991086f0f37e5e0a718bacf4 Mon Sep 17 00:00:00 2001
From: DogmaDragon <103123951+DogmaDragon@users.noreply.github.com>
Date: Sat, 22 Nov 2025 23:19:18 +0200
Subject: [PATCH] Document "# requires" in the plugin config

---
 ui/v2.5/src/docs/en/Manual/Plugins.md | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/ui/v2.5/src/docs/en/Manual/Plugins.md b/ui/v2.5/src/docs/en/Manual/Plugins.md
index f7517aa2c..daeef036a 100644
--- a/ui/v2.5/src/docs/en/Manual/Plugins.md
+++ b/ui/v2.5/src/docs/en/Manual/Plugins.md
@@ -65,8 +65,11 @@ Plugins provide tasks which can be run from the Tasks page.
 
 The basic structure of a plugin configuration file is as follows:
 
-```
-name: <plugin name>
+```yaml
+name: <plugin name> 
+# optional list of dependancies to be included
+# "#" is is part of the config - do not remove
+# requires: <plugin ID>
 description: <optional description of the plugin>
 version: <optional version tag>
 url: <optional url>
@@ -121,6 +124,8 @@ tasks:
 
 The `name`, `description`, `version` and `url` fields are displayed on the plugins page.
 
+`# requires` will make the plugin manager select plugins matching the specified IDs to be automatically installed as dependencies. Only works with plugins within the same index.
+
 The `exec`, `interface`, `errLog` and `tasks` fields are used only for plugins with tasks.
 
 The `settings` field is used to display plugin settings on the plugins page. Plugin settings can also be set using the graphql mutation `configurePlugin` - the settings set this way do _not_ need to be specified in the `settings` field unless they are to be displayed in the stock plugin settings UI.