weechat-xmpp/README.org

76 lines
2.9 KiB
Org Mode
Raw Normal View History

2018-05-09 05:14:05 +00:00
#+TITLE: weechat-slack
#+AUTHOR: Tony Olagbaiye
2018-05-09 16:35:55 +00:00
#+EMAIL: frony0@gmail.com
2018-05-09 05:14:05 +00:00
#+DATE: 2018-05-09
#+DESCRIPTION: Weechat plugin for Slack
#+KEYWORDS: weechat slack c api
#+LANGUAGE: en
2018-05-09 13:30:47 +00:00
#+OPTIONS: H:3 num:nil toc:nil \n:nil @:t ::t |:t ^:t -:t f:t *:t <:t
#+OPTIONS: TeX:t LaTeX:nil skip:nil d:nil todo:t pri:t tags:not-in-toc
2018-05-09 05:14:05 +00:00
#+EXPORT_EXCLUDE_TAGS: exclude
#+STARTUP: showall
[[https://travis-ci.org/bqv/weechat-slack][file:https://api.travis-ci.org/bqv/weechat-slack.svg?branch=master]]
[[https://coveralls.io/github/bqv/weechat-slack?branch=master][file:https://coveralls.io/repos/github/bqv/weechat-slack/badge.svg?branch=master]]
2018-05-09 11:12:57 +00:00
| Status: | Under Development |
2018-05-09 05:14:05 +00:00
| Location: | [[http://github.com/bqv/weechat-slack]] |
2018-05-09 11:12:57 +00:00
| Version: | 0.1.0 |
2018-05-09 05:14:05 +00:00
* Description
A weechat plugin in C to extend the chat client to
support Slack workspaces via the RTM and Web APIs.
* Dependencies
- libwebsockets (static, submodule)
- json-c (static, submodule)
- weechat (>= v1.4)
* Building
#+begin_src sh
git clone git://github.com/bqv/weechat-slack.git
cd weechat-slack
make
make install
#+end_src
2018-05-09 13:18:30 +00:00
Do *NOT* run make install as root, it installs the plugin to your
local weechat plugins directory
2018-05-09 05:14:05 +00:00
2018-05-09 11:12:57 +00:00
* Tasks
** TODO [#A] Implement essential api endpoints and events
2018-05-09 16:35:55 +00:00
- [X] +Implement handling api message =message.me_message= (see [[http://github.com/bqv/weechat-slack/issues/5][#5]])+
2018-05-09 11:12:57 +00:00
- [ ] Implement sending request =chat.meMessage= (see [[http://github.com/bqv/weechat-slack/issues/5][#5]])
- [ ] Implement handling api message =message.thread_broadcast=
2018-05-09 16:35:55 +00:00
- [X] +Implement handling api message =message.bot_message= (see [[http://github.com/bqv/weechat-slack/issues/2][#2]])+
2018-05-09 11:12:57 +00:00
- [ ] Implement handling api message =message.message_changed=
- [ ] Implement handling api message =message.message_deleted=
- [ ] Implement handling api message =message.message_replied=
** TODO [#B] Implement completion engine
- [ ] Tab completion for slack emoji (see [[http://github.com/bqv/weechat-slack/issues/3][#3]])
- [ ] Tab completion for display/user names (see [[http://github.com/bqv/weechat-slack/issues/1][#1]])
- [ ] Sort nick-completion by recent (see [[http://github.com/bqv/weechat-slack/issues/4][#4]])
** TODO [#B] Implement debian packaging
- [ ] Switch to system libwebsockets package (dynamically link)
- [ ] Create configure build step (cmake? autotools?)
** TODO [#C] Implement remaining api endpoints and events
- [ ] Complete api endpoint set
- [ ] Complete api event set
** TODO [#C] Implement full weechat functionality
- [ ] Hook buffer closes
2018-05-09 11:12:57 +00:00
2018-05-09 05:14:05 +00:00
* Contributing
*Your contributions are always welcome!*
Please submit a pull request or create an issue
to add a new or missing feature.
* License
weechat-slack is licensed under the Mozilla Public
License Version 2.0 available [[https://www.mozilla.org/en-US/MPL/2.0/][here]] and in LICENSE.