mrs/README.md

<!-- Header -->
<div id="top" align="center">
  <br />
  
  <!-- Logo -->
  <img src="https://meshtastic.org/assets/images/lora-topology-2-c80684f1eafdf2a71fbaf26e494fb26d.webp" alt="Logo" width="200" height="200">

  <!-- Title -->
  ### Multipurpose Radio Server (MRS)
  
  <!-- Description -->
  A comprehensive, offline-first communication and intelligence platform built for service-denied environments.

  <!-- Repo badges (Using generic placeholders as dynamic data is unavailable) -->
  [![Version](https://img.shields.io/badge/Version-1.0-success)](https://git.zakscode.com/ztimson/mrs/tags)
  [![Pull Requests](https://img.shields.io/badge/Pull%20Requests-0-blue)](https://git.zakscode.com/ztimson/mrs/pull)
  [![Issues](https://img.shields.io/badge/Issues-0-red)](https://git.zakscode.com/ztimson/mrs/issues)

  <!-- Links -->
  ---
  <div align="center">
    <a href="https://git.zakscode.com/ztimson/mrs/wiki" target="_blank">Documentation</a>
    • <a href="https://git.zakscode.com/ztimson/mrs/releases" target="_blank">Release Notes</a>
    • <a href="https://git.zakscode.com/ztimson/mrs/issues/new?template=.github/issue_template/bug.md" target="_blank">Report a Bug</a>
    • <a href="https://git.zakscode.com/ztimson/mrs/issues/new?template=.github/issue_template/enhancement.md" target="_blank">Request a Feature</a>
  </div >

  ---
</div >

## Table of Contents
- [About](#top)
  - [Description](#description)
    - [Inspiration](#inspiration)
    - [Capabilities](#capabilities)
- [Manual](#manual)
  - [Setup](#setup)
    - [Production](#production)
    - [Development](#development)
  - [License](#license)

## About

### Description
MRS is a hardware-focused radio server that acts as the core of the system, providing the physical connectivity and reconnaissance capabilities. It is unified by the OpenCast media/control layer and the AI-Harness intelligence layer.

### Inspiration
This project was built for resiliency and offline capability, drawing from:
- [A.C.I.D](https://www.youtube.com/watch?v=nSrYmkGq9TM)
- [Offline internet](https://www.youtube.com/watch?v=L5RJZmuRJKA)
- [Meshtastic radios](https://morosx.com/ols/products/xtak-lora-mesh)
- [HaLow mesh network](https://www.youtube.com/watch?v=ofR7GFNZzJY)
- [Signal Intelligence](https://www.youtube.com/watch?v=Nam87B2u6bo&t=1942s)

### Capabilities

**Networking**
*   **Mesh:** 900 MHz HaLow / 2.4/5 GHz Mesh WiFi (B.A.T.M.A.N.)
*   **Radio:** LoRa radio (Meshtastic node).
*   **Connectivity:** Captive portal & device home page setup via OpenCast.

**Communication & Data**
*   **Chat:** Offline federated chat (Synapse/Element)
*   **Archive:** Offline knowledge base (Kiwix) and file hosting (AI-Harness).
*   **Tracking:** GPS positioning & offline maps using gpsd, chrony.

**Recon & Security**
*   **Tools:** Bettercap, nmap, aircrack, Metasploit, and SDRAngel for hardware and RF recon.
*   **Media:** Control and casting interface provided by OpenCast.

## Manual

### Setup
**Production**
1. Run the core MRS services to establish the hardware/radio backbone.
2. OpenCast (port 3000) and AI-Harness (port 3001) are required to provide the media control and intelligence interface.

**Development**
1. Install dependencies: `npm install`
2. Start core services: `npm run dev`

## Built With

[![Electron](https://img.shields.io/badge/Electron-47848F?style=for-the-badge&logo=electron&logoColor=white)](https://www.electronjs.org/)
[![Kiwix](https://img.shields.io/badge/Kiwix-000000?style=for-the-badge&logo=kiwix&logoColor=white)](https://kiwix.org/)
[![Node](https://img.shields.io/badge/Node.js-000000?style=for-the-badge&logo=nodedotjs)](https://nodejs.org/)
[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/)
[![OpenCast](https://img.shields.io/badge/OpenCast-009639?style=for-the-badge&logo=nginx&logoColor=white)](https://www.nginx.com/)
[![AI-Harness](https://img.shields.io/badge/AI-Harness-121212?style=for-the-badge&logo=brain&logoColor=white)](https://github.com/ztimson/ai-harness)

## License
Copyright © 2023 Zakary Timson | All Rights Reserved | Available under MIT Licensing

See the [license](./LICENSE) for more information.