Skip to content

LXMFy

Python framework for building LXMF bots on the Reticulum Network.

from lxmfy import LXMFBot

bot = LXMFBot(name="MyBot")

@bot.command(name="ping", description="Responds with pong")
def ping(ctx):
    ctx.reply("Pong!")

bot.run()

Guides

  • Quick Start - install LXMFy and get a bot on the network in minutes
  • Creating Bots - commands, cogs, storage, permissions, RRC, and delivery
  • API Reference - configuration options, methods, and module docs

Included

  • Command registry with type-hinted arguments, help generation, and admin gating
  • Cogs in Python or any executable language
  • LXMF field commands, reactions, attachments, and icon appearance
  • Propagation node delivery with retries and queue persistence
  • Optional NLP intents, permissions, signatures, Landlock sandboxing
  • RRC room client compatible with NomadNet and MeshChatX hubs

Download

PDF, EPUB, and text bundles are attached to GitHub releases.

Languages