Quickstart Guide

Rob Franken edited this page Apr 25, 2017 · 18 revisions

Basic Requirements


You must be running a sufficiently recent version of weechat for this application to work. You can check the version you currently have by running /version in weechat server buffer. Anything newer than 0.3.7 should work.

Note: Support for highlights in irc/other buffers is only supported if you are running 0.3.8-dev compiled after March 6th. See upstream commit for details: http://git.savannah.gnu.org/gitweb/?p=weechat.git;a=commit;h=d495c419197c670e8649853b580e39fff0162617


This app is built to target Android devices running Android 2.1 or higher. I have personally tested it on Android 2.3.3, but have heard reports of it working on other devices. If it works fine on your device, add it to the list below:

Tested devices:

  • Samsung Epic 4G(Not the touch) – Android 2.3.3 - Works fine.
  • Android Emulator - Android 2.1 – Works fine.
  • Samsung / Google Galaxy Nexus – Works fine.
  • Samsung Galaxy S2 - Android 4.1.2 / 4.2.2 - Works fine.
  • Sony Xperia Z1 compact - Android 4.4.4 (Cyanogen) - Works fine.
  • Sony Xperia Z3 compact - Android 5.1.1 (Cyanogen) - Works fine.
  • Sony Xperia Z5 compact - Android 7.0 - Wokrks fine.
  • LG G Pro - Android 4.4.2 - Works fine.
  • LG G3 - Android 5.0 (stock) - Works fine.
  • Motorola Moto E (2nd) Android 5.0/5.1/6.0 - Works fine.
  • Samsung Galaxy Ace II Trend (GT-S7560M) - Android 4.3.1 (CM10.2, kernel 3.0.60) - Works fine.
  • Motorola Moto G Android 5.1.1 (CM12.1, kernel 3.4.42) - Works fine.
  • Motorola Moto X Play Android 6.0.1 - Works fine.
  • OnePlus X - Android 6.0.1 (OxygenOS 3.1.4) - Works fine.
  • OnePlus 3T - Android 7.0 (OxygenOS 4.0.3) - Works fine.

Configure weechat

Since this relies on the relay plugin built into weechat, we need to configure it first. The following is the help message for the relay plugin in 0.3.8-rc2.

[relay]  /relay  list|listfull|listrelay
                 add <protocol.name> <port>
                 del <protocol.name>

relay control

         list: list relay clients (only active relays)
     listfull: list relay clients (verbose, all relays)
    listrelay: list relays (name and port)
          add: add relay for a protocol + name
          del: remove relay for a protocol + name
protocol.name: protocol and name to relay:
                 - protocol "irc": name is the server to share
                 - protocol "weechat" (name is not used)
         port: port used for relay
          raw: open buffer with raw Relay data

Without argument, this command opens buffer with list of relay clients.

  irc proxy, for server "freenode":
    /relay add irc.freenode 8000
  weechat protocol:
    /relay add weechat 8001

We will be adding a relay server using the weechat protocol, and we'll stick to the port suggested in the example. So run the command:

/relay add weechat 8001
relay: listening on port 8001 (relay: weechat, max 5 clients)
relay: relay "weechat" (port 8001) added

Now that it is listening, we should set a password for it, replacing "your-secret-password" with your chosen password. Note: Connections with weechat are not encrypted, so in theory an evesdropper can intercept your password and any other communications sent.

/set relay.network.password "your-secret-password"

A note about firewalls

Since weechat is now listening for connections on port 8001, you need to make sure your firewall is setup to allow that port. If you are behind a router you will need to configure port forwarding. This is beyond the scope of this guide however.

Install the android application

Allow unknown sources

The first thing you must do is enable installation of applications that come from outside the Android Market. To do this, under settings, choose Applications, then check the box "Unknown Sources".

Download and install the app

Navigate to the main download page, or snap the QR code with a barcode scanner to download the apk file. Once it finishes downloading, tap on it and it will prompt you to install. Once installation completes, you can choose to open the app.

Configure the app

The first time you run the app, you will need to configure it. Press Menu, then Preferences.

  • Relay Host - Set this to the ip address/hostname of the machine where weechat is running
  • Relay Port - Set this to the port the weechat relay server is listening on, if you're following along it should be 8001.
  • Relay Password - The password you configured for the connection in weechat earlier.

You may wish to change some of the other preferences at this time as well. Once you leave the preferences page, press Menu, then Connect. If everything was configured successfully you should be looking at a list of all the buffers you have open in weechat.

Final Thoughts

I hope this application can be useful for you, I use it almost daily for keeping up with conversations from my phone. If you have any feature requests or bug reports, please feel free to email me or create an issue on github.


If you run into any problems getting this to work, please let me know. You can create an issue on github, send me an email, or join me on irc(See below for details)

Contact info

Email - kj@ubergeek42.com

irc - nick:ubergeek42 in #weechat-android on freenode

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.