peertube-plugin-livechat/README.md

54 lines
2.5 KiB
Markdown
Raw Normal View History

2021-11-04 12:57:37 +00:00
# PeerTube plugin livechat 🇬🇧
2020-08-21 07:49:48 +00:00
2021-11-04 12:59:52 +00:00
🇫🇷 French version / Version française [ici](README.fr.md).
2022-04-02 22:24:33 +00:00
🇩🇪 German version / deutsche Version [hier](./README.de.md).
2021-02-18 17:31:12 +00:00
2021-11-04 12:57:37 +00:00
This [Peertube](https://joinpeertube.org/) plugin is meant to provide chat system for Peertube videos.
2021-07-20 08:40:07 +00:00
2021-11-04 13:00:59 +00:00
![Chat screenshot](documentation/screenshots/chat.png)
2021-12-01 17:12:26 +00:00
![Fullscreen chat screenshot](documentation/screenshots/fullscreen.png)
2021-11-04 13:58:11 +00:00
See a [demo](https://www.yiny.org/w/399a8d13-d4cf-4ef2-b843-98530a8ccbae).
2021-11-04 12:57:37 +00:00
**IMPORTANT:** unfortunately this plugin does not (yet) work by itself, it must rely on external tools. Please read the [installation guide](documentation/installation.md).
2021-07-20 08:40:58 +00:00
2021-11-04 12:57:37 +00:00
**Before updating to a major release, please read the release notes and breaking changes list : [CHANGELOG](CHANGELOG.md)**.
2021-02-18 17:31:12 +00:00
2021-11-04 12:57:37 +00:00
## Documentation
2021-11-04 13:01:59 +00:00
* [Installation guide](documentation/installation.md)
* [User guide](documentation/user.md)
* [Administrator guide](documentation/admin.md)
2021-11-04 12:57:37 +00:00
## New features requests / Bug tracking
2021-02-20 23:02:31 +00:00
If you have new feature requests, bugs, or difficulties to setup the plugin, you can use the [Github issue tracker](https://github.com/JohnXLivingston/peertube-plugin-livechat/issues).
2021-11-04 13:03:11 +00:00
Here is a roadmap for upcoming features: [ROADMAP](ROADMAP.md).
2021-04-29 11:45:01 +00:00
2021-02-20 23:02:31 +00:00
If you are a webdesigner or a ConverseJS/Prosody/XMPP expert, and want to help improve this plugin, you are welcome.
2021-02-19 18:57:18 +00:00
2021-02-22 18:41:37 +00:00
## Contact me
2021-02-22 13:40:58 +00:00
2021-03-02 15:18:27 +00:00
If you have any question, or if you want to talk about this plugin, you can join this XMPP room with any Jabber client: [plugin-livechat-support@room.im.yiny.org](xmpp:plugin-livechat-support@room.im.yiny.org?join).
2021-02-22 13:40:58 +00:00
2021-11-04 13:03:49 +00:00
If you want to support the project financially, you can contact me by mail at git.[at].john-livingston.fr, or check my [Liberapay profile](https://liberapay.com/JohnLivingston/).
2021-11-04 12:57:37 +00:00
## Contribute
2021-02-19 18:44:19 +00:00
Please refer to the page [CONTRIBUTING.md](CONTRIBUTING.md).
## Credits
2021-11-04 12:57:37 +00:00
[package.json](package.json), [COPYRIGHT](COPYRIGHT.md) and [LICENSE](LICENSE) files contain the license information for this software and its dependencies.
2021-11-04 12:57:37 +00:00
Thanks to David Revoy for his work on Peertube's mascot, [Sepia](https://www.davidrevoy.com/index.php?tag/peertube).
2022-01-06 01:36:14 +00:00
The character design is under CC-By licence, and the SVG files used to create some logo and avatars in this plugin are GPLv3.0.
2021-06-11 16:32:32 +00:00
2021-11-04 12:57:37 +00:00
Thanks to [Framasoft](https://framasoft.org) for making [Peertube](https://joinpeertube.org/) possible, and for the financial support.
2021-06-11 16:32:32 +00:00
2021-06-11 17:46:13 +00:00
Thanks to [ritimo](https://www.ritimo.org/) for the financial support.
2021-11-03 17:13:00 +00:00
Thanks to [Code Lutin](https://www.codelutin.com/) for the financial support.