From c5414792e5d2e7e7d4dfcbb089343ab54af1a724 Mon Sep 17 00:00:00 2001 From: Loup <90267658+Loup-Garou911XD@users.noreply.github.com> Date: Thu, 22 Jan 2026 21:41:32 +0530 Subject: [PATCH] Update plugin submission guidelines in README Clarify requirements for submitting new plugins, including metadata structure and naming conventions. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cda60d3..963ab1b 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,9 @@ There are two different ways the plugin manager can be installed: See [3rd party plugin sources](#3rd-party-plugin-sources) for more information. - New plugins are accepted through a [pull request](../../compare). Add your plugin in the minigames, utilities, or the category directory you feel is the most relevant to the type of plugin you're submitting, [here](plugins). - Then add an entry to the category's JSON metadata file. +- You also need a `plugman` dict with the plugin metadata in the plugin (see the [example](https://github.com/bombsquad-community/plugin-manager?tab=readme-ov-file#example) below). + - The name of the plugin must be in snake_case and matching the file name. + - Must have the plugin_name, description, external_url, authors and version keys. - Plugin manager will also show and execute the settings icon if your `ba.Plugin` class has methods `has_settings_ui` and `show_settings_ui`; check out the [colorscheme](https://github.com/bombsquad-community/plugin-manager/blob/eb163cf86014b2a057c4a048dcfa3d5b540b7fe1/plugins/utilities/colorscheme.py#L448-L452) plugin for an example. #### Example: