README.md 2.6 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
9
**Note:** Some plugins have external dependencies that need to be installed separately.
Check the [plugin's wiki page](https://dev.gajim.org/gajim/gajim-plugins/-/wikis/home#plugins-list) for details.

10
11
There are several ways to install a plugin:

12
13
- 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
14
15

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

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

19
20
- 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
21
    **Symlink:** `ln -s /path/to/gajim-plugins-repository/* ~/.local/share/gajim/plugins/`
22

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

Daniel Brötzmann's avatar
Daniel Brötzmann committed
25
26
27
| Version | Plugins branch |
| ------- | -------------- |
|Gajim master|[master branch](https://dev.gajim.org/gajim/gajim-plugins/tree/master)|
Philipp Hörist's avatar
Philipp Hörist committed
28
|Gajim 1.3|[1.3 branch](https://dev.gajim.org/gajim/gajim-plugins/tree/gajim_1.3)|
29
30
31
|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)|
32

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

Daniel Brötzmann's avatar
Daniel Brötzmann committed
35
## Share / improve Plugins
36

37
You have written a new plugin or want to improve an existing one?
38

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

Daniel Brötzmann's avatar
Daniel Brötzmann committed
41
42
- 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)
43
- Fork the Gajim-Plugins [repository](https://dev.gajim.org/gajim/gajim-plugins)
44
- 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
45
- Additionally, there is a list of [plugin events](https://dev.gajim.org/gajim/gajim/wikis/development/pluginsevents) which might be helpful
46

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

49
**Please do not use dev.gajim.org for any projects that are not directly for the benefit of Gajim!**
50
51

## Plugins list
Daniel Brötzmann's avatar
Daniel Brötzmann committed
52
53

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