ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-13 07:47:14 +03:00
Code Issues Projects Releases Wiki Activity

Plugins.md: Minor edits

Browse Source 
* One more plugin_start() -> plugin_start3()
 * Startup and Shutdown events linkified in sections.
 * Note the use of the return from plugin_start3()
 * Point out the cmdr_data() `data` dictionary is from CAPI `/profile`
This commit is contained in:
Athanasius 2020-07-01 18:29:56 +01:00
parent 3b233771ff
commit 3b5a510653
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
PLUGINS.md
View File

@ -19,6 +19,7 @@ Each plugin has it's own folder in the `plugins` directory:
Plugins are python files. The plugin folder must have a file named `load.py` that must provide one module level function and optionally provide a few others. Plugins are python files. The plugin folder must have a file named `load.py` that must provide one module level function and optionally provide a few others.
##Startup
EDMC will import the `load.py` file as a module and then call the `plugin_start3()` function. EDMC will import the `load.py` file as a module and then call the `plugin_start3()` function.
```python ```python
@ -29,9 +30,11 @@ def plugin_start3(plugin_dir):
print("I am loaded! My plugin folder is {}".format(plugin_dir)) print("I am loaded! My plugin folder is {}".format(plugin_dir))
return "Test" return "Test"
``` ```
The string you return is used as the internal name of the plugin.
Any errors or print statements from your plugin will appear in `%TMP%\EDMarketConnector.log` on Windows, `$TMPDIR/EDMarketConnector.log` on Mac, and `$TMP/EDMarketConnector.log` on Linux. Any errors or print statements from your plugin will appear in `%TMP%\EDMarketConnector.log` on Windows, `$TMPDIR/EDMarketConnector.log` on Mac, and `$TMP/EDMarketConnector.log` on Linux.
##Shutdown
This gets called when the user closes the program: This gets called when the user closes the program:
```python ```python
@ -47,10 +50,12 @@ If your plugin uses one or more threads to handle Events then stop and join() th
# Plugin Hooks # Plugin Hooks
## Configuration ## Configuration
If you want your plugin to be configurable via the GUI you can define a frame (panel) to be displayed on its own tab in EDMC's settings dialog. The tab title will be the value that you returned from `plugin_start`. Use widgets from EDMC's myNotebook.py for the correct look-and-feel. You can be notified when the settings dialog is closed so you can save your settings. If you want your plugin to be configurable via the GUI you can define a frame (panel) to be displayed on its own tab in EDMC's settings dialog. The tab title will be the value that you returned from `plugin_start3`. Use widgets from EDMC's myNotebook.py for the correct look-and-feel. You can be notified when the settings dialog is closed so you can save your settings.
You can use `set()`, `get()` and `getint()` from EDMC's `config.config` object to retrieve your plugin's settings in a platform-independent way. You can use `set()`, `get()` and `getint()` from EDMC's `config.config` object to retrieve your plugin's settings in a platform-independent way.
**Be sure to use a unique prefix for any settings you save so as not to clash with core EDMC or other plugins.**
Use `numberFromString()` from EDMC's `l10n.Locale` object to parse input numbers in a locale-independent way. Use `numberFromString()` from EDMC's `l10n.Locale` object to parse input numbers in a locale-independent way.
```python ```python
@ -176,7 +181,7 @@ def cmdr_data(data, is_beta):
sys.stderr.write(data.get('commander') and data.get('commander').get('name') or '') sys.stderr.write(data.get('commander') and data.get('commander').get('name') or '')
``` ```
The data is a dictionary and full of lots of wonderful stuff! The data is a dictionary containing the response from Frontier to a CAPI `/profile` request.
### Plugin-specific events ### Plugin-specific events