README.md 2.32 KB
Newer Older
1 2 3
# Gajim Plugins

In this place you will find all plugins that are written for [Gajim](https://gajim.org) by the community. If you experience any problems with those plugins, please report them here.
4

Daniel Brötzmann's avatar
Daniel Brötzmann committed
5
## How to install plugins
6 7 8

There are several ways to install a plugin:

9 10
- You can browse / download / enable / configure plugins from within Gajim via 'Gajim' > 'Plugins' menu.
- You can also clone the repository directly from our Git and copy it to:
Daniel Brötzmann's avatar
Daniel Brötzmann committed
11 12

    **Linux:** `~/.local/share/gajim/plugins/`
13

Daniel Brötzmann's avatar
Daniel Brötzmann committed
14
    **Windows:** `C:\Users\USERNAME\AppData\Roaming\Gajim\Plugins`
15

16 17
- Alternatively (for developing), you can also symlink the gajim-plugins repository to Gajim's plugin path:

Daniel Brötzmann's avatar
Daniel Brötzmann committed
18
    **Symlink:** `ln -s /path/to/gajim-plugins-repository/* ~/.local/share/gajim/plugins/`
19

Daniel Brötzmann's avatar
Daniel Brötzmann committed
20
**For each major Gajim version there is a different plugins branch:**
21

Daniel Brötzmann's avatar
Daniel Brötzmann committed
22 23 24
| Version | Plugins branch |
| ------- | -------------- |
|Gajim master|[master branch](https://dev.gajim.org/gajim/gajim-plugins/tree/master)|
25 26 27
|Gajim 1.2|[1.2 branch](https://dev.gajim.org/gajim/gajim-plugins/tree/gajim_1.2)|
|Gajim 1.1|[1.1 branch](https://dev.gajim.org/gajim/gajim-plugins/tree/gajim_1.1)|
|Gajim 1.0|[1.0 branch](https://dev.gajim.org/gajim/gajim-plugins/tree/gajim_1.0)|
28

Daniel Brötzmann's avatar
Daniel Brötzmann committed
29
*Note: Using master branch for plugins requires frequent updates of both Gajim and plugins!*
30

Daniel Brötzmann's avatar
Daniel Brötzmann committed
31
## Share / improve Plugins
32

33
You have written a new plugin or want to improve an existing one?
34

Daniel Brötzmann's avatar
Daniel Brötzmann committed
35
First, thanks for that! Here is how to start:
36

Daniel Brötzmann's avatar
Daniel Brötzmann committed
37 38
- Register an account on our Gitlab [here](https://dev.gajim.org/users/sign_in)
- Tell us about your plans at [gajim@conference.gajim.org](xmpp:gajim@conference.gajim.org?join)
39
- Fork the Gajim-Plugins [repository](https://dev.gajim.org/gajim/gajim-plugins)
40
- When you are finished, do a merge request against the main plugins repository. You can read about how to use git [here](https://dev.gajim.org/gajim/gajim/wikis/howtogit).
Daniel Brötzmann's avatar
Daniel Brötzmann committed
41
- Additionally, there is a list of [plugin events](https://dev.gajim.org/gajim/gajim/wikis/development/pluginsevents) which might be helpful
42

Daniel Brötzmann's avatar
Daniel Brötzmann committed
43
**Before you put in any work, please contact us on [gajim@conference.gajim.org](xmpp:gajim@conference.gajim.org?join)**
44

45
**Please do not use dev.gajim.org for any projects that are not directly for the benefit of Gajim!**
46 47

## Plugins list
Daniel Brötzmann's avatar
Daniel Brötzmann committed
48 49

All available plugins are listed [here](https://dev.gajim.org/gajim/gajim-plugins/wikis/home).