devs/cproof-plugins
2
1
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity
Files
70e41b5919668aa6c45e5a730e7f230f9160ec9c
cproof-plugins/README.md
James Booth 70e41b5919 Update README.md
2014-06-12 00:42:12 +01:00

2.6 KiB
Raw Blame History

profanity-plugins

Plugin support for Profanity is currently in development at the plugins branch.

Supported languages for writing plugins are C, Python, Ruby and Lua.

Building Profanity with plugin support

autoconf-archive, libtool and the development packages for each supported langauge are required e.g.:

python-dev
lua-dev
ruby-dev

Check out the plugins branch and run the usual:

./bootstrap.sh
./configure
make
sudo make install

By default, support for each language is optional and will be attempted during ./configure. To force support for a language, or disable support, the following flags may be used with ./configure.

--enable-c-plugins, --disable-c-plugins
--enable-python-plugins, --disable-python-plugins
--enable-ruby-plugins, --disable-ruby-plugins
--enable-lua-plugins, --disable-lua-plugins

A wrapper script is included to enable support for currently stable plugin languages:

./configure-plugins

This script currently forces support for C, Python and Ruby. Lua support for all platforms is still in progress.

Loading plugins

  1. Copy the plugin

For Python, Ruby and Lua plugins, copy the plugin to $XDG_DATA/profanity/plugins/, (~/.local/share/profanity/plugins/ on most systems).

For C plugins, build the plugin using the supplied Makefile, and then copy the .so file to the same location.

  1. Add to profrc

For all types of plugins, the list of plugins to acutally load when starting Profanity is defined in $XDG_CONFIG/profanity/profrc (~/.config/profanity/profrc on most systems).

For example:

[plugins]
load=browser.py;connect.lua;ChatStart.rb;cricket-score.py;platform-info.py;ascii.py;pid.so

Run the /plugins command to see a list of installed plugins.

Example plugin code

Whilst the API is being developed, the following test plugins are a good reference of possible hooks and API calls available:

tests/python-test.py
tests/RubyTest.rb
tests/luatest.lua
tests/test-c-plugin/test-c-plugin.c

Jenkins plugin

The jenkins plugin monitors builds at a jenkins server and notifies of build status changes, builds may be triggered, logs viewed, and jobs opened using the systems browser.

alt tag

Cricket score plugin

The cricket score python plugin polls a public API to find the score of a given match, shows the score in the console and a desktop notification when it changes. It also adds a /cricket command to show the score at any time.

alt tag