mirror of https://github.com/42wim/matterbridge.git synced 2024-11-15 00:19:24 +01:00

Add scripting (tengo) support for every incoming message (#731 )

TengoModifyMessage allows you to specify the location of a tengo (https://github.com/d5/tengo/) script.
This script will receive every incoming message and can be used to modify the Username and the Text of that message.
The script will have the following global variables:
to modify: msgUsername and msgText
to read: msgChannel and msgAccount

The script is reloaded on every message, so you can modify the script on the fly.

Example script can be found in https://github.com/42wim/matterbridge/tree/master/gateway/bench.tengo
and https://github.com/42wim/matterbridge/tree/master/contrib/example.tengo

The example below will check if the text contains blah and if so, it'll replace the text and the username of that message.
text := import("text")
if text.re_match("blah",msgText) {
    msgText="replaced by this"
    msgUsername="fakeuser"
}

More information about tengo on: https://github.com/d5/tengo/blob/master/docs/tutorial.md and
https://github.com/d5/tengo/blob/master/docs/stdlib.md

2019-02-23 16:39:44 +01:00

11 KiB

Raw Blame History

matterbridge

A simple chat bridge
Letting people be where they want to be.
_{Bridges between a growing number of protocols. Click below to demo
or join the development chat.}

Note: Mattermost isn’t required to run matterbridge.

Features
Chat with us
Screenshots
Installing
- Binaries
- Building
Configuration
- Howto
- Examples
Running
- Docker
Changelog
FAQ
Related projects
Articles
Thanks

Features

Support bridging between any protocols
Support multiple gateways(bridges) for your protocols
Message edits and deletes
Preserves threading when possible
Attachment / files handling
Username and avatar spoofing
Private groups
API

Natively supported

3rd party via matterbridge api

API

The API is very basic at the moment.
More info and examples on the wiki.

Used by the projects below. Feel free to make a PR to add your project to this list.

MatterLink (Matterbridge link for Minecraft Server chat)
pyCord (crossplatform chatbot)
Mattereddit (Reddit chat support)
fbridge (Facebook messenger support)

Chat with us

Questions or want to test on your favorite platform? Join below:

Screenshots

See https://github.com/42wim/matterbridge/wiki

Installing

Binaries

Latest stable release v1.13.1
Development releases (follows master) can be downloaded here

Packages

Overview

Building

Go 1.9+ is required. Make sure you have Go properly installed, including setting up your GOPATH.

After Go is setup, download matterbridge to your $GOPATH directory.

cd $GOPATH
go get github.com/42wim/matterbridge

You should now have matterbridge binary in the bin directory:

$ ls bin/
matterbridge

Configuration

Basic configuration

See howto for a step by step walkthrough for creating your configuration.

Advanced configuration

matterbridge.toml.sample for documentation and an example.

Examples

Bridge mattermost (off-topic) - irc (#testing)

[irc]
    [irc.freenode]
    Server="irc.freenode.net:6667"
    Nick="yourbotname"

[mattermost]
    [mattermost.work]
    Server="yourmattermostserver.tld"
    Team="yourteam"
    Login="yourlogin"
    Password="yourpass"
    PrefixMessagesWithNick=true
    RemoteNickFormat="[{PROTOCOL}] <{NICK}> "

[[gateway]]
name="mygateway"
enable=true
    [[gateway.inout]]
    account="irc.freenode"
    channel="#testing"

    [[gateway.inout]]
    account="mattermost.work"
    channel="off-topic"

Bridge slack (#general) - discord (general)

[slack]
[slack.test]
Token="yourslacktoken"
PrefixMessagesWithNick=true

[discord]
[discord.test]
Token="yourdiscordtoken"
Server="yourdiscordservername"

[general]
RemoteNickFormat="[{PROTOCOL}/{BRIDGE}] <{NICK}> "

[[gateway]]
    name = "mygateway"
    enable=true

    [[gateway.inout]]
    account = "discord.test"
    channel="general"

    [[gateway.inout]]
    account ="slack.test"
    channel = "general"

Running

See howto for a step by step walkthrough for creating your configuration.

Usage of ./matterbridge:
  -conf string
        config file (default "matterbridge.toml")
  -debug
        enable debug
  -gops
        enable gops agent
  -version
        show version

Docker

Create your matterbridge.toml file locally eg in /tmp/matterbridge.toml

docker run -ti -v /tmp/matterbridge.toml:/matterbridge.toml 42wim/matterbridge

Changelog

See changelog.md

FAQ

See FAQ

Want to tip ? * eth: 0xb3f9b5387c66ad6be892bcb7bbc67862f3abc16f * btc: 1N7cKHj5SfqBHBzDJ6kad4BzeqUBBS2zhs

FOSSRIT/infrastructure - roles/matterbridge (Ansible role used to automate deployments of Matterbridge)
matterbridge autoconfig
matterbridge config viewer
matterbridge-heroku
mattereddit
matterlink
mattermost-plugin - Run matterbridge as a plugin in mattermost
pyCord (crossplatform chatbot)
fbridge (Facebook messenger support)

Articles

Thanks

for sponsoring demo/testing droplets.

11 KiB Raw Blame History Unescape Escape