# CProof Plugins

[Website documentation](https://jabber.space/guides/plugins/)

`Master` is a development branch compatible with the latest version of CProof.

## Installing plugins

Use the `/plugins install` command, e.g.

```bash
/plugins install ~/path-to/sounds.py
```

Alternatively, you can use URLs to raw files to install Python plugins. For example,
```bash
/plugins install https://git.jabber.space/devs/cproof-plugins/raw/branch/master/src/sounds.py
```

See the `/help plugins` command for further plugin management options.

## Plugins description

To be described.

## Building CProof with plugin support

Dependencies required:

```
autoconf-archive
libtool
```

For Python plugins the following is also required:

```
python-dev
```

## Developing plugins

API Documentation is available on our website, [jabber.space](https://jabber.space/).
- [Python API](https://jabber.space/api-reference/python/prof/)
- [Python hooks](https://jabber.space/api-reference/python/plugin/)
- [C API](https://jabber.space/api-reference/c/profapi/)
- [C hooks](https://jabber.space/api-reference/c/profhooks/)

## External plugins (C)

- [profanity-plugins by Reimar](https://github.com/ReimarPB/profanity-plugins) - Collection of plugins


## External plugins (Python)

- [profanity-copy-message-plugin](https://github.com/lonski/profanity-copy-message-plugin) - Copy messages to clipboard.