summaryrefslogtreecommitdiff
path: root/plugins/README.txt
diff options
context:
space:
mode:
authorLivio Recchia <recchialivio@libero.it>2020-02-10 23:06:34 +0100
committerLivio Recchia <recchialivio@libero.it>2020-02-10 23:06:34 +0100
commit9a13903a2f7d3a65fdf15a65fb59cccd622e2066 (patch)
tree9403b7dff39eb5e5d7fa0f79efb69b496add4c4b /plugins/README.txt
parent11cc316b74d5f3f283413a33e7693b314741aa4a (diff)
downloadmanachat-9a13903a2f7d3a65fdf15a65fb59cccd622e2066.tar.gz
manachat-9a13903a2f7d3a65fdf15a65fb59cccd622e2066.tar.bz2
manachat-9a13903a2f7d3a65fdf15a65fb59cccd622e2066.tar.xz
manachat-9a13903a2f7d3a65fdf15a65fb59cccd622e2066.zip
Initial commit
Diffstat (limited to 'plugins/README.txt')
-rw-r--r--plugins/README.txt23
1 files changed, 23 insertions, 0 deletions
diff --git a/plugins/README.txt b/plugins/README.txt
new file mode 100644
index 0000000..8324b3d
--- /dev/null
+++ b/plugins/README.txt
@@ -0,0 +1,23 @@
+This directory contains plugins for ManaChat.
+
+To autoload the plugin, in the [Plugins] section of manachat.ini add
+
+[Plugins]
+...
+pluginname = 1
+...
+
+The plugin and it's dependencies will be autoloaded.
+The plugin must export a variable PLUGIN, and the function init()
+
+PLUGIN = {
+ 'name' : 'PluginName' # not really used atm
+ 'requires' : (plugin1, plugin2, ...) # list of required plugins
+ 'blocks' : (plugin3, plugin4, ...) # list of incompatible plugins
+}
+
+def init(config): # config is ConfigParser instance
+ # ... plugin initialisation code ...
+ pass
+
+See 'shop.py' as an example.