diff --git a/README.md b/README.md index 6b80e39..5f8f8fd 100755 --- a/README.md +++ b/README.md @@ -1,56 +1,96 @@ -# Multipurpose Radio Server (MRS) + +
+
+ + + Logo ---- + + ### Multipurpose Radio Server (MRS) + + + A comprehensive, offline-first communication and intelligence platform built for service-denied environments. -###### By: Zakary Timson -###### Date: September 2026 -###### Version: 1.0 + + [![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) ---- + + --- +
+ Documentation + • Release Notes + • Report a Bug + • Request a Feature +
-> Compact communication and information exchange server for service-denied areas. Ideal for disaster response, long-range tracking, and offline-first operations. + --- +
---- +## Table of Contents +- [About](#top) + - [Description](#description) + - [Inspiration](#inspiration) + - [Capabilities](#capabilities) +- [Manual](#manual) + - [Setup](#setup) + - [Production](#production) + - [Development](#development) + - [License](#license) -## 🗂️ Capabilities +## About -**Networking:** -* 900 MHz HaLow / 2.4/5 GHz Mesh WiFi (B.A.T.M.A.N.) -* LoRa radio communication (Meshtastic node) -* Captive portal & device home page setup +### 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. -**Communication:** -* Offline federated chat (Synapse/Element) -* GPS positioning & offline maps +### 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) -**Tools & Integration:** -* **AI Assistant**: Powered by the custom **AI-Harness** (Gemma4-e2b) -* **Knowledge Base**: Offline access via **Kiwix** (Harness provided) -* **Reconnaissance**: Bettercap, nmap, aircrack, Metasploit, and SDRAngel -* **Media/Control**: Control and casting interface provided by **OpenCast** -* **Remote Access**: VNC built into the **OpenCast** layer +### 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. -## 🛠️ Technical Focus +**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. -MRS acts as the hardware and recon core. All features are unified through the OpenCast control panel and the AI-Harness layer. +**Recon & Security** +* **Tools:** Bettercap, nmap, aircrack, Metasploit, and SDRAngel for hardware and RF recon. +* **Media:** Control and casting interface provided by OpenCast. -## 🚀 Quick Start +## Manual -```bash -# Clone and install -git clone https://git.zakscode.com/ztimson/mrs -cd mrs +### 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. -# Install base dependencies -npm ci +**Development** +1. Install dependencies: `npm install` +2. Start core services: `npm run dev` -# Start core services -``` +## Built With ---- +

+ +

+[![Electron](https://img.shields.io/badge/Electron-47848F?style=for-the-badge&logo=electron&logoColor=white)](https://www.electronjs.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 +## License +Copyright © 2023 Zakary Timson | All Rights Reserved | Available under MIT Licensing -This project is licensed under the MIT License. \ No newline at end of file +See the [license](./LICENSE) for more information. \ No newline at end of file