From 7b38c9e63714f0b8b1d74f85c0abbd92096f1ea9 Mon Sep 17 00:00:00 2001 From: Jonathan Harris <jonathan@marginal.org.uk> Date: Sat, 9 Jan 2016 16:42:39 +0000 Subject: [PATCH] Document packaging and installing plugins. --- PLUGINS.md | 7 +++++++ README.md | 13 +++++++++++++ 2 files changed, 20 insertions(+) diff --git a/PLUGINS.md b/PLUGINS.md index 566808ec..43d16178 100644 --- a/PLUGINS.md +++ b/PLUGINS.md @@ -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. diff --git a/README.md b/README.md index 0cf835be..e2d48090 100644 --- a/README.md +++ b/README.md @@ -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 --------