README.md 2.28 KB
Newer Older
1 2
## Welcome to the Gajim Plugins Wiki
                
Daniel Brötzmann's avatar
Daniel Brötzmann committed
3
In this place you find all plugins that are written for <a href="https://gajim.org">Gajim</a> 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:

Daniel Brötzmann's avatar
Daniel Brötzmann committed
9 10 11 12
 - 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:

    **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

Daniel Brötzmann's avatar
Daniel Brötzmann committed
16 17 18
 - Alternatively (for developing), you can also symlink the gajim-plugins repository to Gajim's plugin path
 
    **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 25 26
| Version | Plugins branch |
| ------- | -------------- |
|Gajim 1.0|[1.0 branch](https://dev.gajim.org/gajim/gajim-plugins/tree/gajim_1.0)|
|Gajim 1.1|[1.1 branch](https://dev.gajim.org/gajim/gajim-plugins/tree/gajim_1.1)|
|Gajim master|[master branch](https://dev.gajim.org/gajim/gajim-plugins/tree/master)|
27

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

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

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

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

Daniel Brötzmann's avatar
Daniel Brötzmann committed
36 37
- 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)
38
- Fork the Gajim-Plugins [repository](https://dev.gajim.org/gajim/gajim-plugins)
Daniel Brötzmann's avatar
Daniel Brötzmann committed
39 40
- When you are finished, make a pull request against the main repository. You can read about how to use git [here](https://dev.gajim.org/gajim/gajim/wikis/howtogit).
- Additionally, there is a list of [plugin events](https://dev.gajim.org/gajim/gajim/wikis/development/pluginsevents) which might be helpful
41

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

**Dont use dev.gajim.org for any projects that are not directly for the benefit of Gajim**

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

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