Chat-O-Matic/README.md

50 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

2021-08-19 02:28:06 -05:00
# ![Chat-O-Matic Icon](data/icons/AppIcon.png) Chat-O-Matic
2021-06-07 11:57:49 -05:00
![GSoC 2021](https://img.shields.io/badge/GSoC-2021-green.svg)
2015-06-25 08:30:38 -05:00
2021-08-19 02:28:06 -05:00
Chat-O-Matic is a multi-protocol chat program based on [Caya](https://github.com/Augustolo/Caya).
2021-08-19 17:05:12 -05:00
![Screenshot](data/screenshots/update-final.png)
2021-08-18 15:59:44 -05:00
It can use protocols through native add-ons as well as through libpurple,
the library used by [Pidgin](https://pidgin.im/).
2021-08-18 15:59:44 -05:00
Protocols natively supported include IRC and XMPP.
Protocols generally supported through libpurple include GroupWise, Zephyr, and
[others through plugins](https://pidgin.im/plugins/?type=Protocol).
2015-06-25 08:34:08 -05:00
2021-06-07 11:57:49 -05:00
## Building
2021-08-19 02:28:06 -05:00
You can make Chat-O-Matic and its protocols with:
2021-06-08 10:25:50 -05:00
2021-06-07 11:57:49 -05:00
`$ make`
2021-06-08 10:25:50 -05:00
2021-07-07 15:08:41 -05:00
Or one-by-one:
2021-06-30 14:30:04 -05:00
`$ make libs; make app; make protocols`
2021-08-19 02:28:06 -05:00
Chat-O-Matic itself requires the `expat_devel` package, the XMPP protocol requires
2021-07-11 15:30:34 -05:00
`gloox_devel`, and the libpurple add-on requires `libpurple_devel` and
2021-08-19 17:05:12 -05:00
`glib2_devel`.
2021-07-11 15:30:34 -05:00
2021-06-08 10:25:50 -05:00
2021-08-18 15:59:44 -05:00
## Installation
2021-08-19 02:28:06 -05:00
Protocol add-ons can be installed in any add-ons directory under `chat-o-matic`
(i.e., `~/config/non-packaged/add-ons/chat-o-matic/`) or in the binary's CWD
(`./chat-o-matic/`).
2021-08-18 15:59:44 -05:00
libpurple plugins can be installed to any lib directory under `purple-2`
(i.e., `~/config/non-packaged/lib/purple-2/`).
2021-06-26 21:36:38 -05:00
## License
2021-08-19 02:28:06 -05:00
Chat-O-Matic is under the MIT license, but licenses vary for the included
2021-06-26 21:36:38 -05:00
libraries and add-ons.
The `xmpp` and `purple` add-ons are under the GPLv2+, and `irc` the MIT license.
`libsupport` is under the MIT license, though containing some PD code.
`librunview` contains code from Vision, and is under the MPL.
`libinterface` is under the MIT license.