ref: Cleanup and rearrange files, update documentation
- Remove Ruby files since they aren't supported anymore - Remove test and samples files - Move all the "stable" plugins to `src` folder to follow standard conventions - Update links and descriptions in the documentation
This commit is contained in:
68
README.md
68
README.md
@@ -1,10 +1,25 @@
|
||||
profanity-plugins
|
||||
=================
|
||||
# CProof Plugins
|
||||
|
||||
* [Website documentation](https://profanity-im.github.io/plugins.html)
|
||||
[Website documentation](https://jabber.space/guides/plugins/)
|
||||
|
||||
Building Profanity with plugin support
|
||||
--------------------------------------
|
||||
`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.
|
||||
|
||||
## Building CProof with plugin support
|
||||
|
||||
Dependencies required:
|
||||
|
||||
@@ -19,41 +34,10 @@ For Python plugins the following is also required:
|
||||
python-dev
|
||||
```
|
||||
|
||||
Installing plugins
|
||||
------------------
|
||||
## Developing plugins
|
||||
|
||||
Use the `/plugins install` command, e.g.
|
||||
|
||||
```
|
||||
/plugins install ~/projects-git/profanity-plugins/stable/say.py
|
||||
```
|
||||
|
||||
See the `/help plugins` command for further plugin management options.
|
||||
|
||||
Branches
|
||||
--------
|
||||
|
||||
* `0.5.0`: Maintenance branch compatible Profanity 0.5.0
|
||||
* `0.5.1`: Maintenance branch compatible Profanity 0.5.1
|
||||
* `master`: Development for Profanity 0.6.0 - 0.11.x
|
||||
|
||||
Developing plugins
|
||||
------------------
|
||||
|
||||
API Documentation:
|
||||
* [Python API](https://profanity-im.github.io/plugins/0.5.1/python/html/prof.html)
|
||||
* [Python hooks](https://profanity-im.github.io/plugins/0.5.1/python/html/plugin.html)
|
||||
* [C API](https://profanity-im.github.io/plugins/0.5.1/c/html/profapi_8h.html)
|
||||
* [C hooks](https://profanity-im.github.io/plugins/0.5.1/c/html/profhooks_8h.html)
|
||||
|
||||
External plugins
|
||||
------------------
|
||||
|
||||
* [moj](https://github.com/shinyblink/moj) - Replace emojis
|
||||
* [profanity-copy-message-plugin](https://github.com/lonski/profanity-copy-message-plugin) - Copy messages to clipboard.
|
||||
* [profanity-discord](https://github.com/colcrunch/profanity-discord) - Forward jabber pings on to discord through a webhook.
|
||||
* [profanity-notifycmd](https://github.com/Neo-Oli/profanity-notifycmd) - Launch a custom shell command when you receive a message in profanity.
|
||||
* [profanity-plugin-sanitise](https://github.com/nd2s/profanity-plugin-sanitise) - Clean incoming messages.
|
||||
* [profanity-shortcuts-plugin](https://github.com/ReneVolution/profanity-shortcuts-plugin) - Store custom substitution shortcuts and use them in chats.
|
||||
* [profanity-plugins by H3rnand3zzz](https://github.com/H3rnand3zzz/profanity-plugins) - Array of different **QoL** plugins.
|
||||
* [profanity-plugins by Reimar](https://github.com/ReimarPB/profanity-plugins) - Collection of 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/)
|
||||
|
||||
Reference in New Issue
Block a user