LXMFy

Easily create LXMF bots for the Reticulum Network with this extensible framework.

Roadmap

Features

• Hot reloading (Cog system similar to discord.py)
• Moderation commands (unban, stats, etc.)
• Spam protection (rate limiting, command cooldown, warnings, banning)
• Command prefix (set to None to process all messages as commands)
• Announcements (announce in seconds, set to 0 to disable)
• Extensible Storage Backend
• Permission System
• Middleware System
• Task Scheduler
• Event System
• Help on first message

Installation

pip install lxmfy

or pipx:

pipx install lxmfy

Usage

lxmfy create

Python

from lxmfy import LXMFBot, load_cogs_from_directory

bot = LXMFBot(
    name="LXMFy Test Bot", # Name of the bot that appears on the network.
    announce=600, # Announce every 600 seconds, set to 0 to disable.
    announce_enabled=True, # Set to False to disable all announces (both initial and periodic)
    announce_immediately=True, # Set to False to disable initial announce
    admins=["your_lxmf_hash_here"], # List of admin hashes.
    hot_reloading=True, # Enable hot reloading.
    command_prefix="/", # Set to None to process all messages as commands.
    cogs_dir="cogs", # Specify cogs directory name.
    rate_limit=5, # 5 messages per minute
    cooldown=5, # 5 seconds cooldown
    max_warnings=3, # 3 warnings before ban
    warning_timeout=300, # Warnings reset after 5 minutes
)

# Dynamically load all cogs
load_cogs_from_directory(bot)

@bot.command(name="ping", description="Test if bot is responsive")
def ping(ctx):
    ctx.reply("Pong!")

# Admin Only Command
@bot.command(name="echo", description="Echo a message", admin_only=True)
def echo(ctx, message: str):
    ctx.reply(message)

bot.run()

Framework Development

git clone https://github.com/lxmfy/lxmfy.git
cd lxmfy
poetry install

Development

poetry run ruff check .
poetry run bandit -c pyproject.toml -r .

Docker

docker run -d \
    --name lxmfy-test-bot \
    -v $(pwd)/config:/bot/config \
    -v $(pwd)/.reticulum:/root/.reticulum \
    --restart unless-stopped \
    lxmfy-test

Auto-Interface support:

docker run -d \
    --name lxmfy-test-bot \
    --network host \
    -v $(pwd)/config:/bot/config \
    -v $(pwd)/.reticulum:/root/.reticulum \
    --restart unless-stopped \
    lxmfy-test

Credit to https://github.com/randogoth/lxmf-bot, helped me learning to create LXMF bots.