]>
Commit | Line | Data |
---|---|---|
06495c6b SH |
1 | # WeeChat Qt remote GUI |
2 | ||
3 | [![Build Status](https://github.com/weechat/qweechat/workflows/CI/badge.svg)](https://github.com/weechat/qweechat/actions?query=workflow%3A%22CI%22) | |
4 | ||
5 | QWeeChat is a Qt remote GUI for WeeChat written in Python. | |
6 | ||
7 | Homepage: https://weechat.org/ | |
8 | ||
9 | ## Features | |
10 | ||
11 | - Multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & others). | |
12 | - Free software, released under GPLv3. | |
13 | ||
14 | ![QWeeChat](https://weechat.org/media/images/screenshots/relay/medium/qweechat_shadow.png) | |
15 | ||
16 | ## Install | |
17 | ||
18 | ### Dependencies | |
19 | ||
20 | QWeeChat requires: | |
21 | ||
22 | - Python ≥ 3.7 | |
23 | - [PySide6](https://pypi.org/project/PySide6/) | |
24 | - [WeeChat](https://weechat.org) ≥ 0.3.7, on local or remote machine, with relay plugin enabled and listening on a port with protocol "weechat" | |
25 | ||
26 | ### Install via source distribution | |
27 | ||
28 | ``` | |
29 | $ pip install . | |
30 | ``` | |
31 | ||
32 | ## WeeChat setup | |
33 | ||
34 | You have to add a relay port in WeeChat, for example on port 1234: | |
35 | ||
36 | ``` | |
37 | /set relay.network.password "mypass" | |
38 | /relay add weechat 1234 | |
39 | ``` | |
40 | ||
41 | ## Connect to WeeChat | |
42 | ||
43 | In QWeeChat, click on connect and enter fields: | |
44 | ||
ae648fd7 | 45 | - `hostname`: the IP address or hostname of your machine with WeeChat running |
06495c6b SH |
46 | - `port`: the relay port (defined in WeeChat) |
47 | - `password`: the relay password (defined in WeeChat) | |
3b0947c9 | 48 | - `totp`: the Time-Based One-Time Password (optional, to set if required by WeeChat) |
06495c6b | 49 | |
72c425ba | 50 | Options can be changed in file `~/.config/qweechat/qweechat.conf`. |
06495c6b SH |
51 | |
52 | ## Copyright | |
53 | ||
54 | Copyright © 2011-2021 [Sébastien Helleu](https://github.com/flashcode) | |
55 | ||
56 | This file is part of QWeeChat, a Qt remote GUI for WeeChat. | |
57 | ||
58 | QWeeChat is free software; you can redistribute it and/or modify | |
59 | it under the terms of the GNU General Public License as published by | |
60 | the Free Software Foundation; either version 3 of the License, or | |
61 | (at your option) any later version. | |
62 | ||
63 | QWeeChat is distributed in the hope that it will be useful, | |
64 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
65 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
66 | GNU General Public License for more details. | |
67 | ||
68 | You should have received a copy of the GNU General Public License | |
69 | along with QWeeChat. If not, see <https://www.gnu.org/licenses/>. |