2021-11-13 15:50:49 +00:00
# WeeChat Qt remote GUI
[![Build Status ](https://github.com/weechat/qweechat/workflows/CI/badge.svg )](https://github.com/weechat/qweechat/actions?query=workflow%3A%22CI%22)
QWeeChat is a Qt remote GUI for WeeChat written in Python.
Homepage: https://weechat.org/
## Features
- Multi-platform (GNU/Linux, *BSD, Mac OS X, QNX, Windows & others).
- Free software, released under GPLv3.
![QWeeChat ](https://weechat.org/media/images/screenshots/relay/medium/qweechat_shadow.png )
## Install
### Dependencies
QWeeChat requires:
- Python ≥ 3.7
2024-02-17 20:08:31 +00:00
- PyQt5 or PyQt5 and maybe PySide2 and PySide2 using qtpy
2024-02-17 20:23:53 +00:00
- dev-python/qtconsole; the requirements.txt file says >= 5.5.1 but earlier versions may work just fine
2024-03-08 04:24:04 +00:00
- [WeeChat ](https://weechat.org ) ≥ 0.3.7, on local or remote machine, with relay plugin enabled and listening on a port with protocol "weechat" Tested with 4.1.2
2021-11-13 15:50:49 +00:00
2024-02-17 20:08:31 +00:00
2021-11-13 15:50:49 +00:00
### Install via source distribution
2024-02-17 20:08:31 +00:00
Look at the Makefile and customize the variables; then
2021-11-13 15:50:49 +00:00
```
2024-02-17 20:08:31 +00:00
$ make install
2021-11-13 15:50:49 +00:00
```
## WeeChat setup
2024-02-17 20:08:31 +00:00
You have to add a relay port in WeeChat.
Follow the normal instructions for adding a ```relay``` to
[weechat ](https://github.com/weechat/weechat )
```
/relay add weechat 9000
/relay start weechat
```
or
2021-11-13 15:50:49 +00:00
```
2024-02-17 20:08:31 +00:00
weechat -r '/relay add weechat 9000;/relay start weechat'
```
and run qweechat either under toxygen, or standalone
```
python3 -m qweechat
2021-11-13 15:50:49 +00:00
```
## Connect to WeeChat
In QWeeChat, click on connect and enter fields:
2021-11-14 17:54:48 +00:00
- `hostname` : the IP address or hostname of your machine with WeeChat running
2021-11-13 15:50:49 +00:00
- `port` : the relay port (defined in WeeChat)
- `password` : the relay password (defined in WeeChat)
2021-11-14 17:40:26 +00:00
- `totp` : the Time-Based One-Time Password (optional, to set if required by WeeChat)
2021-11-13 15:50:49 +00:00
2021-11-13 20:15:07 +00:00
Options can be changed in file `~/.config/qweechat/qweechat.conf` .
2021-11-13 15:50:49 +00:00
## Copyright
2022-01-12 22:52:09 +00:00
Copyright © 2011-2022 [Sébastien Helleu ](https://github.com/flashcode )
2021-11-13 15:50:49 +00:00
This file is part of QWeeChat, a Qt remote GUI for WeeChat.
QWeeChat is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
QWeeChat is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with QWeeChat. If not, see < https: / / www . gnu . org / licenses / > .
2024-02-08 20:37:58 +00:00
2024-02-17 20:08:31 +00:00
## Updates
2024-02-08 20:37:58 +00:00
Up-to-date code is on https://git.plastiras.org/emdee/qweechat
2024-03-08 04:24:04 +00:00
You can also run this qweechat under toxygen
https://git.macaw.me/emdee/toxygen
For tox in weechat, see https://git.macaw.me/emdee/tox-weechat