diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ac727ba..0e44e1b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# How to contribute to Meshcore Open +# How to contribute to Offband Meshcore Before submitting any pull requests (PR), please review the following information. @@ -11,9 +11,9 @@ may also be rejected. [See more](#ai-use) ### **Did you find a bug?** -* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/zjs81/meshcore-open/issues). +* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/Strycher/meshcore-open/issues). -* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/zjs81/meshcore-open/issues/new). +* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/Strycher/meshcore-open/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. You can also include diff --git a/README.md b/README.md index 041ea6e..20ace1e 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,12 @@ -# MeshCore Open +# Offband Meshcore Open-source Flutter client for MeshCore LoRa mesh networking devices. -## Overview - -MeshCore Open is a cross-platform mobile application for communicating with MeshCore LoRa mesh network devices via Bluetooth Low Energy (BLE). The app enables long-range, off-grid communication through peer-to-peer messaging, public channels, and mesh networking capabilities. +> **Offband Meshcore** is an independent fork of **[MeshCore Open](https://github.com/zjs81/meshcore-open)** by [zjs81](https://github.com/zjs81), used under the MIT License. Full credit to the original project — see [Credits](#credits). -**Website:** [meshcoreopen.org](https://meshcoreopen.org/) +## Overview - - Get it on Obtainium - +Offband Meshcore is a cross-platform mobile application for communicating with MeshCore LoRa mesh network devices via Bluetooth Low Energy (BLE). The app enables long-range, off-grid communication through peer-to-peer messaging, public channels, and mesh networking capabilities. ## Screenshots @@ -115,7 +111,7 @@ MeshCore Open is a cross-platform mobile application for communicating with Mesh 1. **Clone the repository** ```bash - git clone https://github.com/zjs81/meshcore-open.git + git clone https://github.com/Strycher/meshcore-open.git cd meshcore-open ``` @@ -242,22 +238,11 @@ This is an open-source project. Contributions are welcome! ## Support For issues, questions, or feature requests, please open an issue on GitHub: - - -## Donate - -If you find MeshCore Open useful and would like to support development, you can donate Solana or other Solana tokens: - -**Solana Address:** `F15YanjZj96YTBtKJYgNa8RLQLCZkx5CEwogPWkqXeoQ` - - -**Monero Address:** `453TxnpUqjkJtXxzdjMsrgERNkBRXEGamPbpC45ENrvKAk9tH7kZbxWF82Hz66etgDZyXFPEBU2JUEqhLeJyWt9kBvTVy5m` - -**Bitcoin Address:** `bc1qh45x28v8dslcg4v4upmqd9g0mvc3lnyffmyzr5` + -Your support helps maintain and improve this open-source project! +## Credits -## Acknowledgments +Offband Meshcore is an independent fork of **[MeshCore Open](https://github.com/zjs81/meshcore-open)** by **zjs81**, used under the MIT License. The original copyright and license are retained in [LICENSE](LICENSE). Deep thanks to zjs81 and the upstream contributors. - Built with [Flutter](https://flutter.dev/) - Map tiles from [OpenStreetMap](https://www.openstreetmap.org/) diff --git a/TESTFLIGHT_GUIDE.md b/TESTFLIGHT_GUIDE.md index b092678..8a603b6 100644 --- a/TESTFLIGHT_GUIDE.md +++ b/TESTFLIGHT_GUIDE.md @@ -6,7 +6,7 @@ - [x] Xcode installed - [x] Apple Transporter app installed - [x] App icons ready (1024x1024px) -- [x] Bundle ID configured: `com.monitormx.meshcoreopen` +- [x] Bundle ID configured: `app.offband.meshcore` ## Step 1: Register Bundle Identifier @@ -15,8 +15,8 @@ 3. Select **"App IDs"** → Continue 4. Select **"App"** → Continue 5. Fill in: - - **Description**: Meshcore Open - - **Bundle ID**: Explicit - `com.monitormx.meshcoreopen` + - **Description**: Offband Meshcore + - **Bundle ID**: Explicit - `app.offband.meshcore` - **Capabilities**: Leave defaults (or add as needed) 6. Click **Continue** → **Register** @@ -28,9 +28,9 @@ 4. Click the **"+"** button → **"New App"** 5. Fill in the form: - **Platforms**: iOS - - **Name**: Meshcore Open + - **Name**: Offband Meshcore - **Primary Language**: English (U.S.) - - **Bundle ID**: Select `com.monitormx.meshcoreopen` from dropdown + - **Bundle ID**: Select `app.offband.meshcore` from dropdown - **SKU**: `meshcore-open-001` (or any unique identifier) - **User Access**: Full Access 6. Click **"Create"** @@ -86,7 +86,7 @@ The IPA will be created at: `build/ios/ipa/meshcore_open.ipa` 3. Fill in **Description**: ``` - Meshcore Open is a Flutter client for MeshCore LoRa mesh networking devices. + Offband Meshcore is a Flutter client for MeshCore LoRa mesh networking devices. Features: - BLE connectivity to MeshCore devices @@ -105,7 +105,7 @@ The IPA will be created at: `build/ios/ipa/meshcore_open.ipa` ### Version Information 1. **What's New in This Version**: ``` - Initial release of Meshcore Open + Initial release of Offband Meshcore - BLE device connectivity - Mesh network messaging @@ -241,4 +241,4 @@ Distribution: For issues with: - **App Store Process**: [Apple Developer Support](https://developer.apple.com/contact/) - **Flutter Build Issues**: [Flutter GitHub](https://github.com/flutter/flutter/issues) -- **Meshcore Open App**: [GitHub Issues](https://github.com/wel97459/meshcore-open/issues) +- **Offband Meshcore App**: [GitHub Issues](https://github.com/Strycher/meshcore-open/issues) diff --git a/docs/PRIVACY_POLICY.md b/docs/PRIVACY_POLICY.md index bdbe89d..93714ed 100644 --- a/docs/PRIVACY_POLICY.md +++ b/docs/PRIVACY_POLICY.md @@ -1,16 +1,16 @@ -# Privacy Policy for MeshCore Open +# Privacy Policy for Offband Meshcore **Last Updated:** January 11, 2026 ## Introduction -MeshCore Open ("the App") is an open-source Flutter application for communicating with MeshCore LoRa mesh networking devices. This Privacy Policy explains how the App handles your information. +Offband Meshcore ("the App") is an open-source Flutter application for communicating with MeshCore LoRa mesh networking devices. This Privacy Policy explains how the App handles your information. ## Data Collection ### Data We Do NOT Collect -MeshCore Open does **not**: +Offband Meshcore does **not**: - Collect personal information - Send data to external servers (except map tile requests) - Track your usage or behavior @@ -89,7 +89,7 @@ The App does not knowingly collect any personal information from children under ## Open Source -MeshCore Open is open-source software. You can review the complete source code to verify these privacy practices at [the project repository]. +Offband Meshcore is open-source software. You can review the complete source code to verify these privacy practices at [the project repository]. ## Changes to This Policy @@ -101,4 +101,4 @@ If you have questions about this Privacy Policy or the App's privacy practices, --- -**Summary**: MeshCore Open is a privacy-respecting app that stores all data locally on your device. We do not collect, track, or share your personal information. +**Summary**: Offband Meshcore is a privacy-respecting app that stores all data locally on your device. We do not collect, track, or share your personal information. diff --git a/documentation/README.md b/documentation/README.md index 1367013..6e3d70a 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -1,6 +1,6 @@ -# MeshCore Open - Feature Documentation +# Offband Meshcore - Feature Documentation -MeshCore Open is an open-source Flutter client for MeshCore LoRa mesh networking devices. This documentation covers every user-facing feature, how to access it, and what it does. +Offband Meshcore is an open-source Flutter client for MeshCore LoRa mesh networking devices. This documentation covers every user-facing feature, how to access it, and what it does. ## Table of Contents @@ -18,7 +18,7 @@ MeshCore Open is an open-source Flutter client for MeshCore LoRa mesh networking ## App Overview -MeshCore Open connects to MeshCore LoRa mesh radios over BLE, USB, or TCP. Once connected, users can: +Offband Meshcore connects to MeshCore LoRa mesh radios over BLE, USB, or TCP. Once connected, users can: - **Chat** with other mesh nodes via encrypted direct messages - **Broadcast** on shared channels (public, hashtag, private, or community-scoped) diff --git a/documentation/additional-features.md b/documentation/additional-features.md index 5dfd268..1ec2733 100644 --- a/documentation/additional-features.md +++ b/documentation/additional-features.md @@ -69,7 +69,7 @@ An optional per-contact and per-channel text compression feature using the SMAZ ### How It Works - When enabled, compression is applied using a "compress only if smaller" strategy — the message is only transmitted compressed if the encoded result is actually shorter than the original. Otherwise, the original text is sent uncompressed - Compressed messages are transmitted with a `s:` prefix followed by base64-encoded data -- Recipients using MeshCore Open will decompress automatically. **Recipients using other software** that is not SMAZ-aware will see garbled `s:...` text +- Recipients using Offband Meshcore will decompress automatically. **Recipients using other software** that is not SMAZ-aware will see garbled `s:...` text - The codec operates on ASCII. Non-ASCII / non-English text generally does not benefit from compression and may even expand. Best suited for short English messages - Disabled by default @@ -214,7 +214,7 @@ An emoji picker inline with common reactions. Selected reactions appear below th ### How It Works - Implemented via `emoji_picker.dart` and `reaction_helper.dart` -- Reactions are transmitted as a special message type visible to all participants with MeshCore Open +- Reactions are transmitted as a special message type visible to all participants with Offband Meshcore --- diff --git a/documentation/notifications.md b/documentation/notifications.md index 7db9f0f..386bf7a 100644 --- a/documentation/notifications.md +++ b/documentation/notifications.md @@ -2,7 +2,7 @@ ## Overview -MeshCore Open provides both **system notifications** (push-style OS alerts) and **in-app unread badges** to inform users of new activity. +Offband Meshcore provides both **system notifications** (push-style OS alerts) and **in-app unread badges** to inform users of new activity. ## Notification Types