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

Document packaging and installing plugins.

Browse Source
This commit is contained in:
Jonathan Harris 2016-01-09 16:42:39 +00:00
parent d9203191af
commit 7b38c9e637
2 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
PLUGINS.md
View File

@ -93,3 +93,10 @@ def cmdr_data(data):
```
The data is a dictionary and full of lots of wonderful stuff!
# Distributing a Plugin
To package your plugin for distribution simply create a `.zip` archive of your plugin's folder:
* Windows: In Explorer right click on your plugin's folder and choose Send to → Compressed (zipped) folder.
* Mac: In Finder right click on your plugin's folder and choose Compress.

13
README.md
View File

@ -84,6 +84,19 @@ Windows:
Note: Uninstalling the app does not delete any output files that it has previously written.
Plugins
--------
Plugins extend the behavior of this app. To install a downloaded plugin, open the `.zip` archive and move the folder contained inside into the following folder:
* Windows: `%LOCALAPPDATA%\EDMarketConnector\plugins` (usually `C:\Users\you\AppData\Local\EDMarketConnector\plugins`).
* Mac: `~/Library/Application Support/EDMarketConnector/plugins` (in Finder hold ⌥ and choose Go → Library to open your `~/Library` folder).
* Linux: `$XDG_DATA_HOME/EDMarketConnector/plugins`, or `~/.local/share/EDMarketConnector/plugins` if `$XDG_DATA_HOME` is unset.
You will need to re-start EDMC for it to notice the new plugin.
Refer to [PLUGINS.md](PLUGINS.md) if you would like to write a plugin.
Troubleshooting
--------