helpy4/bombsquad-plugin-manager
1
0
Fork 0
mirror of https://github.com/bombsquad-community/plugin-manager.git synced 2026-08-15 13:03:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
! Freaku 2022-12-05 22:16:21 +05:30 • committed by GitHub
parent bde4df0e4c
commit 4f545393be
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -57,10 +57,7 @@ There are two different ways the plugin manager can be installed:
- New plugins are accepted through a [pull request](../../compare). Add your plugin in the minigames, utilities, or - 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). 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. 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 - Plugin manager will also show and execute the settings icon if your `ba.Plugin` class has methods `has_settings_ui` and `show_settings_ui`.
`on_plugin_manager_prompt`; check out the
[colorscheme](https://github.com/bombsquad-community/plugin-manager/blob/f24f0ca5ded427f6041795021f1af2e6a08b6ce9/plugins/utilities/colorscheme.py#L419-L420)
plugin as an example and its behaviour when the settings icon is tapped via the plugin manager in-game.
#### Example: #### Example:
@ -73,9 +70,6 @@ import ba
class Main(ba.Plugin): class Main(ba.Plugin):
def on_app_running(self): def on_app_running(self):
ba.screenmessage("Hi! I am a sample plugin!") 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 You'll have to fork this repository and add your `sample_plugin.py` plugin file into the appropriate directory, which for
@ -137,9 +131,6 @@ index ebb7dcc..da2b312 100644
def on_app_running(self): def on_app_running(self):
ba.screenmessage("Hi! I am a sample plugin!") ba.screenmessage("Hi! I am a sample plugin!")
+ ba.screenmessage("Hey! This is my new screenmessage!") + 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`: To name this new version as `1.1.0`, add `"1.1.0": null,` just above the previous plugin version in `utilities.json`: