mirror of
https://github.com/permissionlesstech/bitchat.git
synced 2026-07-24 23:25:19 +00:00
db3c3b77f5
- Remove completely unused message aggregation system (100% dead code) - Remove broken store-and-forward implementation that only worked for relayed messages to offline favorites - Update documentation to reflect actual functionality - Net reduction of 312 lines of unmaintained code Co-authored-by: jack <jackjackbits@users.noreply.github.com>
89 lines
2.9 KiB
Markdown
89 lines
2.9 KiB
Markdown
<img width="256" height="256" alt="icon_128x128@2x" src="https://github.com/user-attachments/assets/90133f83-b4f6-41c6-aab9-25d0859d2a47" />
|
|
|
|
## bitchat
|
|
|
|
A decentralized peer-to-peer messaging app that works over Bluetooth mesh networks. No internet required, no servers, no phone numbers. It's the side-groupchat.
|
|
|
|
[bitchat.free](http://bitchat.free)
|
|
|
|
📲 [App Store](https://apps.apple.com/us/app/bitchat-mesh/id6748219622)
|
|
|
|
> [!WARNING]
|
|
> Private messages have not received external security review and may contain vulnerabilities. Do not use for sensitive use cases, and do not rely on its security until it has been reviewed. Now uses the [Noise Protocol](http://www.noiseprotocol.org) for identity and encryption. Public local chat (the main feature) has no security concerns.
|
|
|
|
|
|
## License
|
|
|
|
This project is released into the public domain. See the [LICENSE](LICENSE) file for details.
|
|
|
|
|
|
## Features
|
|
|
|
- **Decentralized Mesh Network**: Automatic peer discovery and multi-hop message relay over Bluetooth LE
|
|
- **Privacy First**: No accounts, no phone numbers, no persistent identifiers
|
|
- **Private Message End-to-End Encryption**: [Noise Protocol](http://noiseprotocol.org)
|
|
- **IRC-Style Commands**: Familiar `/slap`, `/msg`, `/who` style interface
|
|
- **Universal App**: Native support for iOS and macOS
|
|
- **Emergency Wipe**: Triple-tap to instantly clear all data
|
|
- **Performance Optimizations**: LZ4 message compression, adaptive battery modes, and optimized networking
|
|
|
|
|
|
## [Technical Architecture](https://deepwiki.com/permissionlesstech/bitchat)
|
|
|
|
### Binary Protocol
|
|
bitchat uses an efficient binary protocol optimized for Bluetooth LE:
|
|
- Compact packet format with 1-byte type field
|
|
- TTL-based message routing (max 7 hops)
|
|
- Automatic fragmentation for large messages
|
|
- Message deduplication via unique IDs
|
|
|
|
### Mesh Networking
|
|
- Each device acts as both client and peripheral
|
|
- Automatic peer discovery and connection management
|
|
- Adaptive duty cycling for battery optimization
|
|
|
|
For detailed protocol documentation, see the [Technical Whitepaper](WHITEPAPER.md).
|
|
|
|
|
|
## Setup
|
|
|
|
### Option 1: Using XcodeGen (Recommended)
|
|
|
|
1. Install XcodeGen if you haven't already:
|
|
```bash
|
|
brew install xcodegen
|
|
```
|
|
|
|
2. Generate the Xcode project:
|
|
```bash
|
|
cd bitchat
|
|
xcodegen generate
|
|
```
|
|
|
|
3. Open the generated project:
|
|
```bash
|
|
open bitchat.xcodeproj
|
|
```
|
|
|
|
### Option 2: Using Swift Package Manager
|
|
|
|
1. Open the project in Xcode:
|
|
```bash
|
|
cd bitchat
|
|
open Package.swift
|
|
```
|
|
|
|
2. Select your target device and run
|
|
|
|
### Option 3: Manual Xcode Project
|
|
|
|
1. Open Xcode and create a new iOS/macOS App
|
|
2. Copy all Swift files from the `bitchat` directory into your project
|
|
3. Update Info.plist with Bluetooth permissions
|
|
4. Set deployment target to iOS 16.0 / macOS 13.0
|
|
|
|
### Option 4: just
|
|
|
|
Want to try this on macos: `just run` will set it up and run from source.
|
|
Run `just clean` afterwards to restore things to original state for mobile app building and development.
|