plugin-manager

A plugin manager for the game - Bombsquad. Plugin manager is a plugin in itself, which makes further modding of your game more convenient by providing easier access to community created content.

Features

Installation

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

Download 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).
Another way is to add 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.

Usage

If installed correctly, you'll see the plugin manager button in your game's settings.

That's it, you now have access to a variety of community created content waiting for you to install!

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 plugin(s) in a GitHub repository and then your plugin(s) can be installed through the custom source option in-game. See 3rd party plugin sources for more information.
New plugins are accepted through a pull request. 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. 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 plugin as an example and its behaviour when the settings icon is tapped via the plugin manager in-game.

Example:

Let's say you wanna submit this new utility-type plugin named as sample_plugin.py:

# 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 plugin is plugins/utilities. After that, you'll have to add an entry for your plugin in 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:

{
  "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:

"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 create a pull request with the plugin you've added and the modified JSON metadata file!

Updating a Plugin

Make a pull request 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 section, if you also want to add a new screenmessage to the sample_plugin.py plugin after it has been submitted, edit sample_plugin.py with whatever changes you'd like:

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 --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 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 as 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:

$ pip install -r test/pip_reqs.txt

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

$ python -m unittest discover -v

Shout out!

If you've been with the community long enough, you may have known about the amazing Mrmaxmeier's mod manager, which unfortunately wasn't maintained and failed to keep up with the game's latest versions and API changes. Well, this is another attempt to create something similar, with a hope we as a community can continue to keep it up-to-date with the original game.

License

Plugin manager's source code is licensed under the MIT license. See 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.

Dliwk/plugin-manager