emdee/tox-weechat
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Mass refactor 💥

Browse source
This commit is contained in:
Håvard Pettersson 2014-09-28 03:29:34 +02:00
parent 6dfacdf04c
commit 8f1d0070c3
47 changed files with 3440 additions and 3205 deletions
Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -1,6 +1,6 @@
Tox-WeeChat
===========
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.
Tox-WeeChat is a plugin for [WeeChat][1] that enables it to connect to the [Tox][2] network. It is functional, but currently only intended for experimental use.
Current build status: [![Build Status](https://travis-ci.org/haavardp/tox-weechat.svg?branch=master)](https://travis-ci.org/haavardp/tox-weechat)
@ -8,37 +8,35 @@ Installation
------------
> Tox-WeeChat is available in the [AUR][3].
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:
Tox-WeeChat requires [WeeChat][1] >= 1.0 and the latest-ish [libtoxcore][4]. It also requires CMake to be built. Installation is fairly simple; after getting the source, compile and install using CMake:
$ mkdir build && cd build
$ cmake -DHOME_FOLDER_INSTALL=ON ..
$ make
$ make install
This installs the plugin binary `tox.so` to the recommended location `~/.weechat/plugins`. Omitting the home folder flag installs to `/usr/local/lib/weechat/plugins`. Installing to a custom WeeChat home or similar is achieved by setting `INSTALL_PATH`.
This installs the plugin binary `tox.so` to the recommended location `~/.weechat/plugins`. Without the home folder flag, the binary is placed in `/usr/local/lib/weechat/plugins`. Installing to a custom WeeChat folder or elsewhere is achieved by setting `INSTALL_PATH`.
Usage
-----
- If the plugin does no automatically load, load it with `/plugin load tox`. You may have to specify the full path to the plugin binary.
- Create a new identity with `/tox create <name>`. The data file is stored in `~/.weechat/tox/` by default.
- Connect your identity to the Tox network with `/tox connect <name>`.
- Create a new profile with `/tox create <name>`. The data file is stored in `~/.weechat/tox/` by default.
- Load your profile and connect to the Tox network with `/tox load <name>`.
- Change your name with `/name <new name>`.
- Get your Tox ID with `/myid`.
- To add friends or respond to friend requests, `/help friend` will get you started.
- Message a friend with `/msg <friend number>`. Get their friend number with `/friend list`.
A list of commands is available with `/help -list tox`.
Run `/help -list tox` to get a list of all available commands.
TODO & Implemented features
TODO
----
- [x] Adding friends, one-to-one chats
- [x] Support multiple identities
- [x] Save friend requests
- [ ] Encrypted save files
- [ ] Tox DNS
- [ ] Group chats (awaiting libtoxcore implementation)
- [ ] Support proxies (TOR)
- [ ] A/V (long term)
- Persist data (friend requests etc.)
- Support encrypted save files
- Tox DNS
- Group chats
- Support proxies (e.g. TOR)
- A/V
License
---------
@ -62,6 +60,5 @@ along with Tox-WeeChat. If not, see <http://www.gnu.org/licenses/>.
[1]: http://weechat.org
[2]: http://tox.im
[3]: https://aur.archlinux.org/packages/tox-weechat-git
[4]: http://www.digip.org/jansson/
[5]: https://github.com/irungentoo/toxcore
[4]: https://github.com/irungentoo/toxcore