# 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 ` - 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: ![octoshrimpy/QUIK](.github/octoshrimpy_quik.jpg) # QUIK [![Manual Release](https://github.com/octoshrimpy/quik/actions/workflows/manual-release.yml/badge.svg)](https://github.com/octoshrimpy/quik/actions/workflows/manual-release.yml) Translation status [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/octoshrimpy/quik) QUIK is an open source replacement to the [stock messaging app](https://github.com/android/platform_packages_apps_mms) on Android. It is a continuation of [QKSMS](https://github.com/moezbhatti/qksms). ## Features - Scheduled messages - Message backup - Speech-to-text and text-to-speech integrated within the app - Message blocking and archiving - Voice messages - Attachments of any type of file - Message sorting - Message pinning - Delayed sending - Quick reply from notifications - Swipe actions - Emoji reaction handling - and much, much more ## Download Grab QUIK from the official [github releases page](https://github.com/octoshrimpy/quik/releases), or keep up with updates with the following: Get it on F-Droid Get it on Obtainium Download from GitHub releases ## Matrix Chat You can chat with the community over at [#quik-sms:matrix.org](https://matrix.to/#/#quik-sms:matrix.org) ## Reporting bugs A great bug report contains a description of the problem and steps to reproduce the problem. We need to know what we're looking for and where to look for it. When reporting a bug, please make sure to provide the following information: - Steps to reproduce the issue - QUIK version - Device / OS information ## Contributing Contributions are very welcome! Please see the [contributing guidelines](/CONTRIBUTING.md) for details. ## Translations If you'd like to add translations to QUIK, please join the project on [Weblate](https://hosted.weblate.org/engage/quik/)! Translations that are committed directly to source files will not be accepted. For more information see the [translation guidelines](/CONTRIBUTING.md#translate). Translation status ## Thank you A special thank you to Jake ([@klinker41](https://github.com/klinker41)) and Luke Klinker ([@klinker24](https://github.com/klinker24)) for their work on [android-smsmms](https://github.com/klinker41/android-smsmms), which has been an unspeakably large help in implementing MMS into QUIK. A giant thank you to Moez [moezbhatti](https://github.com/moezbhatti) for creating and maintaining QKSMS, of which QUIK would not exist without. ## Contact QUIK is developed and maintained by [Marcos Jones](https://github.com/octoshrimpy). --- ## Star History Star History Chart --- Donate using Ko-Fi Donate using Patreon ## License QUIK is released under the **The GNU General Public License v3.0 (GPLv3)**, which can be found in the [LICENSE](LICENSE) file in the root of this project.