diff options
Diffstat (limited to 'plugins/README.txt')
| -rw-r--r-- | plugins/README.txt | 23 |
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. |