projects / irc / weechat / qweechat.git / blame
| Commit | Line | Data |
|---|---|---|
| 6f4e0369 SH |
1 | = QWeeChat |
| 2 | :author: Sébastien Helleu | |
| 3 | :email: flashcode@flashtux.org | |
| 4 | :lang: en | |
| 5 | ||
| 6 | ||
| 7ae4dcb4 SH |
7 | image:https://travis-ci.org/weechat/qweechat.svg?branch=master["Build Status", link="https://travis-ci.org/weechat/qweechat"] |
| 8 | ||
| 6f4e0369 SH |
9 | QWeeChat is a Qt remote GUI for WeeChat written in Python. |
| 10 | ||
| 9036a59a | 11 | Homepage: https://weechat.org/ |
| 6f4e0369 | 12 | |
| 6f4e0369 SH |
13 | == Features |
| 14 | ||
| 15 | * Multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & others). | |
| 16 | * Free software, released under GPLv3. | |
| 17 | ||
| fa2b812c | 18 | image::https://weechat.org/media/images/screenshots/relay/medium/qweechat_shadow.png[align="center"] |
| 6f4e0369 SH |
19 | |
| 20 | == Install | |
| 21 | ||
| 22 | === Dependencies | |
| 23 | ||
| 24 | Following packages are *required*: | |
| 25 | ||
| 26 | * WeeChat (version >= 0.3.7) on local or remote machine, with relay plugin | |
| 27 | enabled and listening on a port with protocol "weechat" | |
| 7a3a48a5 AR |
28 | * Python 3.7+ |
| 29 | * PySide6 | |
| 6f4e0369 | 30 | |
| 77df9d06 | 31 | === Install via source distribution |
| 6f4e0369 SH |
32 | |
| 33 | ---- | |
| 7a3a48a5 | 34 | $ pip install . |
| 6f4e0369 SH |
35 | ---- |
| 36 | ||
| 37 | == WeeChat setup | |
| 38 | ||
| 39 | You have to add a relay port in WeeChat, for example on port 1234: | |
| 40 | ||
| 41 | ---- | |
| 42 | /set relay.network.password "mypass" | |
| 43 | /relay add weechat 1234 | |
| 44 | ---- | |
| 45 | ||
| 46 | == Connect to WeeChat | |
| 47 | ||
| 48 | In QWeeChat, click on connect and enter fields: | |
| 49 | ||
| a268fb80 SH |
50 | * _server_: the IP address or hostname of your machine with WeeChat running |
| 51 | * _port_: the relay port (defined in WeeChat) | |
| 52 | * _password_: the relay password (defined in WeeChat) | |
| 6f4e0369 | 53 | |
| a268fb80 | 54 | Options can be changed in file _~/.qweechat/qweechat.conf_. |
| 6f4e0369 SH |
55 | |
| 56 | == Copyright | |
| 57 | ||
| 8335009d | 58 | Copyright (C) 2011-2021 Sébastien Helleu <flashcode@flashtux.org> |
| 6f4e0369 SH |
59 | |
| 60 | This file is part of QWeeChat, a Qt remote GUI for WeeChat. | |
| 61 | ||
| 62 | QWeeChat is free software; you can redistribute it and/or modify | |
| 63 | it under the terms of the GNU General Public License as published by | |
| 64 | the Free Software Foundation; either version 3 of the License, or | |
| 65 | (at your option) any later version. | |
| 66 | ||
| 67 | QWeeChat is distributed in the hope that it will be useful, | |
| 68 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 69 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 70 | GNU General Public License for more details. | |
| 71 | ||
| 72 | You should have received a copy of the GNU General Public License | |
| 73 | along with QWeeChat. If not, see <http://www.gnu.org/licenses/>. |