tox-weechat/README.md

80 lines
2.7 KiB
Markdown
Raw Normal View History

2015-08-26 18:11:57 +00:00
# Tox-WeeChat
2015-01-06 14:26:19 +00:00
Tox-WeeChat is a [Tox][1] protocol plugin for [WeeChat][2]. It is functional,
2015-09-07 17:52:23 +00:00
but lacks certain features.
2014-09-02 18:54:42 +00:00
2014-09-30 18:40:24 +00:00
Current build status: [![Build Status](https://travis-ci.org/haavardp/tox-weechat.svg?branch=master)][3]
2014-09-02 20:38:30 +00:00
2015-08-26 18:11:57 +00:00
## Features
2015-01-06 14:26:19 +00:00
Below is a list of implemented features, as well as a rough roadmap for the
future.
2014-11-19 11:37:19 +00:00
- [x] One-to-one chats
- [x] Group chats (text only)
2015-01-06 14:26:19 +00:00
- [x] Proxy support
2014-11-19 11:37:19 +00:00
- [x] Multiple profiles
2015-09-07 17:52:23 +00:00
- [x] Encrypted save files
2014-11-19 11:37:19 +00:00
- [ ] Tox DNS
- [ ] File transfer
- [ ] WeeChat `/upgrade`
- [ ] Audio/video
2015-08-26 18:11:57 +00:00
## Installation
Tox-WeeChat requires [WeeChat][2] >= 1.0.1 and the latest-ish [toxcore][4].
2015-01-06 15:11:55 +00:00
It also requires CMake to be built. Installation is fairly simple; after
getting the source, compile and install using CMake:
2014-09-02 18:54:42 +00:00
$ mkdir build && cd build
2014-10-11 11:16:18 +00:00
$ cmake -DPLUGIN_PATH=~/.weechat/plugins ..
2014-09-11 02:06:20 +00:00
$ make install
2015-01-06 14:26:19 +00:00
This installs the plugin binary `tox.so` to the recommended location
`~/.weechat/plugins`. The default location is `/usr/local/lib/weechat/plugins`.
2014-09-02 18:54:42 +00:00
2015-08-26 18:11:57 +00:00
## Usage
2015-01-06 14:26:19 +00:00
- If the plugin does not load automatically, load it with `/plugin load tox`.
You may have to specify the full path to the plugin binary.
- Create a new profile with `/tox create <profile name>`. The data file is
stored in `~/.weechat/tox/` by default.
- Load your profile and connect to the Tox network with
`/tox load <profile name>`.
- Run `/help -listfull tox` to get a list of all available commands, and
`/set tox.*` for a list of options.
2014-09-02 18:54:42 +00:00
2014-10-08 09:51:50 +00:00
### Common issues
2014-10-08 09:51:50 +00:00
#### Long Tox names messing up WeeChat layout
2015-01-06 14:26:19 +00:00
Tox allows names up to 128 bytes long. To prevent long names from taking all
your screen space, you can set the following options in WeeChat:
- `weechat.bar.nicklist.size_max`
- `weechat.look.prefix_align_max`
- `buffers.look.name_size_max` (if using buffers.pl)
2014-10-11 11:16:18 +00:00
#### Tox won't connect through my proxy
2015-01-06 14:26:19 +00:00
Make sure the proxy type, address and port is correct, and that UDP is
disabled (`/set tox.profile.*.udp`).
2014-10-11 11:16:18 +00:00
2014-09-02 18:54:42 +00:00
License
---------
2015-01-02 15:09:11 +00:00
Copyright (c) 2015 Håvard Pettersson <mail@haavard.me>
2014-09-02 18:54:42 +00:00
2014-09-18 16:55:52 +00:00
This file is part of Tox-WeeChat.
Tox-WeeChat 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.
Tox-WeeChat 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 Tox-WeeChat. If not, see <http://www.gnu.org/licenses/>.
2014-09-02 18:54:42 +00:00
2014-09-30 18:40:24 +00:00
[1]: http://tox.im
[2]: http://weechat.org
[3]: https://travis-ci.org/haavardp/tox-weechat
2015-08-26 18:11:57 +00:00
[4]: https://github.com/irungentoo/toxcore
2014-09-02 19:14:05 +00:00