lxmfy documentation

A framework for creating LXMF bots on the Reticulum Network.

Download

Get the latest version of LXMFy docs (PDF, EPUB, HTML and Text) from our Gitea repository.

Languages

This documentation is available in the following languages:

• English

• Русский

Contents:

• Quick Start
  • Prerequisites
  • Creating Your First Bot (Using the CLI)
  • Interacting With Your Bot
  • Advanced Features
  • Next Steps
• Creating Bots
  • Basic Structure
  • Using Templates
  • Bot Configuration
  • Structured Commands via LXMF Fields
  • Using Cogs (Extensions)
  • External Script Cogs (Multi-Language Support)
  • Sovereign NLP (Local Intent Classification)
  • RNS Link Support
  • Handling Messages
  • Handling Events
  • Storage
  • Permissions
  • Signature Verification
  • Advanced Message Delivery
• Core Components
  • LXMFBot
  • Structured Commands via LXMF Fields
  • Storage
  • Commands
  • Help System
  • Events
  • Testing
  • Permissions
  • Middleware
  • Attachments
  • Icon Appearance (LXMF Field)
  • Scheduler
  • Signatures
  • Message Delivery
  • Message Handlers
• Templates
  • EchoBot
  • NoteBot
  • ReminderBot
• CLI Tools
• Error Handling