matty/peertube-plugin-livechat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
NCTV fork of the livechat plugin.
309 Commits 3 Branches 2 Tags 49 MiB
TypeScript 59.3%
Lua 17.7%
JavaScript 16.9%
SCSS 5%
Shell 1%
cc9cbf692a
Go to file
John Livingston cc9cbf692a
Merge pull request #47 from Porrumentzio/patch-2 
Update eu.json
2021-06-11 23:26:11 +02:00
.github/ISSUE_TEMPLATE Update issue templates 2021-02-21 02:05:44 +01:00
assets Simpler settings screen (tips, help, titles, ...) 2021-06-03 12:20:19 +02:00
client Settings simplification to prepare translations. Diagnostic button is initialized by frontend. 2021-06-11 14:30:46 +02:00
conversejs Refactoring. 2021-05-18 19:13:47 +02:00
docker Adding Dockerfile. 2021-06-01 20:41:20 +02:00
documentation Documentation. 2021-06-11 18:32:32 +02:00
languages Update eu.json 2021-06-11 20:35:49 +02:00
prosody-modules mod_muc_moderation 2021-05-11 16:49:55 +02:00
public/images Changed icons to have a material flavour 2021-03-08 19:18:01 +01:00
server Text simplification to prepare translation. 2021-06-11 14:45:18 +02:00
shared Chat can be enabled in video properties. 2021-06-08 18:08:58 +02:00
.eslintrc.json Eslint: configure for standard-typescript (backend), and separate configurations depending on folders. 2021-04-07 17:20:28 +02:00
.gitignore Adding eslint. 2021-02-20 11:55:00 +01:00
.npmignore (webpack) adding webpack for dependencies bundling, .gitignore and .npmignore 2019-11-19 17:08:04 +01:00
CHANGELOG.md Chat can be enabled in video properties. 2021-06-08 18:08:58 +02:00
LICENSE Add license 2019-07-16 17:00:46 +02:00
package-lock.json npm audit fix 2021-06-02 12:08:47 +02:00
package.json Version. 2021-06-02 12:08:11 +02:00
README.md ritimo 2021-06-11 19:46:13 +02:00
ROADMAP.md . 2021-06-11 19:12:30 +02:00
webpack.config.js Settings simplification to prepare translations. Diagnostic button is initialized by frontend. 2021-06-11 14:30:46 +02:00

README.md

PeerTube plugin livechat

This plugin is meant to provide web chat for Peertube videos.

The plugin has to rely on an external tool as web chat backend. There are multiple ways to provide such functionality:

  • Prosody server controlled by Peertube (recommended): this plugin can launch a Prosody process and auto-configure it. Documentation. This is the recommanded setup, and is almost automatic to setup.
  • Connect to an existing XMPP server with ConverseJS: you can use an external Jabber/XMPP server. This server has to provide BOSH or Websocket API, accept anonymous loggin, and accept room creation. Documentation
  • Use an external web chat tool: you can use any external web chat tool, that can be included in an iframe. Documentation

For the two first solutions, the connection to the XMPP server is made with the converseJS Javascript library. XMPP is a protocol for chat applications. It is sometime known has Jabber.

If you have new feature requests, bugs, or difficulties to setup the plugin, you can use the Github issue tracker.

Here is a roadmap for upcoming features: roadmap.

If you are a webdesigner or a ConverseJS/Prosody/XMPP expert, and want to help improve this plugin, you are welcome.

Contact me

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.

Settings

For the chat mode, and related settings, please refer to the corresponding documentation:

There are several common settings. Please see the documentation here: common settings documentation.

Credits

Thanks to David Revoy for his work on Peertube's mascot, Sepia.

Some material icons downloaded from this website where used for icons: Material.io

Some Prosody Modules in the prosody-modules folder are under MIT license. Please refer to README files in each subfolder, and to the COPYING file. For more informations, here is the official Prosody Modules website.

Thanks to Framasoft for making Peertube possible, and for the support.

Thanks to ritimo for the financial support.