Skip to main content

Matterbridge API plugin for Delta Chat

Project description

Matterdelta

Latest Release CI Code style: black

Matterdelta is a Matterbridge API plugin allowing to connect Delta Chat group chats to the various chat services supported by Matterbridge.

Install

pip install matterdelta

Usage

Configure the bot's Delta Chat account:

matterdelta init dcaccount:nine.testrun.org

The bot's display name, avatar and status/signature can also be tweaked:

matterdelta config selfavatar "/path/to/avatar.png"
matterdelta config displayname "Bridge Bot"
matterdelta config selfstatus "Hi, I am a Delta Chat bot"

To run the bot so it starts processing messages:

matterdelta serve

To see all available options run matterdelta --help

Example Configuration

matterbridge.toml

[api]
    [api.deltachat]
    BindAddress="127.0.0.1:4242"
    Token="MATTERBRIDGE_TOKEN"
    Buffer=1000
    RemoteNickFormat="{NICK}"

...

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

    [[gateway.inout]]
    account="api.deltachat"
    channel="api"

    ...

Add these to your existing Matterbridge config to set up an API instance that Matterdelta can connect to.

config.json

{
  "gateways": [
    {"gateway": "gateway1", "accountId": 1, "chatId": 1234}
  ],
  "api": {
    "url": "http://127.0.0.1:4242",
    "token": "MATTERBRIDGE_TOKEN"
  },
  "quoteFormat": "{MESSAGE} (re @{QUOTENICK}: {QUOTEMESSAGE:.46})"
}

This file should be in Matterdelta's configuration directory, usually ~/.config/matterdelta/ in Linux-based systems.

To get the accountId and chatId of the chat you want to bridge, run the bot and add its address to your Delta Chat group, then send /id in the group, the bot will reply with the account and chat id, then edit the configuration file and restart the bot.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

matterdelta-1.7.0.tar.gz (19.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

matterdelta-1.7.0-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file matterdelta-1.7.0.tar.gz.

File metadata

  • Download URL: matterdelta-1.7.0.tar.gz
  • Upload date:
  • Size: 19.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for matterdelta-1.7.0.tar.gz
Algorithm Hash digest
SHA256 0cce6887b50002fbc40af2b67abba4d18305ca1f91dda4f73ebdcc0008192af9
MD5 a351013d1c910278c812bcbbae29a1a5
BLAKE2b-256 c90088798b203942a7a9a5bc86c40ce7dd1176232e74c38bb9adad9853553454

See more details on using hashes here.

File details

Details for the file matterdelta-1.7.0-py3-none-any.whl.

File metadata

  • Download URL: matterdelta-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 19.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for matterdelta-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 640bdd2399a3d98593d8ad7d4ebb7213c53b4d95089ae769784a92fd07a35233
MD5 ba7f137c4d96ef392e4a58c90dae2bd8
BLAKE2b-256 2159ebd533a9499c8ea63285a5487089d92aa2173e8867bcc4aa649332620a6b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page