tox-weechat/README.md

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 for now. Bug reports and suggestions are appreciated.

[![Build Status](https://travis-ci.org/haavardp/tox-weechat.svg?branch=master)](https://travis-ci.org/haavardp/tox-weechat)

Installation
------------
Tox-WeeChat requires [libtoxcore][3] (and WeeChat) to work. After getting them, install Tox-WeeChat like this:

    $ git clone https://github.com/haavardp/tox-weechat.git
    $ cd tox-weechat
    $ mkdir build && cd build
    $ cmake -DHOME_FOLDER_INSTALL=ON ..
    $ make
    $ make install

This installs the plugin binary `tox.so` in the recommended location `~/.weechat/plugins`. To install the plugin somewhere else, replace the cmake command above with either of these:

 - To install to `/usr/local/lib/weechat/plugins`: `cmake ..`
 - To install to `/usr/lib/weechat/plugins`: `cmake -DCMAKE_INSTALL_PREFIX=/usr ..`
 - To install a custom path: `cmake -DINSTALL_PATH=/some/path ..`

You may also need to `sudo make install`, depending on permissions.

Usage
-----
In WeeChat, load the plugin: `/plugin load tox`. In cases where WeeChat can't find the plugin, try specifying the full path to the binary. You should get a new buffer called tox. This is the core Tox buffer, where output from commands will appear.

 - In WeeChat, load the plugin with `/plugin load tox`. If it fails, try specifying the full path to the binary.
 - Create a new identity with `/tox add <name>`. The data file is created in `<WeeChat home>/tox/<name>` by default. Can be changed with `/set tox.identity.<name>.save_file`.
 - Connect your new identity to the Tox network with `/tox connect <name>`.

The following commands must be executed on a Tox buffer:

 - To change your name, `/name <new name>`.
 - Get your Tox address with `/myaddress`.
 - 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`.

A list of commands is available with `/help -list tox`.

TODO
----
 - [x] Support multiple identities
 - [ ] Preserve friend requests when closing
 - [ ] Group chats
 - [ ] Polish and reach a "stable" release
   - [ ] Add autocomplete to all commands

License
---------
Tox-WeeChat is licensed under the MIT license. For more information, see the LICENSE file.

Copyright (c) 2014 Håvard Pettersson <haavard.pettersson@gmail.com>.

[1]: http://weechat.org
[2]: http://tox.im
[3]: https://github.com/irungentoo/toxcore
Added README.md and LICENSE. 2014-09-02 18:54:42 +00:00			`Tox-WeeChat`
			`===========`
Added TODO list. 2014-09-10 22:29:09 +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 for now. Bug reports and suggestions are appreciated.`
Added README.md and LICENSE. 2014-09-02 18:54:42 +00:00
Added build status badge. 2014-09-02 20:38:30 +00:00			`[![Build Status](https://travis-ci.org/haavardp/tox-weechat.svg?branch=master)](https://travis-ci.org/haavardp/tox-weechat)`

Added README.md and LICENSE. 2014-09-02 18:54:42 +00:00			`Installation`
			`------------`
Improved build process and instructions. 2014-09-10 00:45:12 +00:00			`Tox-WeeChat requires [libtoxcore][3] (and WeeChat) to work. After getting them, install Tox-WeeChat like this:`
Added README.md and LICENSE. 2014-09-02 18:54:42 +00:00
Added -DPREFIX option to cmake build. 2014-09-02 19:10:00 +00:00			`$ git clone https://github.com/haavardp/tox-weechat.git`
			`$ cd tox-weechat`
Restored build instructions. This reverts commit 5a99af58d6e7840bfe8f8dc824379a6520e8a257. 2014-09-02 21:27:53 +00:00			`$ mkdir build && cd build`
Update README.md 2014-09-11 02:06:20 +00:00			`$ cmake -DHOME_FOLDER_INSTALL=ON ..`
			`$ make`
			`$ make install`

			This installs the plugin binary `tox.so` in the recommended location `~/.weechat/plugins`. To install the plugin somewhere else, replace the cmake command above with either of these:
Added README.md and LICENSE. 2014-09-02 18:54:42 +00:00
Improved build instructions. 2014-09-10 22:39:56 +00:00			- To install to `/usr/local/lib/weechat/plugins`: `cmake ..`
			- To install to `/usr/lib/weechat/plugins`: `cmake -DCMAKE_INSTALL_PREFIX=/usr ..`
Update README.md 2014-09-11 02:06:20 +00:00			- To install a custom path: `cmake -DINSTALL_PATH=/some/path ..`
Update README.md 2014-09-11 02:07:03 +00:00
			You may also need to `sudo make install`, depending on permissions.
Added README.md and LICENSE. 2014-09-02 18:54:42 +00:00
			`Usage`
			`-----`
Improved build process and instructions. 2014-09-10 00:45:12 +00:00			In WeeChat, load the plugin: `/plugin load tox`. In cases where WeeChat can't find the plugin, try specifying the full path to the binary. You should get a new buffer called tox. This is the core Tox buffer, where output from commands will appear.
Added README.md and LICENSE. 2014-09-02 18:54:42 +00:00
More support for multiple identities. 2014-09-13 10:22:26 +00:00			- In WeeChat, load the plugin with `/plugin load tox`. If it fails, try specifying the full path to the binary.
			- Create a new identity with `/tox add <name>`. The data file is created in `<WeeChat home>/tox/<name>` by default. Can be changed with `/set tox.identity.<name>.save_file`.
			- Connect your new identity to the Tox network with `/tox connect <name>`.

			`The following commands must be executed on a Tox buffer:`

Added README.md and LICENSE. 2014-09-02 18:54:42 +00:00			- To change your name, `/name <new name>`.
			- Get your Tox address with `/myaddress`.
			- 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`.

Typo 2014-09-02 22:22:35 +00:00			A list of commands is available with `/help -list tox`.
Added README.md and LICENSE. 2014-09-02 18:54:42 +00:00
Added TODO list. 2014-09-10 22:29:09 +00:00			`TODO`
			`----`
More support for multiple identities. 2014-09-13 10:22:26 +00:00			`- [x] Support multiple identities`
Added TODO list. 2014-09-10 22:29:09 +00:00			`- [ ] Preserve friend requests when closing`
			`- [ ] Group chats`
			`- [ ] Polish and reach a "stable" release`
More support for multiple identities. 2014-09-13 10:22:26 +00:00			`- [ ] Add autocomplete to all commands`
Added TODO list. 2014-09-10 22:29:09 +00:00
Added README.md and LICENSE. 2014-09-02 18:54:42 +00:00			`License`
			`---------`
			`Tox-WeeChat is licensed under the MIT license. For more information, see the LICENSE file.`

Added -DPREFIX option to cmake build. 2014-09-02 19:10:00 +00:00			`Copyright (c) 2014 Håvard Pettersson <haavard.pettersson@gmail.com>.`
Added README.md and LICENSE. 2014-09-02 18:54:42 +00:00
			`[1]: http://weechat.org`
			`[2]: http://tox.im`
			`[3]: https://github.com/irungentoo/toxcore`
Make CMake install plugin locally. 2014-09-02 19:14:05 +00:00