<linkrel="index"title="Index"href="genindex.html"><linkrel="search"title="Search"href="search.html"><linkrel="next"title="Using Reticulum on Your System"href="using.html"><linkrel="prev"title="Zen of Reticulum"href="zen.html">
<p>This chapter provides a non-exhaustive list of notable programs, systems and application-layer protocols that have been built using Reticulum.</p>
<p>Many different applications using Reticulum already exist, serving a wide variety of purposes from day-to-day communication and information sharing to systems administration and tackling advanced networking and communications challenges.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>For ease of discovery while reading this manual over the web or as an e-book, links provided in this chapter primarily point to repositories and pages located on internet servers. In many cases, these are public web mirrors, with the upstream repositories residing on Reticulum nodes. For the latest source, updates and information regarding any project, be sure to check their Nomad Network or <codeclass="docutils literal notranslate"><spanclass="pre">rngit</span></code> nodes.</p>
</div>
<p>These programs will let you get a feel for how Reticulum works. Most of them have been designed to run well even over slow networks based on LoRa or packet radio, but all can also be used over fast links, such as local WiFi, wired Ethernet, the Internet, or any combination.</p>
<p>As such, it is easy to get started experimenting, without having to set up any radio transceivers or infrastructure just to try it out. Launching the programs on separate devices connected to the same WiFi network is enough to get started, and physical radio interfaces can then be added later.</p>
<p>Development of Reticulum-based applications and systems is ongoing, so consider this list a non-exhaustive starting point of <em>some</em> of the options available. With a bit of searching, primarily over Reticulum itself, you will find many more interesting things.</p>
<sectionid="browsing-publishing">
<h2>Browsing & Publishing<aclass="headerlink"href="#browsing-publishing"title="Link to this heading">¶</a></h2>
<p>In addition to the programs listed in this section, other Nomad Network clients include:</p>
<p>The terminal-based program <aclass="reference external"href="https://github.com/markqvist/nomadnet">Nomad Network</a> provides a complete encrypted communications suite built with Reticulum.</p>
<p>It features encrypted LXMF messaging (both direct and delayed-delivery for offline users), file sharing, and has a built-in text-browser and page server with support for dynamically rendered pages, user authentication and more. It also includes an RRC client and a suite of network utilities.</p>
</section>
<sectionid="ren-browser">
<h3>Ren Browser<aclass="headerlink"href="#ren-browser"title="Link to this heading">¶</a></h3>
<p><aclass="reference external"href="https://github.com/Quad4-Software/Ren-Browser">Ren Browser</a> is a modern, standalone browser for Nomad Network using the <aclass="reference external"href="https://github.com/Quad4-Software/Reticulum-Go">Reticulum-Go</a> implementation. The project is actively being developed, and should be considered alpha level software, but much of the functionality is already working. If you want to help expanding the ecosystem, this is an excellent project to take a look at.</p>
<p>Ren Browser is great example of an application aiming for true, seamless interoperability with the existing software ecosystem. It can operate fully standalone using it’s own embedded <aclass="reference external"href="https://github.com/Quad4-Software/Reticulum-Go">Go implementation</a> of Reticulum, or seamlessly utilise a shared RNS instance already running on the system.</p>
<p><aclass="reference external"href="https://github.com/Quad4-Software/rns-page-node">RNS Page Node</a> is a simple way to serve pages and files to any other Nomad Network compatible client. Drop-in replacement for NomadNet nodes that primarily serve pages and files.</p>
<p>You can host the entirity of Wikipedia, StackExchange or any other <codeclass="docutils literal notranslate"><spanclass="pre">.zim</span></code> file, to Nomad Network clients using <aclass="reference external"href="https://github.com/RFnexus/Retipedia">Retipedia</a>.</p>
<h3>Git Over Reticulum<aclass="headerlink"href="#git-over-reticulum"title="Link to this heading">¶</a></h3>
<p>The included <aclass="reference internal"href="git.html#git-main"><spanclass="std std-ref">rngit</span></a> system provides a fully distributed solution for managing, hosting, collaborating on and interacting with Git repositories over Reticulum.</p>
<p><aclass="reference external"href="https://github.com/markqvist/Sideband">Sideband</a> is a technical LXMF and LXST client, for Android, Linux, macOS and Windows. It also serves as a multi-purpose Reticulum utility, with features and functionality targeted at advanced users.</p>
<p>Sideband allows you to communicate with other people or LXMF-compatible systems over Reticulum networks using LoRa, Packet Radio, WiFi, I2P, Encrypted QR Paper Messages, or anything else Reticulum supports.</p>
<p>It interoperates with all other LXMF clients, and provides advanced features such as PTT and voice messaging, real-time voice calls, file attachments, private telemetry sharing, and a full plugin system for expandability.</p>
</section>
<sectionid="id6">
<h3>MeshChatX<aclass="headerlink"href="#id6"title="Link to this heading">¶</a></h3>
<p><aclass="reference external"href="https://meshchatx.com/">MeshChatX</a> is an all-in-one Reticulum client with messaging, calling, and a NomadNet browser, providing everything you need for Reticulum, LXMF, and LXST in one beautiful and feature-rich application.</p>
<h3>Columba<aclass="headerlink"href="#id8"title="Link to this heading">¶</a></h3>
<p><aclass="reference external"href="https://github.com/torlando-tech/columba/">Columba</a> is a simple and familiar LXMF messaging app Android, built with a native Android interface and Material Design 3. It also includes LXST voice call functionality, and a mobile Nomad Network page browser.</p>
<h3>Ren TUI<aclass="headerlink"href="#ren-tui"title="Link to this heading">¶</a></h3>
<p><aclass="reference external"href="https://github.com/Quad4-Software/Ren-TUI">Ren TUI</a> is an early prototype terminal LXMF client for Reticulum built with Odin on librns (Reticulum-Go). It aims for NomadNet-like messaging/browsing without urwid or ncurses.</p>
<h3>Reticulum Relay Chat<aclass="headerlink"href="#reticulum-relay-chat"title="Link to this heading">¶</a></h3>
<p><aclass="reference external"href="https://rrc.kc1awv.net/">Reticulum Relay Chat</a> is a live chat system built on top of the Reticulum Network Stack. It exists to let people talk to each other in real time over Reticulum without dragging in message databases, synchronization engines, or architectural commitments they did not ask for.</p>
<p>RRC is closer in spirit to IRC than to modern “everything platforms.” You connect, you join a room, you talk, and then you leave. If you were present, you saw the conversation. If you were not, the conversation did not wait for you. This is not an accident. This is the entire design.</p>
<p><aclass="reference external"href="https://github.com/kc1awv/RetiBBS">RetiBBS</a> is an old-school bulletin board system implementation for Reticulum networks.</p>
<h3>Reticulum Network Telephone<aclass="headerlink"href="#reticulum-network-telephone"title="Link to this heading">¶</a></h3>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">rnphone</span></code> program, included as part of the <aclass="reference external"href="https://github.com/markqvist/LXST">LXST</a> package is a command-line Reticulum telephone utility and daemon, that allows building physical, hardware telephones for LXST and Reticulum, as well as simply performing calls via the command line.</p>
<p>It supports interfacing directly with hardware peripherals such as GPIO keypads and LCD displays, providing a modular system for building secure hardware telephones.</p>
<h3>Partyline<aclass="headerlink"href="#partyline"title="Link to this heading">¶</a></h3>
<p><aclass="reference external"href="https://github.com/RFnexus/partyline">Partyline</a> is a group voice application for Reticulum, built on <aclass="reference external"href="https://github.com/markqvist/LXST">LXST</a>, inspired by <aclass="reference external"href="https://github.com/mumble-voip/mumble">Mumble</a>.</p>
<p>It provides both realtime group voice over any Reticulum transport capable of >6 kilobits per second, LXST dial-in support, listen-only music/broadcasting rooms, and many other useful functions.</p>
<p>The <aclass="reference external"href="https://github.com/kc1awv/lxst_phone">LXST Phone</a> program is a cross-platform desktop application for performing LXST voice calls over Reticulum. It supports various advanced features such as SAS verification, peer blocking, rate limiting, encrypted call history storage and contact management.</p>
<h2>System Administration<aclass="headerlink"href="#system-administration"title="Link to this heading">¶</a></h2>
<sectionid="remote-shell">
<h3>Remote Shell<aclass="headerlink"href="#remote-shell"title="Link to this heading">¶</a></h3>
<p>The included <aclass="reference internal"href="using.html#using-rnsh"><spanclass="std std-ref">rnsh</span></a> program lets you establish fully interactive
remote shell sessions over Reticulum. It also allows you to pipe any program to or from a
remote system, and is similar to how <codeclass="docutils literal notranslate"><spanclass="pre">ssh</span></code> works. The <codeclass="docutils literal notranslate"><spanclass="pre">rnsh</span></code> program is very efficient, and
can facilitate fully interactive shell sessions, even over extremely low-bandwidth links,
such as LoRa or packet radio.</p>
<p>In addition to the default, fully interactive terminal mode, for extremely limited links,
<codeclass="docutils literal notranslate"><spanclass="pre">rnsh</span></code> offers line-interactive mode, allowing you to interact with remote systems, even
when link throughput is counted in a few hundreds of bits per second.</p>
<p>The <aclass="reference external"href="https://github.com/Quad4-Software/RNS-Filesync">RNS FileSync</a> program enables automatic file synchronization between devices without requiring central servers, internet connectivity, or cloud services. It works over any network medium supported by Reticulum, including radio, LoRa, WiFi, or the internet, making it ideal for off-grid, privacy-focused, and resilient file sharing.</p>
</section>
</section>
<sectionid="utilities-components">
<h2>Utilities & Components<aclass="headerlink"href="#utilities-components"title="Link to this heading">¶</a></h2>
<sectionid="modem73">
<h3>Modem73<aclass="headerlink"href="#modem73"title="Link to this heading">¶</a></h3>
<p><aclass="reference external"href="https://github.com/RFnexus/modem73">MODEM73</a> and its companion <aclass="reference external"href="https://github.com/RFnexus/modem73interface">Modem73Interface</a> is an open source software modem that works with any HF, VHF, or UHF radio capable of 2400 Hz of bandwidth. All you need is a sound card and audio cable for your radio.</p>
<h3>LXMFy<aclass="headerlink"href="#lxmfy"title="Link to this heading">¶</a></h3>
<p><aclass="reference external"href="https://lxmfy.quad4.io/">LXMFy</a> is a comprehensive and advanced bot creation framework for LXMF, that allows building any kind of automation or bot system running over LXMF and Reticulum. <aclass="reference external"href="https://lxmfy.quad4.io/latest/creating-bots/">Bot implementations exist</a> for Home Assistant control, LLM integrations, and various other purposes.</p>
<h3>Micron Parser JS<aclass="headerlink"href="#micron-parser-js"title="Link to this heading">¶</a></h3>
<p><aclass="reference external"href="https://github.com/RFnexus/micron-parser-js">Micron Parser JS</a> is the JavaScript-based parser for the Micron markup language, that most web-based Nomad Network browsers use. If you want to make utilities or tools that display Micron pages, this library is essential.</p>
<h3>Reticulated<aclass="headerlink"href="#reticulated"title="Link to this heading">¶</a></h3>
<p><aclass="reference external"href="https://github.com/RFnexus/Reticulated">Reticulated</a> is a Reticulum Network simulator that spawns live, interactive Reticulum instances controllable from a node-based Web UI.</p>
<p>You can create networks of any topology and set bitrate, MTU, and configure path loss and propagation behavior. It provides a top-down view to a live network. You can connect any Reticulum application to the simulated network. It also has built in utilities like a basic LXMF chat function and Resource transfer included.</p>
<h3>RNMon<aclass="headerlink"href="#rnmon"title="Link to this heading">¶</a></h3>
<p><aclass="reference external"href="https://github.com/lbatalha/rnmon">RNMon</a> is a monitoring daemon designed to monitor the status of multiple RNS applications and push the metrics to an InfluxDB instance over the influx line protocol.</p>
<h2>Device Flashers<aclass="headerlink"href="#device-flashers"title="Link to this heading">¶</a></h2>
<p>In addition to the included command-line <codeclass="docutils literal notranslate"><spanclass="pre">rnodeconf</span></code> flasher, several community-provided RNode device flashers exist:</p>
<p>Several programs, such as <aclass="reference external"href="https://github.com/markqvist/Sideband">Sideband</a> and <aclass="reference external"href="https://meshchatx.com/">MeshChatX</a> also include built-in device flashers that can be used fully offline.</p>
<h2>Protocols<aclass="headerlink"href="#protocols"title="Link to this heading">¶</a></h2>
<p>A number of standard protocols have emerged through real-world usage and testing in the Reticulum community. While you may sometimes want to use completely custom protocols and implementations when writing Reticulum-based software, using these protocols provides application developers with an easy way to implement advanced functionality quickly and effortlessly. Using them also ensures compatibility and interoperability between many different client applications, creating an open communications ecosystem where users are free to choose the applications that suit their needs, while remaining connected to everyone else.</p>
<sectionid="lxmf">
<h3>LXMF<aclass="headerlink"href="#lxmf"title="Link to this heading">¶</a></h3>
<p><aclass="reference external"href="https://github.com/markqvist/lxmf">LXMF</a> is a simple and flexible messaging format and delivery protocol that allows a wide variety of applications, while using as little bandwidth as possible. It offers zero-conf message routing, end-to-end encryption and Forward Secrecy, and can be transported over any kind of medium that Reticulum supports.</p>
<p>LXMF is efficient enough that it can deliver messages over extremely low-bandwidth systems such as packet radio or LoRa. Encrypted LXMF messages can also be encoded as QR-codes or text-based URIs, allowing completely analog paper message transport.</p>
<p>Using Propagation Nodes, LXMF also offer a way to store and forward messages to users or endpoints that are not directly reachable at the time of message emission.</p>
<p><aclass="reference external"href="https://github.com/markqvist/lxst">LXST</a> is a simple and flexible real-time streaming format and delivery protocol that allows a wide variety of applications, while using as little bandwidth as possible. It is built on top of Reticulum and offers zero-conf stream routing, end-to-end encryption and Forward Secrecy, and can be transported over any kind of medium that Reticulum supports. It currently powers real-time voice and telephony applications over Reticulum.</p>
</section>
<sectionid="rrc">
<h3>RRC<aclass="headerlink"href="#rrc"title="Link to this heading">¶</a></h3>
<p>The <aclass="reference external"href="https://rrc.kc1awv.net/">Reticulum Relay Chat</a> protocol, is a live chat system built on top of the Reticulum Network Stack. It exists to provide near real-time group communication without dragging in message history databases, federation machinery, or architectural guilt.</p>
<p>RRC is intentionally simple. It does not pretend to be email, a mailbox, or a distributed archive. It behaves more like a conversation in a room. If you were there, you heard it. If you were not, you did not. That is not a bug, that is the point.</p>
<h2>Interface Modules & Connectivity Resources<aclass="headerlink"href="#interface-modules-connectivity-resources"title="Link to this heading">¶</a></h2>
<p>This section provides a list of various community-provided interface modules, guides and resources for creating Reticulum networks over special or challenging mediums.</p>
<li><p><aclass="reference external"href="https://github.com/RFnexus/modem73">Modem73</a> is an efficient software modem that can be used with Reticulum</p></li>
<li><p>Custom interface module for running <aclass="reference external"href="https://github.com/Quad4-Software/RNS-over-HTTP">RNS over HTTP</a></p></li>
<li><p>Guide for running <aclass="reference external"href="https://github.com/matvik22000/rns-over-icmp">Reticulum over ICMP</a> using <codeclass="docutils literal notranslate"><spanclass="pre">PipeInterface</span></code></p></li>
<li><p>Guide for running <aclass="reference external"href="https://github.com/markqvist/Reticulum/discussions/1002">Reticulum over DNS</a> with Iodine</p></li>
<li><p>Guide for running <aclass="reference external"href="https://github.com/RFnexus/reticulum-over-hf">Reticulum over HF radio</a></p></li>
</ul>
</section>
</section>
</article>
</div>
<footer>
<divclass="related-pages">
<aclass="next-page"href="using.html">
<divclass="page-info">
<divclass="context">
<span>Next</span>
</div>
<divclass="title">Using Reticulum on Your System</div>
