forked from upstream-mirrors/quik
Automate CI/CD, document fork features, and format messages
This commit is contained in:
@@ -1,3 +1,46 @@
|
||||
# Quik Fork with Remotrix Matrix Bridge
|
||||
|
||||
> [!NOTE]
|
||||
> This project is a hard fork of the open-source **Quik** SMS messenger application. It has been modified to natively integrate **Remotrix**, a background service that bridges your SMS messages to a Matrix homeserver.
|
||||
|
||||
## Why this fork?
|
||||
|
||||
The original Remotrix project was a standalone background bridge that required a separate, default SMS handler application. By deeply integrating Remotrix directly into Quik, we created a single, unified SMS application that offers a beautiful Material Design UI on the phone, while silently syncing all messages to your Matrix account (via Trixnity) in the background.
|
||||
|
||||
**Key enhancements in this fork:**
|
||||
* **Native Matrix Background Sync**: SMS messages sent or received on the phone are instantly bridged to your Matrix account.
|
||||
* **Two-way Communication**: Messages sent from Matrix are instantly forwarded as standard SMS messages from the phone.
|
||||
* **Coroutines Deadlock Fix**: Upgraded Room database dependencies to resolve fatal `SQLiteConnectionPool` deadlocks during the cryptographic key generation phases.
|
||||
* **Enhanced Visual Formatting**: Matrix messages now use intuitive prefixes (🟢 for outgoing, 🔴 for incoming) to clearly distinguish participants without requiring AppService double puppeting.
|
||||
* **Gitea Actions CI/CD**: Includes automated builds and automatic upstream fetching from the original Quik repository.
|
||||
|
||||
## Management Room
|
||||
|
||||
When you log into the application with your Matrix bot account (`@remotrix:yourserver.com`) and specify a Manager ID (`@you:yourserver.com`), the bot creates a dedicated **Management Room** and invites you.
|
||||
From there, you can issue commands:
|
||||
- `!new <phone_number>` - Opens a new Matrix room dedicated to chatting with that phone number.
|
||||
- `!close` - Deletes a chat room.
|
||||
- `!ping` - Checks bot latency.
|
||||
- `!reload` - Restarts the background service.
|
||||
|
||||
Any non-command text sent in a dedicated phone number room will be sent as an SMS to that contact.
|
||||
|
||||
## Building and Releasing (Fork CI/CD)
|
||||
|
||||
The project uses Gitea Actions for CI/CD:
|
||||
- `build.yml`: Automatically builds the Debug and Release APKs (`assembleDebug`, `assembleRelease`) upon pushing to `main` or creating a tag. If a tag (e.g., `v1.0.0`) is pushed, a Gitea Release is created automatically.
|
||||
- `sync.yml`: Runs weekly to automatically fetch changes from the original `quik` upstream repository and merge them into our fork.
|
||||
|
||||
To build manually:
|
||||
```bash
|
||||
./gradlew assembleDebug
|
||||
```
|
||||
The APK will be available in `presentation/build/outputs/apk/debug/`.
|
||||
|
||||
---
|
||||
|
||||
# Original Quik Documentation Below:
|
||||
|
||||

|
||||
|
||||
# QUIK
|
||||
|
||||
Reference in New Issue
Block a user