bombsquad-plugin-manager/README.md

[![CI](https://github.com/bombsquad-community/plugin-manager/actions/workflows/ci.yml/badge.svg)](https://github.com/bombsquad-community/plugin-manager/actions/workflows/ci.yml)

# plugin-manager

A plugin manager for the game - [Bombsquad](https://www.froemling.net/apps/bombsquad).


## Features

- [x] Fully open-source plugin manager, as well as all the plugins you'll find in this repository.
- [x] Ability to add 3rd party plugin sources (use them at your own risk, since they may not be audited!).
- [x] Only deal with plugins and plugin updates targetting your game's current API version.
- [x] Search installable plugins from this repository, as well as 3rd party sources.
- [x] Setting to enable or disable auto-updates for plugin manager as well plugins.
- [x] Setting to immediately enable installed plugins/minigames without having to restart game.
- [x] Ability to launch a plugin's settings directly from the plugin manager window.
- [x] Check out a plugin's source code before you even install it.
- [ ] Sync installed plugins with workspaces.
- [ ] Sort plugins by popularity, downloads, rating or some other metric.


## Installation

There are two different ways the plugin manager can be installed through:

1. Download [plugin_manager.py](https://raw.githubusercontent.com/bombsquad-community/plugin-manager/main/plugin_manager.py)
   to your mods directory (check it out by going into your game's Settings -> Advanced -> Show Mods Folder). This is the
   recommended way (see below).

2. Another way is to add
   [plugin_manager.py](https://raw.githubusercontent.com/bombsquad-community/plugin-manager/main/plugin_manager.py)
   to your workspace. However, plugin manager self-updates will fail when installed using this way since the game
   will overrwrite the updated plugin manager, with the older version from workspace on the next sync. However, you can
   manually apply updates by copying the latest plugin manager's source code again to your workspace when using this method.

## Contributing

### Submitting a Plugin

- In order for a plugin to get accepted to this official repository, it must target the general game audience and be
  completely open and readable, not be encoded or encrypted in any form.
- If your plugin doesn't target the general game audience, you can put your plugins in a GitHub repository and then
  your plugins can be installed through the custom source option in-game.
  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.
- Plugin manager will also show and execute the settings icon if your `ba.Plugin` export class has a method named
  `on_plugin_manager_prompt`; check out the
  [colorscheme](https://github.com/bombsquad-community/plugin-manager/blob/f24f0ca5ded427f6041795021f1af2e6a08b6ce9/plugins/utilities/colorscheme.py#L419-L420)
  plugin for an example and it's behaviour when the settings icon is tapped on via the plugin manager in-game.

#### Example:

Let's say you wanna submit this new utility-type plugin named as `sample_plugin.py`:
```python
# ba_meta require api 7
import ba

# ba_meta export plugin
class Main(ba.Plugin):
    def on_app_running(self):
        ba.screenmessage("Hi! I am a sample plugin!")

    def on_plugin_manager_prompt(self):
        ba.screenmessage("You tapped my settings from the Plugin Manager Window!")
```

You'll have to fork this repository and add your `sample_plugin.py` plugin file into the appropriate directory, which for
utility plugins is [plugins/utilities](plugins/utilities). Now you'll have to add an entry for your plugin
in [plugins/utilities.json](plugins/utilities.json) so that it gets picked up by the Plugin Manager in-game.

To do this, you'll have to edit the file and add something like this:
```json
{
  "name": "Utilities",
  ...
  "plugins": {
    ...
    "sample_plugin": {
      "description": "Shows screenmessages!",
      "external_url": "",
      "authors": [
        {
          "name": "Alex",
          "email": "alex@example.com",
          "discord": null
        }
      ],
      "versions": {
        "1.0.0": null
      }
    },
    ...
  }
  ...
}
```
You can add whatever you wanna add to these fields. However, leave the value for your version key as `null`:
```json
"1.0.0": null
```
Version values will automatically be populated through github-actions (along with formatting your code as per PEP8 style
guide) once you open a pull request.

Save `utilities.json` with your modified changes and now you can make us a [pull request](../../compare) with the
plugin you've added and the modified JSON metadata file!

### Updating a Plugin

- Make a [pull request](../../compare) with whatever changes you'd like to make to an existing plugin, and add a new
  version entry in your plugin category's JSON metadata file.

#### Example

Continuing the example from [Submitting a Plugin](#submitting-a-plugin) section, say you also wanna add a new screenmessage
to the `sample_plugin.py` plugin after it was submitted. Edit `sample_plugin.py` with whatever changes you'd like:
```diff
diff --git a/plugins/utilities/sample_plugin.py b/plugins/utilities/sample_plugin.py
index ebb7dcc..da2b312 100644
--- a/plugins/utilities/sample_plugin.py
+++ b/plugins/utilities/sample_plugin.py
@@ -5,6 +5,7 @@ import ba
 class Main(ba.Plugin):
     def on_app_running(self):
         ba.screenmessage("Hi! I am a sample plugin!")
+        ba.screenmessage("Hey! This is my new screenmessage!")
 
     def on_plugin_manager_prompt(self):
         ba.screenmessage("You tapped my settings from the Plugin Manager Window!")
```

To name this new version as `1.1.0`, add `"1.1.0": null,` just above the previous plugin version in `utilities.json`:
```diff
diff --git a/plugins/utilities.json b/plugins/utilities.json
index d3fd5bc..34ce9ad 100644
--- a/plugins/utilities.json
+++ b/plugins/utilities.json
@@ -14,7 +14,10 @@
         }
       ],
       "versions": {
-        "1.0.0": null
+        "1.1.0": null,
+        "1.0.0": {
+          ...
+        }
       }
     },
     ...
```
That's it! Now you can make a [pull request](../../compare) with both the updated `sample_plugin.py` and `utilities.json` files.

## 3rd Party Plugin Sources

- In case your plugin doesn't sit well with our guidelines or you wouldn't want your plugin to be here for some reason,
  you can create your own GitHub repository and put all your plugins in there.
- Check out https://github.com/rikkolovescats/sahilp-plugins for an example. You can choose to show up plugins from this
  repository in your plugin manager by adding `rikkolovescats/sahilp-plugins` as a custom source through the category
  selection popup window in-game.


## Tests

Metadata tests are automatically executed whenever a pull request is opened and a commit is pushed. You can also run them
locally by installing test dependencies with:

```bash
$ pip install -r test/pip_reqs.txt
```

and then executing the following in the project's root directory:

```bash
$ python -m unittest discover -v
```

## License

- [Plugin manager's source code](plugin_manager.py) is licensed under the MIT license. See [LICENSE](LICENSE) for more
  information.
- Any plugins you submit here are automatically assumed to be licensed under the MIT license, i.e. unless you explicitly
  specify a different license while submitting a plugin.