tox-weechat/README.md

68 lines
2.8 KiB
Markdown
Raw Normal View History

2014-09-02 18:54:42 +00:00
Tox-WeeChat
===========
2014-09-17 15:49:12 +00:00
Tox-WeeChat is a C plugin for the [WeeChat][1] chat client that enables it to connect to the [Tox][2] network. It is functional, but fairly limited in features and not intended for general use yet.
2014-09-02 18:54:42 +00:00
2014-09-17 15:49:12 +00:00
Current build status: [![Build Status](https://travis-ci.org/haavardp/tox-weechat.svg?branch=master)](https://travis-ci.org/haavardp/tox-weechat)
2014-09-02 20:38:30 +00:00
2014-09-02 18:54:42 +00:00
Installation
------------
2014-09-18 17:39:40 +00:00
> Tox-WeeChat is available on the [AUR][3].
2014-09-18 17:44:02 +00:00
Tox-WeeChat requires [WeeChat][1] >=1.0, [libjansson][4] >=2.5, and the latest-ish [libtoxcore][5]. 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-09-11 02:06:20 +00:00
$ cmake -DHOME_FOLDER_INSTALL=ON ..
$ make
$ make install
2014-09-18 17:44:02 +00:00
This installs the plugin binary `tox.so` in the recommended location `~/.weechat/plugins`. Omitting the home folder flag installs it to `/usr/local/lib/weechat/plugins`. Installing to a custom WeeChat home or similar is achieved by setting `INSTALL_PATH`.
2014-09-02 18:54:42 +00:00
Usage
-----
2014-09-18 17:44:02 +00:00
- If the plugin does no automatically load, load itw ith `/plugin load tox`. You may have to specify the full path to the plugin binary.
2014-09-17 15:49:12 +00:00
- Create a new identity with `/tox add <name>`. The data file is stored in `<WeeChat home>/tox/` by default.
- Connect your identity to the Tox network with `/tox connect <name>`.
- Change your name with `/name <new name>`.
2014-09-02 18:54:42 +00:00
- Get your Tox address with `/myaddress`.
- To add friends or respond to friend requests, `/help friend` will get you started.
2014-09-17 15:49:12 +00:00
- Message a friend with `/msg <friend number>`. Get their friend number with `/friend list`.
2014-09-02 18:54:42 +00:00
2014-09-02 22:22:35 +00:00
A list of commands is available with `/help -list tox`.
2014-09-02 18:54:42 +00:00
2014-09-18 15:59:43 +00:00
TODO & Implemented features
2014-09-10 22:29:09 +00:00
----
2014-09-17 15:49:12 +00:00
- [x] Adding friends, one-to-one chats
2014-09-13 10:22:26 +00:00
- [x] Support multiple identities
2014-09-18 15:59:43 +00:00
- [x] Save friend requests
2014-09-17 22:15:53 +00:00
- [ ] Encrypted save files
2014-09-13 19:24:11 +00:00
- [ ] Tox DNS
2014-09-17 15:49:12 +00:00
- [ ] Group chats (awaiting libtoxcore implementation)
- [ ] Support proxies (TOR)
- [ ] A/V (long term)
2014-09-10 22:29:09 +00:00
2014-09-02 18:54:42 +00:00
License
---------
2014-09-18 16:55:52 +00:00
Copyright (c) 2014 Håvard Pettersson <haavard.pettersson@gmail.com>
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
[1]: http://weechat.org
[2]: http://tox.im
2014-09-18 17:39:40 +00:00
[3]: https://aur.archlinux.org/packages/tox-weechat-git
[4]: http://www.digip.org/jansson/
[5]: https://github.com/irungentoo/toxcore
2014-09-02 19:14:05 +00:00