toxygen/docs/plugins.md

22 lines
761 B
Markdown
Raw Normal View History

2017-04-06 20:28:34 +02:00
# Plugins
2016-05-28 12:06:13 +02:00
Toxygen is the first [Tox](https://tox.chat/) client with plugins support. Plugin is Python 3.4 - 3.6 module (.py file) and directory with plugin's data which provide some additional functionality.
2016-05-28 12:06:13 +02:00
2017-04-06 20:28:34 +02:00
# How to write plugin
2016-05-28 12:06:13 +02:00
Check [Plugin API](/docs/plugin_api.md) for more info
2017-04-06 20:28:34 +02:00
# How to install plugin
2016-05-28 12:06:13 +02:00
2016-05-28 21:43:51 +02:00
Toxygen comes without preinstalled plugins.
2017-04-06 20:28:34 +02:00
1. Put plugin and directory with its data into /src/plugins/ or import it via GUI (In menu: Plugins => Import plugin)
2. Restart Toxygen or choose Plugins => Reload plugins in menu.
2016-05-28 12:06:13 +02:00
2017-04-06 20:28:34 +02:00
## Note: /src/plugins/ should contain plugin_super_class.py and __init__.py
2016-06-28 20:47:49 +02:00
2017-04-06 20:28:34 +02:00
# Plugins list
2016-05-28 12:06:13 +02:00
WARNING: It is unsecure to install plugin not from this list!
2017-03-04 21:35:46 +01:00
[Main repo](https://github.com/toxygen-project/toxygen_plugins)