Skip to content

Repository files navigation

reticulum-go-protocols

Go implementations of application protocols that run on Reticulum-Go. All packages share one transport instance. This is a monorepo.

Package What it is Docs
pkg/mf Compact native format: 16-byte sender hash plus UTF-8 text docs/en/mf.md
pkg/lxmf LXMF 1.1.0 pack, stamp, paper URI, delivery docs/en/lxmf.md
pkg/rrc RRC protocol version 1 (spec 0.1.3) hub and client docs/en/rrc.md
pkg/lxst LXST 0.5.1 encrypted voice over Reticulum links docs/en/lxst.md
pkg/rnv Reticulum-Go Native Video (concept only): stills, clips, low-rate A/V streams docs/en/rnv.md
cmd/gorrcd Go RRC hub daemon docs/en/gorrcd.md

Full English index: docs/en.

Requirements

Optional, for Go/Python interop tests:

  • uv
  • LXMF-ref clone of upstream LXMF
  • RRC-ref clone of rrcd

Install

The module path is github.com/Quad4-Software/reticulum-go-protocols. It is not on the public Go module proxy.

require github.com/Quad4-Software/reticulum-go-protocols v0.0.0

replace github.com/Quad4-Software/reticulum-go-protocols => github.com/Quad4-Software/reticulum-go-protocols master
go mod tidy

Pin a commit or tag instead of master for a reproducible build. For a local checkout:

replace github.com/Quad4-Software/reticulum-go-protocols => ../reticulum-go-protocols

Copy the replace lines for github.com/Quad4-Software/Reticulum-Go and the other quad4/* modules from this repo's go.mod, or set:

export GOPRIVATE=quad4/*

Quick start

Make and Task wrap the same scripts. Plain go works if you keep vendor flags:

export GOFLAGS=-mod=vendor
export GOPROXY=off
export GOSUMDB=off
make help
make test-short
make gorrcd
./bin/gorrcd-$(go env GOOS)-$(go env GOARCH)
task --list
task test-short
task gorrcd
go test -short -count=1 ./...
sh scripts/ci/build-gorrcd.sh "$(go env GOOS)" "$(go env GOARCH)" bin
Action Make Task Plain
Short tests make test-short task test-short go test -short -count=1 ./...
All tests make test task test go test -count=1 ./...
Vet / fmt make vet / make fmt task vet / task fmt go vet ./... / go fmt ./...
Check make check task check vet + short tests
gorrcd make gorrcd task gorrcd sh scripts/ci/build-gorrcd.sh …
golxmd make golxmd task golxmd sh scripts/ci/build-golxmd.sh …
Shared libs make libs task build-lib* sh scripts/ci/build-lib*.sh …

Cross-compile and install:

make gorrcd GOOS=linux GOARCH=arm64
make install PREFIX=$HOME/.local

Package APIs, examples, interop notes, and the full command matrix: docs/en/building.md.

License

0BSD. Copyright 2026 Quad4.io.

About

Reticulum Message Formats and Protocols in Golang

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages