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 GitHub Releases.

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
  • Next Steps
• Creating Bots
  • Basic Structure
  • Using Templates
  • Bot Configuration
  • Using Cogs (Extensions)
  • Handling Events
  • Storage
  • Permissions
  • Signature Verification
• Core Components
  • LXMFBot
  • Storage
  • Commands
  • Events
  • Permissions
  • Middleware
  • Attachments
  • Icon Appearance (LXMF Field)
  • Scheduler
  • Signatures
• Templates
  • EchoBot
  • MemeBot
  • NoteBot
  • ReminderBot
• CLI Tools
• Error Handling