helpy4/bombsquad-plugin-manager
1
0
Fork 0
mirror of https://github.com/bombsquad-community/plugin-manager.git synced 2025-10-08 14:54:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
bombsquad-plugin-manager/README.md
Rikko e5c8a8e2a1
Update README.md
2022-12-18 03:58:57 +05:30

210 lines
8.5 KiB
Markdown
Raw Blame History

[![DownloadIcon]][DownloadLink]
[DownloadIcon]:https://img.shields.io/badge/Download-5555ff?style=for-the-badge&logoColor=white&logo=DocuSign
[DownloadLink]:https://cdn.jsdelivr.net/gh/bombsquad-community/plugin-manager/plugin_manager.py
[![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). Plugin manager is a plugin in itself,
which makes further modding of your game more convenient by providing easier access to community created content.
![Plugin Manager GIF](https://user-images.githubusercontent.com/106954762/190505304-519c4b91-2461-42b1-be57-655a3fb0cbe8.gif)
## Features
- [x] Completely open-source - both the plugin-manager and all the plugins in this repository.
- [x] Works on all platforms.
- [x] Only deal with plugins and updates targetting your game's current API version.
- [x] Search for plugins.
- [x] Add 3rd party plugin sources (use them at your own risk, since they may not be audited!).
- [x] Enable or disable auto-updates for plugin manager and plugins.
- [x] Immediately enable installed plugins/minigames without having to restart game.
- [x] Launch a plugin's settings directly from the plugin manager window.
- [x] Check out a plugin's source code before installing 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:
1. [Download plugin_manager.py][DownloadLink] to your mods directory (check it out by going into your game's
Settings -> Advanced -> Show Mods Folder). This is the recommended way (read next method to know why).
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.
## Usage
- If installed correctly, you'll see the plugin manager button in your game's settings.
<img src="https://user-images.githubusercontent.com/106954762/190507025-f9e0dd12-d91b-4e3e-a347-6998d776a399.png" width="600">
- 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](#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` 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:
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 has_settings_ui(self):
return True
def show_settings_ui(self, source_widget):
ba.screenmessage("You tapped my settings!")
```
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](plugins/utilities). After that, 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 create 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, 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
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!")
def has_settings_ui(self):
return True
def show_settings_ui(self, source_widget):
- ba.screenmessage("You tapped my settings!")
+ ba.screenmessage("Hey! This is my new screenmessage!")
```
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 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:
```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
```
## Shout out!
If you've been with the community long enough, you may have known about the amazing
[Mrmaxmeier's mod manager](https://github.com/Mrmaxmeier/BombSquad-Community-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](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.
Reference in a new issue View git blame Copy permalink