Matrix/node-red-contrib-matrix-chat-jw
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
https://github.com/Skylar-Tech/node-red-contrib-matrix-chat.git
8 Commits 6 Branches 14 Tags 1.9 MiB
HTML 53.2%
JavaScript 46.8%
aeb52518ad
Go to file
Skylar Sadlier aeb52518ad Update some docs
2021-08-18 14:39:35 -06:00
examples Added some examples 2021-08-18 14:19:20 -06:00
src Update some docs 2021-08-18 14:39:35 -06:00
.gitignore Initial commit of an alpha version. 2021-08-14 09:00:57 -06:00
example.png - matrix-receive node updated so that msg.sender is msg.userId instead (for better node chaining). 2021-08-18 11:18:29 -06:00
LICENSE Initial commit 2021-08-11 18:06:06 -06:00
package-lock.json - matrix-receive node updated so that msg.sender is msg.userId instead (for better node chaining). 2021-08-18 11:18:29 -06:00
package.json - matrix-receive node updated so that msg.sender is msg.userId instead (for better node chaining). 2021-08-18 11:18:29 -06:00
README.md Added some examples 2021-08-18 14:19:20 -06:00

README.md

node-red-contrib-matrix-chat

Matrix chat server client for Node-RED

Currently we are in beta. We ask that you open any issues you have on our repository to help us reach a stable well tested version. Things may change & break before our first release so check changelog before updating.

Features

The following is supported from this package:

  • Receive events from a room (messages, reactions, images, and files)
  • Send Images/Files
  • Send HTML/Plain Text Message/Notice
  • React to messages
  • Register user's on closed registration Synapse servers using registration_shared_secret (Admin Only)
  • List out users on a Synapse server (Admin Only)
  • Get WhoIs info for a Synapse user (Admin Only)
  • Add/Edit Synapse users using the v2 API (requires a pre-existing admin account)
  • Get a user list from a room
  • Kick user from room
  • Ban user from room

Therefore, you can easily build a bot, chat relay, or administrate your Matrix server from within Node-RED.

Examples

We have examples! Check them out

Installing

You can either install from within Node-RED by searching for node-red-contrib-matrix-chat or run this from within your Node-RED directory:

npm install node-red-contrib-matrix-chat

Usage

Using this package is very straightforward. Examples coming soon!

Other Packages

Contributing

All contributions are welcome! If you do add a feature please do a pull request so that everyone benefits :) Sharing is caring.