mmrelay 1.0.11

Bridge between Meshtastic mesh networks and Matrix chat rooms

M<>M Relay

(Meshtastic <=> Matrix Relay)

A powerful and easy-to-use relay between Meshtastic devices and Matrix chat rooms, allowing seamless communication across platforms. This opens the door for bridging Meshtastic devices to many other platforms.

Documentation

Visit our Wiki for comprehensive guides and information.

• Installation Instructions - Setup and configuration guide
• v1.0 Release Announcement - New changes in v1.0
• Upgrade Guide - Migration guidance for existing users

---

Quick Start

MMRelay runs on Linux, macOS, and Windows.

# Install using pipx for isolated installation (recommended)
pipx install mmrelay

# Generate a sample configuration file & then edit it
mmrelay --generate-config

# Start the relay (without --install-service to run manually)
mmrelay --install-service

For detailed installation and configuration instructions, see the Installation Guide.

---

Features

• Bidirectional message relay between Meshtastic devices and Matrix chat rooms, capable of supporting multiple meshnets
• Supports serial, network, and BLE (now too!) connections for Meshtastic devices
• Custom fields are embedded in Matrix messages for relaying messages between multiple meshnets
• Truncates long messages to fit within Meshtastic's payload size
• SQLite database to store node information for improved functionality
• Customizable logging level for easy debugging
• Configurable through a simple YAML file
• Supports mapping multiple rooms and channels 1:1
• Relays messages to/from an MQTT broker, if configured in the Meshtastic firmware
• ✨️ Cross-platform reactions support ✨️ NEW!!

We would love to support Matrix E2EE rooms, but this is currently not implemented.

---

Windows Installer

The latest installer is available here.

---

Plugins

M<>M Relay supports plugins for extending its functionality, enabling customization and enhancement of the relay to suit specific needs.

Core Plugins

Generate a map of your nodes:

Produce high-level details about your mesh:

See the full list of core plugins here.

Community & Custom Plugins

MMRelay's plugin system allows you to extend functionality in two ways:

• Custom Plugins: Create personal plugins for your own use, stored in ~/.mmrelay/plugins/custom/
• Community Plugins: Share your creations with others or use plugins developed by the community

Check the Community Plugins Development Guide in our wiki to get started.

✨️ Visit the Community Plugins List!

Install a Community Plugin

Add the repository under the community-plugins section in config.yaml:

community-plugins:
  example-plugin:
    active: true
    repository: https://github.com/jeremiah-k/mmr-plugin-template.git
    tag: main

Plugin System

Plugins make it easy to extend functionality without modifying the core program. MMRelay features a powerful plugin system with standardized locations:

• Core Plugins: Pre-installed with the package
• Custom Plugins: Your own plugins in ~/.mmrelay/plugins/custom/
• Community Plugins: Third-party plugins in ~/.mmrelay/plugins/community/

---

Getting Started with Matrix

See our Wiki page Getting Started With Matrix & MM Relay.

---

Already on Matrix?

Join us!

• Our project's room: #mmrelay:meshnet.club
• Part of the Meshtastic Community Matrix space: #meshtastic-community:meshnet.club
• Public Relay Room: #relay-room:meshnet.club - Where we bridge multiple meshnets. Feel free to join us, with or without a relay!