Your Android phone and your Windows PC, working as one. Local-first, end-to-end encrypted, no account.
Initial commit: project plan, licenses and community files
Bee6f7c8276cbbc
diff --git a/.editorconfig b/.editorconfignew file mode 100644index 0000000..27e955d--- /dev/null+++ b/.editorconfig@@ -0,0 +1,22 @@+root = true++[*]+charset = utf-8+end_of_line = lf+insert_final_newline = true+trim_trailing_whitespace = true+indent_style = space+indent_size = 4++[*.{md,yml,yaml,json,toml,qml}]+indent_size = 2++[*.md]+trim_trailing_whitespace = false++[*.{bat,cmd,ps1}]+end_of_line = crlf++[LICENSES/*.txt]+trim_trailing_whitespace = false+insert_final_newline = unsetdiff --git a/.gitattributes b/.gitattributesnew file mode 100644index 0000000..cc45131--- /dev/null+++ b/.gitattributes@@ -0,0 +1,30 @@+# Normalize line endings: LF in the repo, native checkout where it matters.+* text=auto eol=lf++# Windows scripts need CRLF+*.bat text eol=crlf+*.cmd text eol=crlf+*.ps1 text eol=crlf++# Binary files+*.png binary+*.jpg binary+*.jpeg binary+*.gif binary+*.webp binary+*.ico binary+*.icns binary+*.ttf binary+*.otf binary+*.woff binary+*.woff2 binary+*.mp3 binary+*.mp4 binary+*.ogg binary+*.opus binary+*.zip binary+*.7z binary+*.jar binary+*.so binary+*.dll binary+*.exe binarydiff --git a/.gitignore b/.gitignorenew file mode 100644index 0000000..f09fc21--- /dev/null+++ b/.gitignore@@ -0,0 +1,58 @@+# ---- Secrets: never commit these ----+*.jks+*.keystore+*.p12+*.pfx+*.pem+*.key+keystore.properties+signing.properties+.env+.env.*+!.env.example++# ---- Rust ----+/target/+**/target/+**/*.rs.bk++# ---- Qt / C++ build output ----+build/+build-*/+*.qmlc+*.jsc+.qmlls.ini+CMakeLists.txt.user*+*.pro.user*+compile_commands.json++# ---- Android / Gradle ----+.gradle/+**/build/+local.properties+captures/+.externalNativeBuild/+.cxx/+*.apk+*.aab+*.ap_+*.dex+android/**/jniLibs/++# ---- IDEs and editors ----+.idea/+*.iml+.vscode/*+!.vscode/extensions.json+!.vscode/settings.json+*.swp+*.swo++# ---- OS clutter ----+.DS_Store+Thumbs.db+desktop.ini++# ---- Logs and tool output ----+*.log+aqtinstall.logdiff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.mdnew file mode 100644index 0000000..513fc5d--- /dev/null+++ b/CODE_OF_CONDUCT.md@@ -0,0 +1,83 @@+# Contributor Covenant Code of Conduct++## Our Pledge++We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.++We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.++## Our Standards++Examples of behavior that contributes to a positive environment for our community include:++* Demonstrating empathy and kindness toward other people+* Being respectful of differing opinions, viewpoints, and experiences+* Giving and gracefully accepting constructive feedback+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience+* Focusing on what is best not just for us as individuals, but for the overall community++Examples of unacceptable behavior include:++* The use of sexualized language or imagery, and sexual attention or advances of any kind+* Trolling, insulting or derogatory comments, and personal or political attacks+* Public or private harassment+* Publishing others' private information, such as a physical or email address, without their explicit permission+* Other conduct which could reasonably be considered inappropriate in a professional setting++## Enforcement Responsibilities++Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.++Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.++## Scope++This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.++## Enforcement++Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at the project maintainers via a private report (see SECURITY.md for how to reach them privately on GitHub). All complaints will be reviewed and investigated promptly and fairly.++All community leaders are obligated to respect the privacy and security of the reporter of any incident.++## Enforcement Guidelines++Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:++### 1. Correction++**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.++**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.++### 2. Warning++**Community Impact**: A violation through a single incident or series of actions.++**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.++### 3. Temporary Ban++**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.++**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.++### 4. Permanent Ban++**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.++**Consequence**: A permanent ban from any sort of public interaction within the community.++## Attribution++This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].++Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].++For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].++[homepage]: https://www.contributor-covenant.org+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html+[Mozilla CoC]: https://github.com/mozilla/diversity+[FAQ]: https://www.contributor-covenant.org/faq+[translations]: https://www.contributor-covenant.org/translationsdiff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdnew file mode 100644index 0000000..a110524--- /dev/null+++ b/CONTRIBUTING.md@@ -0,0 +1,60 @@+# Contributing to Nectarlink++Thanks for your interest! Nectarlink is in early development, so the codebase+and these guidelines will change quickly.++## Before you start++- Read [docs/PLAN.md](docs/PLAN.md) to understand the goals, the architecture+ and the roadmap.+- For anything bigger than a small fix, open an issue first so we can agree on+ the approach.+- Be kind. Everyone is expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md).++## Sign your commits (DCO)++Nectarlink uses the [Developer Certificate of Origin](DCO.txt) instead of a+CLA. By signing off, you certify that you wrote the change or otherwise have+the right to submit it under the project's licenses.++Add a sign-off line to every commit:++```+git commit -s -m "Your message"+```++This appends a line like:++```+Signed-off-by: Your Name <[email protected]>+```++Commits without a sign-off can't be merged.++## Licensing of contributions++Your contribution is licensed under the license that covers the files you+change, as described in the top-level [LICENSE](LICENSE) file. For GPL-licensed+parts, this includes the [app-store exception](LICENSES/APP-STORE-EXCEPTION.md).++## Ground rules for code++These come from the plan and will grow into a full style guide:++- **Rust is the source of truth.** Business logic lives in Rust. QML only+ describes screens, layout and animation.+- **One bridge.** Only the `nectarlink-qt` crate talks to Qt.+- **Privacy first.** Never log notification text, message content, file names+ or keys. No telemetry.+- **All user-facing strings are translatable** (`qsTr` in QML, string+ resources on Android).+- **Accessibility is not optional.** Labels for screen readers and full+ keyboard navigation from day one.+- Format with `cargo fmt` and keep `cargo clippy` clean. Android code follows+ the official Kotlin style.++## Reporting bugs++Open an issue with your Windows build, phone model, Android version, and the+Nectarlink versions on both sides. Security problems go through+[SECURITY.md](SECURITY.md) instead, never a public issue.diff --git a/DCO.txt b/DCO.txtnew file mode 100644index 0000000..49b8cb0--- /dev/null+++ b/DCO.txt@@ -0,0 +1,34 @@+Developer Certificate of Origin+Version 1.1++Copyright (C) 2004, 2006 The Linux Foundation and its contributors.++Everyone is permitted to copy and distribute verbatim copies of this+license document, but changing it is not allowed.+++Developer's Certificate of Origin 1.1++By making a contribution to this project, I certify that:++(a) The contribution was created in whole or in part by me and I+ have the right to submit it under the open source license+ indicated in the file; or++(b) The contribution is based upon previous work that, to the best+ of my knowledge, is covered under an appropriate open source+ license and I have the right under that license to submit that+ work with modifications, whether created in whole or in part+ by me, under the same open source license (unless I am+ permitted to submit under a different license), as indicated+ in the file; or++(c) The contribution was provided directly to me by some other+ person who certified (a), (b) or (c) and I have not modified+ it.++(d) I understand and agree that this project and the contribution+ are public and that a record of the contribution (including all+ personal information I submit with it, including my sign-off) is+ maintained indefinitely and may be redistributed consistent with+ this project or the open source license(s) involved.diff --git a/LICENSE b/LICENSEnew file mode 100644index 0000000..57fc310--- /dev/null+++ b/LICENSE@@ -0,0 +1,32 @@+Nectarlink is distributed under several licenses, depending on the part of the+project. The full license texts are in the LICENSES/ directory.++ Part of the project License+ ------------------------------------------- ----------------------------------+ Desktop app (desktop/) GPL-3.0-or-later, with the+ Android app (android/) additional permission in+ CLI (core/nectarlink-cli/) LICENSES/APP-STORE-EXCEPTION.md++ Core libraries (core/, except the CLI): MPL-2.0+ nectarlink-core, nectarlink-protocol,+ nectarlink-adb, nectarlink-localsend,+ nectarlink-ffi++ Protocol specification and documentation CC-BY-4.0+ (docs/)++ Anything not listed above GPL-3.0-or-later, with the+ additional permission in+ LICENSES/APP-STORE-EXCEPTION.md++Individual source files may state their license with an SPDX header, for+example:++ // SPDX-License-Identifier: MPL-2.0++When a file's header and this table disagree, the file's header applies.++The Nectarlink name and logo are not licensed under any of the licenses above.+See TRADEMARKS.md.++Copyright (C) 2026 The Nectarlink contributors.diff --git a/LICENSES/APP-STORE-EXCEPTION.md b/LICENSES/APP-STORE-EXCEPTION.mdnew file mode 100644index 0000000..4950734--- /dev/null+++ b/LICENSES/APP-STORE-EXCEPTION.md@@ -0,0 +1,40 @@+# Additional permission under GNU GPL version 3, section 7++This additional permission applies to every part of Nectarlink that is licensed+under the GNU General Public License version 3 or later ("the GPL"), as listed+in the top-level `LICENSE` file.++## Permission++As an additional permission under section 7 of the GPL, the copyright holders+of Nectarlink give you permission to convey a covered work, or a work based on+it, through an application store or similar distribution platform (for example+the Apple App Store, the Mac App Store, the Microsoft Store or Google Play),+even if that platform's terms of service or technical measures add+restrictions that would otherwise conflict with the GPL, such as limits on the+number of devices, usage rules, or digital rights management applied by the+platform.++## Conditions++This permission applies only if all of the following are true:++1. The Corresponding Source of the exact version conveyed through the platform+ is made available, free of charge, under the terms of the GPL (with this+ additional permission), through a means other than the platform, such as a+ public source code repository.+2. Recipients are informed, for example in the app's description or its+ "About" screen, where that Corresponding Source can be obtained.+3. The platform's restrictions are imposed by the platform itself and not+ added by you.++## Scope++This permission only relaxes the restrictions described above. It does not+remove or reduce any right that the GPL grants to recipients. You may remove+this additional permission from your own copies or modified versions, as+allowed by section 7 of the GPL. Contributions to Nectarlink are accepted under+the GPL together with this additional permission.++_Note: this text was drafted for the project and has not yet been reviewed by a+lawyer. A legal review is planned before the first public release._diff --git a/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txtnew file mode 100644index 0000000..da6ab6c--- /dev/null+++ b/LICENSES/CC-BY-4.0.txt@@ -0,0 +1,396 @@+Attribution 4.0 International++=======================================================================++Creative Commons Corporation ("Creative Commons") is not a law firm and+does not provide legal services or legal advice. Distribution of+Creative Commons public licenses does not create a lawyer-client or+other relationship. Creative Commons makes its licenses and related+information available on an "as-is" basis. Creative Commons gives no+warranties regarding its licenses, any material licensed under their+terms and conditions, or any related information. Creative Commons+disclaims all liability for damages resulting from their use to the+fullest extent possible.++Using Creative Commons Public Licenses++Creative Commons public licenses provide a standard set of terms and+conditions that creators and other rights holders may use to share+original works of authorship and other material subject to copyright+and certain other rights specified in the public license below. The+following considerations are for informational purposes only, are not+exhaustive, and do not form part of our licenses.++ Considerations for licensors: Our public licenses are+ intended for use by those authorized to give the public+ permission to use material in ways otherwise restricted by+ copyright and certain other rights. Our licenses are+ irrevocable. Licensors should read and understand the terms+ and conditions of the license they choose before applying it.+ Licensors should also secure all rights necessary before+ applying our licenses so that the public can reuse the+ material as expected. Licensors should clearly mark any+ material not subject to the license. This includes other CC-+ licensed material, or material used under an exception or+ limitation to copyright. More considerations for licensors:+ wiki.creativecommons.org/Considerations_for_licensors++ Considerations for the public: By using one of our public+ licenses, a licensor grants the public permission to use the+ licensed material under specified terms and conditions. If+ the licensor's permission is not necessary for any reason--for+ example, because of any applicable exception or limitation to+ copyright--then that use is not regulated by the license. Our+ licenses grant only permissions under copyright and certain+ other rights that a licensor has authority to grant. Use of+ the licensed material may still be restricted for other+ reasons, including because others have copyright or other+ rights in the material. A licensor may make special requests,+ such as asking that all changes be marked or described.+ Although not required by our licenses, you are encouraged to+ respect those requests where reasonable. More considerations+ for the public:+ wiki.creativecommons.org/Considerations_for_licensees++=======================================================================++Creative Commons Attribution 4.0 International Public License++By exercising the Licensed Rights (defined below), You accept and agree+to be bound by the terms and conditions of this Creative Commons+Attribution 4.0 International Public License ("Public License"). To the+extent this Public License may be interpreted as a contract, You are+granted the Licensed Rights in consideration of Your acceptance of+these terms and conditions, and the Licensor grants You such rights in+consideration of benefits the Licensor receives from making the+Licensed Material available under these terms and conditions.+++Section 1 -- Definitions.++ a. Adapted Material means material subject to Copyright and Similar+ Rights that is derived from or based upon the Licensed Material+ and in which the Licensed Material is translated, altered,+ arranged, transformed, or otherwise modified in a manner requiring+ permission under the Copyright and Similar Rights held by the+ Licensor. For purposes of this Public License, where the Licensed+ Material is a musical work, performance, or sound recording,+ Adapted Material is always produced where the Licensed Material is+ synched in timed relation with a moving image.++ b. Adapter's License means the license You apply to Your Copyright+ and Similar Rights in Your contributions to Adapted Material in+ accordance with the terms and conditions of this Public License.++ c. Copyright and Similar Rights means copyright and/or similar rights+ closely related to copyright including, without limitation,+ performance, broadcast, sound recording, and Sui Generis Database+ Rights, without regard to how the rights are labeled or+ categorized. For purposes of this Public License, the rights+ specified in Section 2(b)(1)-(2) are not Copyright and Similar+ Rights.++ d. Effective Technological Measures means those measures that, in the+ absence of proper authority, may not be circumvented under laws+ fulfilling obligations under Article 11 of the WIPO Copyright+ Treaty adopted on December 20, 1996, and/or similar international+ agreements.++ e. Exceptions and Limitations means fair use, fair dealing, and/or+ any other exception or limitation to Copyright and Similar Rights+ that applies to Your use of the Licensed Material.++ f. Licensed Material means the artistic or literary work, database,+ or other material to which the Licensor applied this Public+ License.++ g. Licensed Rights means the rights granted to You subject to the+ terms and conditions of this Public License, which are limited to+ all Copyright and Similar Rights that apply to Your use of the+ Licensed Material and that the Licensor has authority to license.++ h. Licensor means the individual(s) or entity(ies) granting rights+ under this Public License.++ i. Share means to provide material to the public by any means or+ process that requires permission under the Licensed Rights, such+ as reproduction, public display, public performance, distribution,+ dissemination, communication, or importation, and to make material+ available to the public including in ways that members of the+ public may access the material from a place and at a time+ individually chosen by them.++ j. Sui Generis Database Rights means rights other than copyright+ resulting from Directive 96/9/EC of the European Parliament and of+ the Council of 11 March 1996 on the legal protection of databases,+ as amended and/or succeeded, as well as other essentially+ equivalent rights anywhere in the world.++ k. You means the individual or entity exercising the Licensed Rights+ under this Public License. Your has a corresponding meaning.+++Section 2 -- Scope.++ a. License grant.++ 1. Subject to the terms and conditions of this Public License,+ the Licensor hereby grants You a worldwide, royalty-free,+ non-sublicensable, non-exclusive, irrevocable license to+ exercise the Licensed Rights in the Licensed Material to:++ a. reproduce and Share the Licensed Material, in whole or+ in part; and++ b. produce, reproduce, and Share Adapted Material.++ 2. Exceptions and Limitations. For the avoidance of doubt, where+ Exceptions and Limitations apply to Your use, this Public+ License does not apply, and You do not need to comply with+ its terms and conditions.++ 3. Term. The term of this Public License is specified in Section+ 6(a).++ 4. Media and formats; technical modifications allowed. The+ Licensor authorizes You to exercise the Licensed Rights in+ all media and formats whether now known or hereafter created,+ and to make technical modifications necessary to do so. The+ Licensor waives and/or agrees not to assert any right or+ authority to forbid You from making technical modifications+ necessary to exercise the Licensed Rights, including+ technical modifications necessary to circumvent Effective+ Technological Measures. For purposes of this Public License,+ simply making modifications authorized by this Section 2(a)+ (4) never produces Adapted Material.++ 5. Downstream recipients.++ a. Offer from the Licensor -- Licensed Material. Every+ recipient of the Licensed Material automatically+ receives an offer from the Licensor to exercise the+ Licensed Rights under the terms and conditions of this+ Public License.++ b. No downstream restrictions. You may not offer or impose+ any additional or different terms or conditions on, or+ apply any Effective Technological Measures to, the+ Licensed Material if doing so restricts exercise of the+ Licensed Rights by any recipient of the Licensed+ Material.++ 6. No endorsement. Nothing in this Public License constitutes or+ may be construed as permission to assert or imply that You+ are, or that Your use of the Licensed Material is, connected+ with, or sponsored, endorsed, or granted official status by,+ the Licensor or others designated to receive attribution as+ provided in Section 3(a)(1)(A)(i).++ b. Other rights.++ 1. Moral rights, such as the right of integrity, are not+ licensed under this Public License, nor are publicity,+ privacy, and/or other similar personality rights; however, to+ the extent possible, the Licensor waives and/or agrees not to+ assert any such rights held by the Licensor to the limited+ extent necessary to allow You to exercise the Licensed+ Rights, but not otherwise.++ 2. Patent and trademark rights are not licensed under this+ Public License.++ 3. To the extent possible, the Licensor waives any right to+ collect royalties from You for the exercise of the Licensed+ Rights, whether directly or through a collecting society+ under any voluntary or waivable statutory or compulsory+ licensing scheme. In all other cases the Licensor expressly+ reserves any right to collect such royalties.+++Section 3 -- License Conditions.++Your exercise of the Licensed Rights is expressly made subject to the+following conditions.++ a. Attribution.++ 1. If You Share the Licensed Material (including in modified+ form), You must:++ a. retain the following if it is supplied by the Licensor+ with the Licensed Material:++ i. identification of the creator(s) of the Licensed+ Material and any others designated to receive+ attribution, in any reasonable manner requested by+ the Licensor (including by pseudonym if+ designated);++ ii. a copyright notice;++ iii. a notice that refers to this Public License;++ iv. a notice that refers to the disclaimer of+ warranties;++ v. a URI or hyperlink to the Licensed Material to the+ extent reasonably practicable;++ b. indicate if You modified the Licensed Material and+ retain an indication of any previous modifications; and++ c. indicate the Licensed Material is licensed under this+ Public License, and include the text of, or the URI or+ hyperlink to, this Public License.++ 2. You may satisfy the conditions in Section 3(a)(1) in any+ reasonable manner based on the medium, means, and context in+ which You Share the Licensed Material. For example, it may be+ reasonable to satisfy the conditions by providing a URI or+ hyperlink to a resource that includes the required+ information.++ 3. If requested by the Licensor, You must remove any of the+ information required by Section 3(a)(1)(A) to the extent+ reasonably practicable.++ 4. If You Share Adapted Material You produce, the Adapter's+ License You apply must not prevent recipients of the Adapted+ Material from complying with this Public License.+++Section 4 -- Sui Generis Database Rights.++Where the Licensed Rights include Sui Generis Database Rights that+apply to Your use of the Licensed Material:++ a. for the avoidance of doubt, Section 2(a)(1) grants You the right+ to extract, reuse, reproduce, and Share all or a substantial+ portion of the contents of the database;++ b. if You include all or a substantial portion of the database+ contents in a database in which You have Sui Generis Database+ Rights, then the database in which You have Sui Generis Database+ Rights (but not its individual contents) is Adapted Material; and++ c. You must comply with the conditions in Section 3(a) if You Share+ all or a substantial portion of the contents of the database.++For the avoidance of doubt, this Section 4 supplements and does not+replace Your obligations under this Public License where the Licensed+Rights include other Copyright and Similar Rights.+++Section 5 -- Disclaimer of Warranties and Limitation of Liability.++ a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE+ EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS+ AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF+ ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,+ IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,+ WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR+ PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,+ ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT+ KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT+ ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.++ b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE+ TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,+ NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,+ INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,+ COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR+ USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN+ ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR+ DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR+ IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.++ c. The disclaimer of warranties and limitation of liability provided+ above shall be interpreted in a manner that, to the extent+ possible, most closely approximates an absolute disclaimer and+ waiver of all liability.+++Section 6 -- Term and Termination.++ a. This Public License applies for the term of the Copyright and+ Similar Rights licensed here. However, if You fail to comply with+ this Public License, then Your rights under this Public License+ terminate automatically.++ b. Where Your right to use the Licensed Material has terminated under+ Section 6(a), it reinstates:++ 1. automatically as of the date the violation is cured, provided+ it is cured within 30 days of Your discovery of the+ violation; or++ 2. upon express reinstatement by the Licensor.++ For the avoidance of doubt, this Section 6(b) does not affect any+ right the Licensor may have to seek remedies for Your violations+ of this Public License.++ c. For the avoidance of doubt, the Licensor may also offer the+ Licensed Material under separate terms or conditions or stop+ distributing the Licensed Material at any time; however, doing so+ will not terminate this Public License.++ d. Sections 1, 5, 6, 7, and 8 survive termination of this Public+ License.+++Section 7 -- Other Terms and Conditions.++ a. The Licensor shall not be bound by any additional or different+ terms or conditions communicated by You unless expressly agreed.++ b. Any arrangements, understandings, or agreements regarding the+ Licensed Material not stated herein are separate from and+ independent of the terms and conditions of this Public License.+++Section 8 -- Interpretation.++ a. For the avoidance of doubt, this Public License does not, and+ shall not be interpreted to, reduce, limit, restrict, or impose+ conditions on any use of the Licensed Material that could lawfully+ be made without permission under this Public License.++ b. To the extent possible, if any provision of this Public License is+ deemed unenforceable, it shall be automatically reformed to the+ minimum extent necessary to make it enforceable. If the provision+ cannot be reformed, it shall be severed from this Public License+ without affecting the enforceability of the remaining terms and+ conditions.++ c. No term or condition of this Public License will be waived and no+ failure to comply consented to unless expressly agreed to by the+ Licensor.++ d. Nothing in this Public License constitutes or may be interpreted+ as a limitation upon, or waiver of, any privileges and immunities+ that apply to the Licensor or You, including from the legal+ processes of any jurisdiction or authority.+++=======================================================================++Creative Commons is not a party to its public+licenses. Notwithstanding, Creative Commons may elect to apply one of+its public licenses to material it publishes and in those instances+will be considered the “Licensor.” The text of the Creative Commons+public licenses is dedicated to the public domain under the CC0 Public+Domain Dedication. Except for the limited purpose of indicating that+material is shared under a Creative Commons public license or as+otherwise permitted by the Creative Commons policies published at+creativecommons.org/policies, Creative Commons does not authorize the+use of the trademark "Creative Commons" or any other trademark or logo+of Creative Commons without its prior written consent including,+without limitation, in connection with any unauthorized modifications+to any of its public licenses or any other arrangements,+understandings, or agreements concerning use of licensed material. For+the avoidance of doubt, this paragraph does not form part of the+public licenses.++Creative Commons may be contacted at creativecommons.org.+diff --git a/LICENSES/GPL-3.0-or-later.txt b/LICENSES/GPL-3.0-or-later.txtnew file mode 100644index 0000000..f288702--- /dev/null+++ b/LICENSES/GPL-3.0-or-later.txt@@ -0,0 +1,674 @@+ GNU GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++ Preamble++ The GNU General Public License is a free, copyleft license for+software and other kinds of works.++ The licenses for most software and other practical works are designed+to take away your freedom to share and change the works. By contrast,+the GNU General Public License is intended to guarantee your freedom to+share and change all versions of a program--to make sure it remains free+software for all its users. We, the Free Software Foundation, use the+GNU General Public License for most of our software; it applies also to+any other work released this way by its authors. You can apply it to+your programs, too.++ When we speak of free software, we are referring to freedom, not+price. Our General Public Licenses are designed to make sure that you+have the freedom to distribute copies of free software (and charge for+them if you wish), that you receive source code or can get it if you+want it, that you can change the software or use pieces of it in new+free programs, and that you know you can do these things.++ To protect your rights, we need to prevent others from denying you+these rights or asking you to surrender the rights. Therefore, you have+certain responsibilities if you distribute copies of the software, or if+you modify it: responsibilities to respect the freedom of others.++ For example, if you distribute copies of such a program, whether+gratis or for a fee, you must pass on to the recipients the same+freedoms that you received. You must make sure that they, too, receive+or can get the source code. And you must show them these terms so they+know their rights.++ Developers that use the GNU GPL protect your rights with two steps:+(1) assert copyright on the software, and (2) offer you this License+giving you legal permission to copy, distribute and/or modify it.++ For the developers' and authors' protection, the GPL clearly explains+that there is no warranty for this free software. For both users' and+authors' sake, the GPL requires that modified versions be marked as+changed, so that their problems will not be attributed erroneously to+authors of previous versions.++ Some devices are designed to deny users access to install or run+modified versions of the software inside them, although the manufacturer+can do so. This is fundamentally incompatible with the aim of+protecting users' freedom to change the software. The systematic+pattern of such abuse occurs in the area of products for individuals to+use, which is precisely where it is most unacceptable. Therefore, we+have designed this version of the GPL to prohibit the practice for those+products. If such problems arise substantially in other domains, we+stand ready to extend this provision to those domains in future versions+of the GPL, as needed to protect the freedom of users.++ Finally, every program is threatened constantly by software patents.+States should not allow patents to restrict development and use of+software on general-purpose computers, but in those that do, we wish to+avoid the special danger that patents applied to a free program could+make it effectively proprietary. To prevent this, the GPL assures that+patents cannot be used to render the program non-free.++ The precise terms and conditions for copying, distribution and+modification follow.++ TERMS AND CONDITIONS++ 0. Definitions.++ "This License" refers to version 3 of the GNU General Public License.++ "Copyright" also means copyright-like laws that apply to other kinds of+works, such as semiconductor masks.++ "The Program" refers to any copyrightable work licensed under this+License. Each licensee is addressed as "you". "Licensees" and+"recipients" may be individuals or organizations.++ To "modify" a work means to copy from or adapt all or part of the work+in a fashion requiring copyright permission, other than the making of an+exact copy. The resulting work is called a "modified version" of the+earlier work or a work "based on" the earlier work.++ A "covered work" means either the unmodified Program or a work based+on the Program.++ To "propagate" a work means to do anything with it that, without+permission, would make you directly or secondarily liable for+infringement under applicable copyright law, except executing it on a+computer or modifying a private copy. Propagation includes copying,+distribution (with or without modification), making available to the+public, and in some countries other activities as well.++ To "convey" a work means any kind of propagation that enables other+parties to make or receive copies. Mere interaction with a user through+a computer network, with no transfer of a copy, is not conveying.++ An interactive user interface displays "Appropriate Legal Notices"+to the extent that it includes a convenient and prominently visible+feature that (1) displays an appropriate copyright notice, and (2)+tells the user that there is no warranty for the work (except to the+extent that warranties are provided), that licensees may convey the+work under this License, and how to view a copy of this License. If+the interface presents a list of user commands or options, such as a+menu, a prominent item in the list meets this criterion.++ 1. Source Code.++ The "source code" for a work means the preferred form of the work+for making modifications to it. "Object code" means any non-source+form of a work.++ A "Standard Interface" means an interface that either is an official+standard defined by a recognized standards body, or, in the case of+interfaces specified for a particular programming language, one that+is widely used among developers working in that language.++ The "System Libraries" of an executable work include anything, other+than the work as a whole, that (a) is included in the normal form of+packaging a Major Component, but which is not part of that Major+Component, and (b) serves only to enable use of the work with that+Major Component, or to implement a Standard Interface for which an+implementation is available to the public in source code form. A+"Major Component", in this context, means a major essential component+(kernel, window system, and so on) of the specific operating system+(if any) on which the executable work runs, or a compiler used to+produce the work, or an object code interpreter used to run it.++ The "Corresponding Source" for a work in object code form means all+the source code needed to generate, install, and (for an executable+work) run the object code and to modify the work, including scripts to+control those activities. However, it does not include the work's+System Libraries, or general-purpose tools or generally available free+programs which are used unmodified in performing those activities but+which are not part of the work. For example, Corresponding Source+includes interface definition files associated with source files for+the work, and the source code for shared libraries and dynamically+linked subprograms that the work is specifically designed to require,+such as by intimate data communication or control flow between those+subprograms and other parts of the work.++ The Corresponding Source need not include anything that users+can regenerate automatically from other parts of the Corresponding+Source.++ The Corresponding Source for a work in source code form is that+same work.++ 2. Basic Permissions.++ All rights granted under this License are granted for the term of+copyright on the Program, and are irrevocable provided the stated+conditions are met. This License explicitly affirms your unlimited+permission to run the unmodified Program. The output from running a+covered work is covered by this License only if the output, given its+content, constitutes a covered work. This License acknowledges your+rights of fair use or other equivalent, as provided by copyright law.++ You may make, run and propagate covered works that you do not+convey, without conditions so long as your license otherwise remains+in force. You may convey covered works to others for the sole purpose+of having them make modifications exclusively for you, or provide you+with facilities for running those works, provided that you comply with+the terms of this License in conveying all material for which you do+not control copyright. Those thus making or running the covered works+for you must do so exclusively on your behalf, under your direction+and control, on terms that prohibit them from making any copies of+your copyrighted material outside their relationship with you.++ Conveying under any other circumstances is permitted solely under+the conditions stated below. Sublicensing is not allowed; section 10+makes it unnecessary.++ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.++ No covered work shall be deemed part of an effective technological+measure under any applicable law fulfilling obligations under article+11 of the WIPO copyright treaty adopted on 20 December 1996, or+similar laws prohibiting or restricting circumvention of such+measures.++ When you convey a covered work, you waive any legal power to forbid+circumvention of technological measures to the extent such circumvention+is effected by exercising rights under this License with respect to+the covered work, and you disclaim any intention to limit operation or+modification of the work as a means of enforcing, against the work's+users, your or third parties' legal rights to forbid circumvention of+technological measures.++ 4. Conveying Verbatim Copies.++ You may convey verbatim copies of the Program's source code as you+receive it, in any medium, provided that you conspicuously and+appropriately publish on each copy an appropriate copyright notice;+keep intact all notices stating that this License and any+non-permissive terms added in accord with section 7 apply to the code;+keep intact all notices of the absence of any warranty; and give all+recipients a copy of this License along with the Program.++ You may charge any price or no price for each copy that you convey,+and you may offer support or warranty protection for a fee.++ 5. Conveying Modified Source Versions.++ You may convey a work based on the Program, or the modifications to+produce it from the Program, in the form of source code under the+terms of section 4, provided that you also meet all of these conditions:++ a) The work must carry prominent notices stating that you modified+ it, and giving a relevant date.++ b) The work must carry prominent notices stating that it is+ released under this License and any conditions added under section+ 7. This requirement modifies the requirement in section 4 to+ "keep intact all notices".++ c) You must license the entire work, as a whole, under this+ License to anyone who comes into possession of a copy. This+ License will therefore apply, along with any applicable section 7+ additional terms, to the whole of the work, and all its parts,+ regardless of how they are packaged. This License gives no+ permission to license the work in any other way, but it does not+ invalidate such permission if you have separately received it.++ d) If the work has interactive user interfaces, each must display+ Appropriate Legal Notices; however, if the Program has interactive+ interfaces that do not display Appropriate Legal Notices, your+ work need not make them do so.++ A compilation of a covered work with other separate and independent+works, which are not by their nature extensions of the covered work,+and which are not combined with it such as to form a larger program,+in or on a volume of a storage or distribution medium, is called an+"aggregate" if the compilation and its resulting copyright are not+used to limit the access or legal rights of the compilation's users+beyond what the individual works permit. Inclusion of a covered work+in an aggregate does not cause this License to apply to the other+parts of the aggregate.++ 6. Conveying Non-Source Forms.++ You may convey a covered work in object code form under the terms+of sections 4 and 5, provided that you also convey the+machine-readable Corresponding Source under the terms of this License,+in one of these ways:++ a) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by the+ Corresponding Source fixed on a durable physical medium+ customarily used for software interchange.++ b) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by a+ written offer, valid for at least three years and valid for as+ long as you offer spare parts or customer support for that product+ model, to give anyone who possesses the object code either (1) a+ copy of the Corresponding Source for all the software in the+ product that is covered by this License, on a durable physical+ medium customarily used for software interchange, for a price no+ more than your reasonable cost of physically performing this+ conveying of source, or (2) access to copy the+ Corresponding Source from a network server at no charge.++ c) Convey individual copies of the object code with a copy of the+ written offer to provide the Corresponding Source. This+ alternative is allowed only occasionally and noncommercially, and+ only if you received the object code with such an offer, in accord+ with subsection 6b.++ d) Convey the object code by offering access from a designated+ place (gratis or for a charge), and offer equivalent access to the+ Corresponding Source in the same way through the same place at no+ further charge. You need not require recipients to copy the+ Corresponding Source along with the object code. If the place to+ copy the object code is a network server, the Corresponding Source+ may be on a different server (operated by you or a third party)+ that supports equivalent copying facilities, provided you maintain+ clear directions next to the object code saying where to find the+ Corresponding Source. Regardless of what server hosts the+ Corresponding Source, you remain obligated to ensure that it is+ available for as long as needed to satisfy these requirements.++ e) Convey the object code using peer-to-peer transmission, provided+ you inform other peers where the object code and Corresponding+ Source of the work are being offered to the general public at no+ charge under subsection 6d.++ A separable portion of the object code, whose source code is excluded+from the Corresponding Source as a System Library, need not be+included in conveying the object code work.++ A "User Product" is either (1) a "consumer product", which means any+tangible personal property which is normally used for personal, family,+or household purposes, or (2) anything designed or sold for incorporation+into a dwelling. In determining whether a product is a consumer product,+doubtful cases shall be resolved in favor of coverage. For a particular+product received by a particular user, "normally used" refers to a+typical or common use of that class of product, regardless of the status+of the particular user or of the way in which the particular user+actually uses, or expects or is expected to use, the product. A product+is a consumer product regardless of whether the product has substantial+commercial, industrial or non-consumer uses, unless such uses represent+the only significant mode of use of the product.++ "Installation Information" for a User Product means any methods,+procedures, authorization keys, or other information required to install+and execute modified versions of a covered work in that User Product from+a modified version of its Corresponding Source. The information must+suffice to ensure that the continued functioning of the modified object+code is in no case prevented or interfered with solely because+modification has been made.++ If you convey an object code work under this section in, or with, or+specifically for use in, a User Product, and the conveying occurs as+part of a transaction in which the right of possession and use of the+User Product is transferred to the recipient in perpetuity or for a+fixed term (regardless of how the transaction is characterized), the+Corresponding Source conveyed under this section must be accompanied+by the Installation Information. But this requirement does not apply+if neither you nor any third party retains the ability to install+modified object code on the User Product (for example, the work has+been installed in ROM).++ The requirement to provide Installation Information does not include a+requirement to continue to provide support service, warranty, or updates+for a work that has been modified or installed by the recipient, or for+the User Product in which it has been modified or installed. Access to a+network may be denied when the modification itself materially and+adversely affects the operation of the network or violates the rules and+protocols for communication across the network.++ Corresponding Source conveyed, and Installation Information provided,+in accord with this section must be in a format that is publicly+documented (and with an implementation available to the public in+source code form), and must require no special password or key for+unpacking, reading or copying.++ 7. Additional Terms.++ "Additional permissions" are terms that supplement the terms of this+License by making exceptions from one or more of its conditions.+Additional permissions that are applicable to the entire Program shall+be treated as though they were included in this License, to the extent+that they are valid under applicable law. If additional permissions+apply only to part of the Program, that part may be used separately+under those permissions, but the entire Program remains governed by+this License without regard to the additional permissions.++ When you convey a copy of a covered work, you may at your option+remove any additional permissions from that copy, or from any part of+it. (Additional permissions may be written to require their own+removal in certain cases when you modify the work.) You may place+additional permissions on material, added by you to a covered work,+for which you have or can give appropriate copyright permission.++ Notwithstanding any other provision of this License, for material you+add to a covered work, you may (if authorized by the copyright holders of+that material) supplement the terms of this License with terms:++ a) Disclaiming warranty or limiting liability differently from the+ terms of sections 15 and 16 of this License; or++ b) Requiring preservation of specified reasonable legal notices or+ author attributions in that material or in the Appropriate Legal+ Notices displayed by works containing it; or++ c) Prohibiting misrepresentation of the origin of that material, or+ requiring that modified versions of such material be marked in+ reasonable ways as different from the original version; or++ d) Limiting the use for publicity purposes of names of licensors or+ authors of the material; or++ e) Declining to grant rights under trademark law for use of some+ trade names, trademarks, or service marks; or++ f) Requiring indemnification of licensors and authors of that+ material by anyone who conveys the material (or modified versions of+ it) with contractual assumptions of liability to the recipient, for+ any liability that these contractual assumptions directly impose on+ those licensors and authors.++ All other non-permissive additional terms are considered "further+restrictions" within the meaning of section 10. If the Program as you+received it, or any part of it, contains a notice stating that it is+governed by this License along with a term that is a further+restriction, you may remove that term. If a license document contains+a further restriction but permits relicensing or conveying under this+License, you may add to a covered work material governed by the terms+of that license document, provided that the further restriction does+not survive such relicensing or conveying.++ If you add terms to a covered work in accord with this section, you+must place, in the relevant source files, a statement of the+additional terms that apply to those files, or a notice indicating+where to find the applicable terms.++ Additional terms, permissive or non-permissive, may be stated in the+form of a separately written license, or stated as exceptions;+the above requirements apply either way.++ 8. Termination.++ You may not propagate or modify a covered work except as expressly+provided under this License. Any attempt otherwise to propagate or+modify it is void, and will automatically terminate your rights under+this License (including any patent licenses granted under the third+paragraph of section 11).++ However, if you cease all violation of this License, then your+license from a particular copyright holder is reinstated (a)+provisionally, unless and until the copyright holder explicitly and+finally terminates your license, and (b) permanently, if the copyright+holder fails to notify you of the violation by some reasonable means+prior to 60 days after the cessation.++ Moreover, your license from a particular copyright holder is+reinstated permanently if the copyright holder notifies you of the+violation by some reasonable means, this is the first time you have+received notice of violation of this License (for any work) from that+copyright holder, and you cure the violation prior to 30 days after+your receipt of the notice.++ Termination of your rights under this section does not terminate the+licenses of parties who have received copies or rights from you under+this License. If your rights have been terminated and not permanently+reinstated, you do not qualify to receive new licenses for the same+material under section 10.++ 9. Acceptance Not Required for Having Copies.++ You are not required to accept this License in order to receive or+run a copy of the Program. Ancillary propagation of a covered work+occurring solely as a consequence of using peer-to-peer transmission+to receive a copy likewise does not require acceptance. However,+nothing other than this License grants you permission to propagate or+modify any covered work. These actions infringe copyright if you do+not accept this License. Therefore, by modifying or propagating a+covered work, you indicate your acceptance of this License to do so.++ 10. Automatic Licensing of Downstream Recipients.++ Each time you convey a covered work, the recipient automatically+receives a license from the original licensors, to run, modify and+propagate that work, subject to this License. You are not responsible+for enforcing compliance by third parties with this License.++ An "entity transaction" is a transaction transferring control of an+organization, or substantially all assets of one, or subdividing an+organization, or merging organizations. If propagation of a covered+work results from an entity transaction, each party to that+transaction who receives a copy of the work also receives whatever+licenses to the work the party's predecessor in interest had or could+give under the previous paragraph, plus a right to possession of the+Corresponding Source of the work from the predecessor in interest, if+the predecessor has it or can get it with reasonable efforts.++ You may not impose any further restrictions on the exercise of the+rights granted or affirmed under this License. For example, you may+not impose a license fee, royalty, or other charge for exercise of+rights granted under this License, and you may not initiate litigation+(including a cross-claim or counterclaim in a lawsuit) alleging that+any patent claim is infringed by making, using, selling, offering for+sale, or importing the Program or any portion of it.++ 11. Patents.++ A "contributor" is a copyright holder who authorizes use under this+License of the Program or a work on which the Program is based. The+work thus licensed is called the contributor's "contributor version".++ A contributor's "essential patent claims" are all patent claims+owned or controlled by the contributor, whether already acquired or+hereafter acquired, that would be infringed by some manner, permitted+by this License, of making, using, or selling its contributor version,+but do not include claims that would be infringed only as a+consequence of further modification of the contributor version. For+purposes of this definition, "control" includes the right to grant+patent sublicenses in a manner consistent with the requirements of+this License.++ Each contributor grants you a non-exclusive, worldwide, royalty-free+patent license under the contributor's essential patent claims, to+make, use, sell, offer for sale, import and otherwise run, modify and+propagate the contents of its contributor version.++ In the following three paragraphs, a "patent license" is any express+agreement or commitment, however denominated, not to enforce a patent+(such as an express permission to practice a patent or covenant not to+sue for patent infringement). To "grant" such a patent license to a+party means to make such an agreement or commitment not to enforce a+patent against the party.++ If you convey a covered work, knowingly relying on a patent license,+and the Corresponding Source of the work is not available for anyone+to copy, free of charge and under the terms of this License, through a+publicly available network server or other readily accessible means,+then you must either (1) cause the Corresponding Source to be so+available, or (2) arrange to deprive yourself of the benefit of the+patent license for this particular work, or (3) arrange, in a manner+consistent with the requirements of this License, to extend the patent+license to downstream recipients. "Knowingly relying" means you have+actual knowledge that, but for the patent license, your conveying the+covered work in a country, or your recipient's use of the covered work+in a country, would infringe one or more identifiable patents in that+country that you have reason to believe are valid.++ If, pursuant to or in connection with a single transaction or+arrangement, you convey, or propagate by procuring conveyance of, a+covered work, and grant a patent license to some of the parties+receiving the covered work authorizing them to use, propagate, modify+or convey a specific copy of the covered work, then the patent license+you grant is automatically extended to all recipients of the covered+work and works based on it.++ A patent license is "discriminatory" if it does not include within+the scope of its coverage, prohibits the exercise of, or is+conditioned on the non-exercise of one or more of the rights that are+specifically granted under this License. You may not convey a covered+work if you are a party to an arrangement with a third party that is+in the business of distributing software, under which you make payment+to the third party based on the extent of your activity of conveying+the work, and under which the third party grants, to any of the+parties who would receive the covered work from you, a discriminatory+patent license (a) in connection with copies of the covered work+conveyed by you (or copies made from those copies), or (b) primarily+for and in connection with specific products or compilations that+contain the covered work, unless you entered into that arrangement,+or that patent license was granted, prior to 28 March 2007.++ Nothing in this License shall be construed as excluding or limiting+any implied license or other defenses to infringement that may+otherwise be available to you under applicable patent law.++ 12. No Surrender of Others' Freedom.++ If conditions are imposed on you (whether by court order, agreement or+otherwise) that contradict the conditions of this License, they do not+excuse you from the conditions of this License. If you cannot convey a+covered work so as to satisfy simultaneously your obligations under this+License and any other pertinent obligations, then as a consequence you may+not convey it at all. For example, if you agree to terms that obligate you+to collect a royalty for further conveying from those to whom you convey+the Program, the only way you could satisfy both those terms and this+License would be to refrain entirely from conveying the Program.++ 13. Use with the GNU Affero General Public License.++ Notwithstanding any other provision of this License, you have+permission to link or combine any covered work with a work licensed+under version 3 of the GNU Affero General Public License into a single+combined work, and to convey the resulting work. The terms of this+License will continue to apply to the part which is the covered work,+but the special requirements of the GNU Affero General Public License,+section 13, concerning interaction through a network will apply to the+combination as such.++ 14. Revised Versions of this License.++ The Free Software Foundation may publish revised and/or new versions of+the GNU General Public License from time to time. Such new versions will+be similar in spirit to the present version, but may differ in detail to+address new problems or concerns.++ Each version is given a distinguishing version number. If the+Program specifies that a certain numbered version of the GNU General+Public License "or any later version" applies to it, you have the+option of following the terms and conditions either of that numbered+version or of any later version published by the Free Software+Foundation. If the Program does not specify a version number of the+GNU General Public License, you may choose any version ever published+by the Free Software Foundation.++ If the Program specifies that a proxy can decide which future+versions of the GNU General Public License can be used, that proxy's+public statement of acceptance of a version permanently authorizes you+to choose that version for the Program.++ Later license versions may give you additional or different+permissions. However, no additional obligations are imposed on any+author or copyright holder as a result of your choosing to follow a+later version.++ 15. Disclaimer of Warranty.++ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.++ 16. Limitation of Liability.++ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF+SUCH DAMAGES.++ 17. Interpretation of Sections 15 and 16.++ If the disclaimer of warranty and limitation of liability provided+above cannot be given local legal effect according to their terms,+reviewing courts shall apply local law that most closely approximates+an absolute waiver of all civil liability in connection with the+Program, unless a warranty or assumption of liability accompanies a+copy of the Program in return for a fee.++ END OF TERMS AND CONDITIONS++ How to Apply These Terms to Your New Programs++ If you develop a new program, and you want it to be of the greatest+possible use to the public, the best way to achieve this is to make it+free software which everyone can redistribute and change under these terms.++ To do so, attach the following notices to the program. It is safest+to attach them to the start of each source file to most effectively+state the exclusion of warranty; and each file should have at least+the "copyright" line and a pointer to where the full notice is found.++ <one line to give the program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ This program is free software: you can redistribute it and/or modify+ it under the terms of the GNU General Public License as published by+ the Free Software Foundation, either version 3 of the License, or+ (at your option) any later version.++ This program is distributed in the hope that it will be useful,+ but WITHOUT ANY WARRANTY; without even the implied warranty of+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+ GNU General Public License for more details.++ You should have received a copy of the GNU General Public License+ along with this program. If not, see <https://www.gnu.org/licenses/>.++Also add information on how to contact you by electronic and paper mail.++ If the program does terminal interaction, make it output a short+notice like this when it starts in an interactive mode:++ <program> Copyright (C) <year> <name of author>+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.+ This is free software, and you are welcome to redistribute it+ under certain conditions; type `show c' for details.++The hypothetical commands `show w' and `show c' should show the appropriate+parts of the General Public License. Of course, your program's commands+might be different; for a GUI interface, you would use an "about box".++ You should also get your employer (if you work as a programmer) or school,+if any, to sign a "copyright disclaimer" for the program, if necessary.+For more information on this, and how to apply and follow the GNU GPL, see+<https://www.gnu.org/licenses/>.++ The GNU General Public License does not permit incorporating your program+into proprietary programs. If your program is a subroutine library, you+may consider it more useful to permit linking proprietary applications with+the library. If this is what you want to do, use the GNU Lesser General+Public License instead of this License. But first, please read+<https://www.gnu.org/licenses/why-not-lgpl.html>.diff --git a/LICENSES/MPL-2.0.txt b/LICENSES/MPL-2.0.txtnew file mode 100644index 0000000..d0a1fa1--- /dev/null+++ b/LICENSES/MPL-2.0.txt@@ -0,0 +1,373 @@+Mozilla Public License Version 2.0+==================================++1. Definitions+--------------++1.1. "Contributor"+ means each individual or legal entity that creates, contributes to+ the creation of, or owns Covered Software.++1.2. "Contributor Version"+ means the combination of the Contributions of others (if any) used+ by a Contributor and that particular Contributor's Contribution.++1.3. "Contribution"+ means Covered Software of a particular Contributor.++1.4. "Covered Software"+ means Source Code Form to which the initial Contributor has attached+ the notice in Exhibit A, the Executable Form of such Source Code+ Form, and Modifications of such Source Code Form, in each case+ including portions thereof.++1.5. "Incompatible With Secondary Licenses"+ means++ (a) that the initial Contributor has attached the notice described+ in Exhibit B to the Covered Software; or++ (b) that the Covered Software was made available under the terms of+ version 1.1 or earlier of the License, but not also under the+ terms of a Secondary License.++1.6. "Executable Form"+ means any form of the work other than Source Code Form.++1.7. "Larger Work"+ means a work that combines Covered Software with other material, in+ a separate file or files, that is not Covered Software.++1.8. "License"+ means this document.++1.9. "Licensable"+ means having the right to grant, to the maximum extent possible,+ whether at the time of the initial grant or subsequently, any and+ all of the rights conveyed by this License.++1.10. "Modifications"+ means any of the following:++ (a) any file in Source Code Form that results from an addition to,+ deletion from, or modification of the contents of Covered+ Software; or++ (b) any new file in Source Code Form that contains any Covered+ Software.++1.11. "Patent Claims" of a Contributor+ means any patent claim(s), including without limitation, method,+ process, and apparatus claims, in any patent Licensable by such+ Contributor that would be infringed, but for the grant of the+ License, by the making, using, selling, offering for sale, having+ made, import, or transfer of either its Contributions or its+ Contributor Version.++1.12. "Secondary License"+ means either the GNU General Public License, Version 2.0, the GNU+ Lesser General Public License, Version 2.1, the GNU Affero General+ Public License, Version 3.0, or any later versions of those+ licenses.++1.13. "Source Code Form"+ means the form of the work preferred for making modifications.++1.14. "You" (or "Your")+ means an individual or a legal entity exercising rights under this+ License. For legal entities, "You" includes any entity that+ controls, is controlled by, or is under common control with You. For+ purposes of this definition, "control" means (a) the power, direct+ or indirect, to cause the direction or management of such entity,+ whether by contract or otherwise, or (b) ownership of more than+ fifty percent (50%) of the outstanding shares or beneficial+ ownership of such entity.++2. License Grants and Conditions+--------------------------------++2.1. Grants++Each Contributor hereby grants You a world-wide, royalty-free,+non-exclusive license:++(a) under intellectual property rights (other than patent or trademark)+ Licensable by such Contributor to use, reproduce, make available,+ modify, display, perform, distribute, and otherwise exploit its+ Contributions, either on an unmodified basis, with Modifications, or+ as part of a Larger Work; and++(b) under Patent Claims of such Contributor to make, use, sell, offer+ for sale, have made, import, and otherwise transfer either its+ Contributions or its Contributor Version.++2.2. Effective Date++The licenses granted in Section 2.1 with respect to any Contribution+become effective for each Contribution on the date the Contributor first+distributes such Contribution.++2.3. Limitations on Grant Scope++The licenses granted in this Section 2 are the only rights granted under+this License. No additional rights or licenses will be implied from the+distribution or licensing of Covered Software under this License.+Notwithstanding Section 2.1(b) above, no patent license is granted by a+Contributor:++(a) for any code that a Contributor has removed from Covered Software;+ or++(b) for infringements caused by: (i) Your and any other third party's+ modifications of Covered Software, or (ii) the combination of its+ Contributions with other software (except as part of its Contributor+ Version); or++(c) under Patent Claims infringed by Covered Software in the absence of+ its Contributions.++This License does not grant any rights in the trademarks, service marks,+or logos of any Contributor (except as may be necessary to comply with+the notice requirements in Section 3.4).++2.4. Subsequent Licenses++No Contributor makes additional grants as a result of Your choice to+distribute the Covered Software under a subsequent version of this+License (see Section 10.2) or under the terms of a Secondary License (if+permitted under the terms of Section 3.3).++2.5. Representation++Each Contributor represents that the Contributor believes its+Contributions are its original creation(s) or it has sufficient rights+to grant the rights to its Contributions conveyed by this License.++2.6. Fair Use++This License is not intended to limit any rights You have under+applicable copyright doctrines of fair use, fair dealing, or other+equivalents.++2.7. Conditions++Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted+in Section 2.1.++3. Responsibilities+-------------------++3.1. Distribution of Source Form++All distribution of Covered Software in Source Code Form, including any+Modifications that You create or to which You contribute, must be under+the terms of this License. You must inform recipients that the Source+Code Form of the Covered Software is governed by the terms of this+License, and how they can obtain a copy of this License. You may not+attempt to alter or restrict the recipients' rights in the Source Code+Form.++3.2. Distribution of Executable Form++If You distribute Covered Software in Executable Form then:++(a) such Covered Software must also be made available in Source Code+ Form, as described in Section 3.1, and You must inform recipients of+ the Executable Form how they can obtain a copy of such Source Code+ Form by reasonable means in a timely manner, at a charge no more+ than the cost of distribution to the recipient; and++(b) You may distribute such Executable Form under the terms of this+ License, or sublicense it under different terms, provided that the+ license for the Executable Form does not attempt to limit or alter+ the recipients' rights in the Source Code Form under this License.++3.3. Distribution of a Larger Work++You may create and distribute a Larger Work under terms of Your choice,+provided that You also comply with the requirements of this License for+the Covered Software. If the Larger Work is a combination of Covered+Software with a work governed by one or more Secondary Licenses, and the+Covered Software is not Incompatible With Secondary Licenses, this+License permits You to additionally distribute such Covered Software+under the terms of such Secondary License(s), so that the recipient of+the Larger Work may, at their option, further distribute the Covered+Software under the terms of either this License or such Secondary+License(s).++3.4. Notices++You may not remove or alter the substance of any license notices+(including copyright notices, patent notices, disclaimers of warranty,+or limitations of liability) contained within the Source Code Form of+the Covered Software, except that You may alter any license notices to+the extent required to remedy known factual inaccuracies.++3.5. Application of Additional Terms++You may choose to offer, and to charge a fee for, warranty, support,+indemnity or liability obligations to one or more recipients of Covered+Software. However, You may do so only on Your own behalf, and not on+behalf of any Contributor. You must make it absolutely clear that any+such warranty, support, indemnity, or liability obligation is offered by+You alone, and You hereby agree to indemnify every Contributor for any+liability incurred by such Contributor as a result of warranty, support,+indemnity or liability terms You offer. You may include additional+disclaimers of warranty and limitations of liability specific to any+jurisdiction.++4. Inability to Comply Due to Statute or Regulation+---------------------------------------------------++If it is impossible for You to comply with any of the terms of this+License with respect to some or all of the Covered Software due to+statute, judicial order, or regulation then You must: (a) comply with+the terms of this License to the maximum extent possible; and (b)+describe the limitations and the code they affect. Such description must+be placed in a text file included with all distributions of the Covered+Software under this License. Except to the extent prohibited by statute+or regulation, such description must be sufficiently detailed for a+recipient of ordinary skill to be able to understand it.++5. Termination+--------------++5.1. The rights granted under this License will terminate automatically+if You fail to comply with any of its terms. However, if You become+compliant, then the rights granted under this License from a particular+Contributor are reinstated (a) provisionally, unless and until such+Contributor explicitly and finally terminates Your grants, and (b) on an+ongoing basis, if such Contributor fails to notify You of the+non-compliance by some reasonable means prior to 60 days after You have+come back into compliance. Moreover, Your grants from a particular+Contributor are reinstated on an ongoing basis if such Contributor+notifies You of the non-compliance by some reasonable means, this is the+first time You have received notice of non-compliance with this License+from such Contributor, and You become compliant prior to 30 days after+Your receipt of the notice.++5.2. If You initiate litigation against any entity by asserting a patent+infringement claim (excluding declaratory judgment actions,+counter-claims, and cross-claims) alleging that a Contributor Version+directly or indirectly infringes any patent, then the rights granted to+You by any and all Contributors for the Covered Software under Section+2.1 of this License shall terminate.++5.3. In the event of termination under Sections 5.1 or 5.2 above, all+end user license agreements (excluding distributors and resellers) which+have been validly granted by You or Your distributors under this License+prior to termination shall survive termination.++************************************************************************+* *+* 6. Disclaimer of Warranty *+* ------------------------- *+* *+* Covered Software is provided under this License on an "as is" *+* basis, without warranty of any kind, either expressed, implied, or *+* statutory, including, without limitation, warranties that the *+* Covered Software is free of defects, merchantable, fit for a *+* particular purpose or non-infringing. The entire risk as to the *+* quality and performance of the Covered Software is with You. *+* Should any Covered Software prove defective in any respect, You *+* (not any Contributor) assume the cost of any necessary servicing, *+* repair, or correction. This disclaimer of warranty constitutes an *+* essential part of this License. No use of any Covered Software is *+* authorized under this License except under this disclaimer. *+* *+************************************************************************++************************************************************************+* *+* 7. Limitation of Liability *+* -------------------------- *+* *+* Under no circumstances and under no legal theory, whether tort *+* (including negligence), contract, or otherwise, shall any *+* Contributor, or anyone who distributes Covered Software as *+* permitted above, be liable to You for any direct, indirect, *+* special, incidental, or consequential damages of any character *+* including, without limitation, damages for lost profits, loss of *+* goodwill, work stoppage, computer failure or malfunction, or any *+* and all other commercial damages or losses, even if such party *+* shall have been informed of the possibility of such damages. This *+* limitation of liability shall not apply to liability for death or *+* personal injury resulting from such party's negligence to the *+* extent applicable law prohibits such limitation. Some *+* jurisdictions do not allow the exclusion or limitation of *+* incidental or consequential damages, so this exclusion and *+* limitation may not apply to You. *+* *+************************************************************************++8. Litigation+-------------++Any litigation relating to this License may be brought only in the+courts of a jurisdiction where the defendant maintains its principal+place of business and such litigation shall be governed by laws of that+jurisdiction, without reference to its conflict-of-law provisions.+Nothing in this Section shall prevent a party's ability to bring+cross-claims or counter-claims.++9. Miscellaneous+----------------++This License represents the complete agreement concerning the subject+matter hereof. If any provision of this License is held to be+unenforceable, such provision shall be reformed only to the extent+necessary to make it enforceable. Any law or regulation which provides+that the language of a contract shall be construed against the drafter+shall not be used to construe this License against a Contributor.++10. Versions of the License+---------------------------++10.1. New Versions++Mozilla Foundation is the license steward. Except as provided in Section+10.3, no one other than the license steward has the right to modify or+publish new versions of this License. Each version will be given a+distinguishing version number.++10.2. Effect of New Versions++You may distribute the Covered Software under the terms of the version+of the License under which You originally received the Covered Software,+or under the terms of any subsequent version published by the license+steward.++10.3. Modified Versions++If you create software not governed by this License, and you want to+create a new license for such software, you may create and use a+modified version of this License if you rename the license and remove+any references to the name of the license steward (except to note that+such modified license differs from this License).++10.4. Distributing Source Code Form that is Incompatible With Secondary+Licenses++If You choose to distribute Source Code Form that is Incompatible With+Secondary Licenses under the terms of this version of the License, the+notice described in Exhibit B of this License must be attached.++Exhibit A - Source Code Form License Notice+-------------------------------------------++ This Source Code Form is subject to the terms of the Mozilla Public+ License, v. 2.0. If a copy of the MPL was not distributed with this+ file, You can obtain one at https://mozilla.org/MPL/2.0/.++If it is not possible or desirable to put the notice in a particular+file, then You may include the notice in a location (such as a LICENSE+file in a relevant directory) where a recipient would be likely to look+for such a notice.++You may add additional accurate notices of copyright ownership.++Exhibit B - "Incompatible With Secondary Licenses" Notice+---------------------------------------------------------++ This Source Code Form is "Incompatible With Secondary Licenses", as+ defined by the Mozilla Public License, v. 2.0.diff --git a/README.md b/README.mdnew file mode 100644index 0000000..43337ed--- /dev/null+++ b/README.md@@ -0,0 +1,40 @@+# Nectarlink++**Your Android phone and your Windows PC, working as one.**++Nectarlink is one open-source app that replaces the pile of tools people juggle today: Phone Link, KDE Connect, scrcpy, LocalSend and the discontinued Intel Unison.++> Bees carry nectar back to the hive. Nectarlink carries everything between your phone and your PC.++> **Status: pre-alpha, in active development.** Nothing is ready to install yet.++## What it will do++- **Notifications** on your PC with replies and actions, including OTP codes.+- **Messages and calls**: SMS/MMS, one inbox for chat apps, call alerts and controls.+- **Clipboard** synced both ways, with history and smart suggestions.+- **Files and photos**: drag and drop, resumable transfers, your phone's storage inside Explorer, LocalSend compatibility.+- **Mirroring and phone apps on your PC**: each app in its own window, with audio and keyboard/mouse. Nothing extra to install.+- **Phone as webcam, touchpad, air mouse, Stream-Deck-style macro pad, voice recorder and voice keyboard** for your PC.+- **Works everywhere**: Wi-Fi, USB, and optionally away from home. End-to-end encrypted, no account, no cloud.+- **Power Levels**: everything works with normal permissions, and an optional one-time setup unlocks more on any Android phone (no root required).++The full plan, including research, features, architecture and roadmap, is in [docs/PLAN.md](docs/PLAN.md).++## Tech++- **Shared core:** Rust (networking via [iroh](https://iroh.computer), pairing, transfers, storage).+- **Windows app:** Qt Quick (QML) UI on a Rust backend. Windows 11, x64 and ARM64.+- **Android app:** Kotlin + Jetpack Compose (Material 3 Expressive).++## License++- Desktop and Android apps: [GPL-3.0-or-later](LICENSES/GPL-3.0-or-later.txt), with an [app-store exception](LICENSES/APP-STORE-EXCEPTION.md).+- Core libraries: [MPL-2.0](LICENSES/MPL-2.0.txt).+- Protocol specification and documentation: [CC BY 4.0](LICENSES/CC-BY-4.0.txt).++See [LICENSE](LICENSE) for which applies where. The Nectarlink name and logo are covered by the [trademark policy](TRADEMARKS.md).++## Contributing++See [CONTRIBUTING.md](CONTRIBUTING.md). Contributions are accepted under the [Developer Certificate of Origin](DCO.txt), and everyone is expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md). To report a security issue, please follow [SECURITY.md](SECURITY.md).diff --git a/SECURITY.md b/SECURITY.mdnew file mode 100644index 0000000..65e6e9c--- /dev/null+++ b/SECURITY.md@@ -0,0 +1,32 @@+# Security policy++Nectarlink handles sensitive data such as notifications, messages, one-time+codes and files, so security reports are taken seriously.++## Reporting a vulnerability++**Please don't open a public issue for security problems.**++Report privately through GitHub's private vulnerability reporting: open the+repository's **Security** tab and choose **Report a vulnerability**.++Please include:++- what the issue is and its impact,+- steps to reproduce, or a proof of concept,+- the affected versions (desktop app, Android app, Windows and Android+ versions).++## What to expect++- An acknowledgement within 7 days.+- Updates as the issue is investigated and fixed.+- Credit in the release notes once a fix ships, if you'd like it.++Please give us a reasonable amount of time to release a fix before disclosing+the issue publicly.++## Supported versions++Nectarlink is in pre-alpha. Until the first stable release, only the latest+development version receives security fixes.diff --git a/TRADEMARKS.md b/TRADEMARKS.mdnew file mode 100644index 0000000..bb7572f--- /dev/null+++ b/TRADEMARKS.md@@ -0,0 +1,27 @@+# Trademark policy++The Nectarlink source code is open source, but the **Nectarlink name and+logo** are not covered by the software licenses. This policy exists so that+people can trust that something called "Nectarlink" really comes from this+project.++## You're welcome to++- Use the name "Nectarlink" to refer to the project, for example in articles,+ reviews, tutorials and videos.+- Say that your software is "compatible with Nectarlink" or "based on+ Nectarlink", as long as that's accurate.+- Redistribute unmodified official builds under the Nectarlink name.++## Please don't++- Distribute a **modified** version under the Nectarlink name or logo. Forks+ are welcome, but they need their own name and logo.+- Use the name or logo in a way that suggests the project endorses you, your+ product or your service when it doesn't.+- Use the name or a confusingly similar one in app store listings, domain names+ or social media accounts for software that isn't the official Nectarlink.++## Questions++If you're unsure whether your use is fine, open an issue and ask.diff --git a/docs/PLAN.md b/docs/PLAN.mdnew file mode 100644index 0000000..5393148--- /dev/null+++ b/docs/PLAN.md@@ -0,0 +1,769 @@+# Nectarlink: Product & Engineering Plan++> **Nectarlink** connects Android phones and Windows PCs. It's one open-source app that replaces Phone Link, KDE Connect, scrcpy, LocalSend and Intel Unison.+> *Bees carry nectar back to the hive. Nectarlink carries everything between your phone and your PC.*+> Status: **planning complete, stack locked (Qt Quick + Rust), name final (Nectarlink), repo initialized locally. No product code yet.** Next steps in §12. Last updated 2026-10-04.++---++## 0. Decisions at a glance++| Question | Decision | One-line reason |+|---|---|---|+| Name | **Nectarlink** ✅ | Clean name (no conflicts found), warm, on the bee theme, says "connection". See §10.1 |+| Shared engine | **Rust core** (`nectarlink-core`) used by both apps | Both ends run the same protocol code, which avoids the cross-implementation bugs KDE Connect has |+| Transport | **iroh 1.x** (QUIC, devices dialed by public key) | E2E-encrypted by default, LAN discovery, hole punching, relay fallback and multipath in one library (1.0 June 2026, now 1.3) |+| Wire format | **CBOR (serde)** over QUIC streams, plus a versioned spec in `docs/protocol` | Self-describing and forward-compatible, with no codegen toolchain. Third parties can still implement it |+| Windows app | **Qt Quick (QML) for the UI + Rust for everything else** (bridged by cxx-qt), `windows-rs` for OS integration, mirrored video drawn inside the UI with no copies. **No WebView, no web stack** ✅ | Visual ceiling equal to web (real blur, shaders, Caelestia-level motion) at a fraction of the RAM, best fit for video and always-on overlays. Gated by a Phase 0 "Qt + Rust proof" (§5.1) |+| Android app | **Kotlin + Jetpack Compose + Material 3 Expressive**, core via **UniFFI** | Deep OS integration needs native Kotlin, and Compose/M3 Expressive is the best-looking, smoothest Android UI stack |+| Mirroring | **Two engines:** *Elevated* (scrcpy-server, Apache-2.0) and *Standard* (MediaProjection). PC side decodes in hardware with Media Foundation and renders with D3D11 | Best quality and features when privileged access exists, and it still works when it doesn't |+| Superpowers without root | **Power Levels** (Basic → Assist → Elevated → Root). Elevated mode runs Nectarlink's *own* code as the `shell` user, so there's **no extra app to install**. Several setup paths, and the UI greys out features by level | Unlocks background clipboard, sensitive notifications, consent-free mirroring, app windows and toggles on **any** Android phone |+| Accounts / cloud | **None.** Local-first. Optional "away from home" mode via relays (self-hostable) | Privacy is the #1 reason people leave Phone Link |+| Platforms | **Windows 11 only** (x64 + native ARM64). Android 8+. **macOS desktop = future scope** (Qt Quick, the Rust core and the `Platform`/`VideoSink` layers make it a port, not a rewrite). iPhone = later | Win11-only frees us to use Mica, the virtual camera API and the Win11 context menu |+| Distribution | **GitHub-first**: GitHub Releases + winget (Windows), GitHub Releases + Obtainium + later IzzyOnDroid (Android). No Play account for now | Free, fast to ship, no Play policy limits on SMS/Accessibility/files |+| License | ✅ Apps **GPL-3.0-or-later** (+ app-store exception), core crates **MPL-2.0**, protocol spec & docs **CC BY 4.0**, name/logo trademark-protected, **DCO** for contributions | See §10.2 |+| Crash reports | **Opt-in only**, with a preview of exactly what gets sent | Privacy is a selling point |++---++## 1. Research: what exists and what people say++### 1.1 The landscape++| App | Strengths | Weaknesses / complaints |+|---|---|---|+| **Microsoft Phone Link** | Built into Windows 11. Calls via Bluetooth, SMS, photos, notifications, Start menu phone flyout, "Lock PC" from phone, Cross-Device Resume, "Expanded screen" app mirroring (Jan 2026) | Needs a Microsoft account. App mirroring and copy-paste are **gated to Samsung/HONOR/OPPO/ASUS/vivo/Xiaomi**. Frequent disconnects ("offline", drops after PC sleep). **Sensitive notifications (OTPs) blocked** on Android 15+ for Play Store installs, and in 2026 Microsoft announced it blocks them outright, which made users angry. Closed source |+| **KDE Connect** | Feature-rich, FOSS, cross-platform (officially on Windows via Microsoft Store and installer, v26.08.1 Sept 2026), run commands, presentation remote, true bidirectional clipboard | Windows is a secondary platform with rougher edges than Linux. Discovery and firewall trouble (UDP broadcast on 1714–1764, rules hard to add). Same-network only. "Constant connectivity issues", dated UI/UX. No virtual display. Several features are one-directional |+| **Sefirah** (closest competitor) | WinUI 3, nice Fluent UI, ~3k stars, actively developed (v3.1, Aug 2026). Notifications, clipboard (Shizuku/ADB), media, files, **Android storage in Explorer**, SMS, **Bluetooth calling (v3.0)**, scrcpy mirroring, Play Sound | scrcpy must be **downloaded and configured manually**. Windows-only UI tech. No SMS attachments. Open issues ask for **LAN-not-just-Wi-Fi, mobile data / away use, virtual touchpad, contacts tab, keyboard shortcuts, custom phone toggles, auto-select device, battery-saving controls**. Bugs: tray icon missing, stuck loading, SMS sync lag, mirror not responding. Breaking releases (v3.0 needed a reinstall due to expired certs). Some fork/source turbulence in Oct 2026 |+| **scrcpy** (4.0, May 2026) | Best-in-class mirroring: low latency, audio, camera, **virtual displays (resizable in 4.0)**, UHID keyboard/mouse, OTG | CLI-first, needs USB debugging / ADB knowledge, no GUI, no pairing UX, no other features |+| **LocalSend** | Fast, cross-platform (incl. iOS/macOS), no account, open REST protocol v2 | Files only (no clipboard or notification sync). Discovery fails on AP isolation / VPN / Windows firewall / "Public" network profile |+| **Intel Unison** (dead) | Loved for files, photos, SMS and calls for **both Android and iOS**, and tablet as second screen | Discontinued June 2025, download removed Jan 2026. Its users are now homeless |+| **Tandem** (SamyogKarki/tandem, new open-source project) | Windows app for Android phones: screen mirroring and control over Wi-Fi (via Android wireless debugging, QR pairing), file drag and drop, shared clipboard, notifications and calls on the PC. Nothing to install on the phone | Windows-only, needs Android 11+ and wireless debugging, same Wi-Fi. A young project, but shows the same "one app instead of scrcpy + KDE Connect" idea. Another reason to avoid the name "Tandem" |+| **Quick Share (Google)** | Fast file sharing, official, now on Windows | Files only, Google-controlled |+| **AirDroid / Pushbullet / GlideX** | Remote management, "unify control" across devices (GlideX) | Freemium, cloud accounts, ads, privacy concerns |++### 1.2 What users complain about (ranked by how often it comes up)++1. **"It disconnects / can't find my device."** This covers firewalls, the Windows "Public" network profile, AP isolation, VPNs, PC sleep, and Android battery killers (OnePlus, Xiaomi and others). *This is the #1 problem across every app in the category.*+2. **Features locked to certain phones** (Phone Link's OEM gating).+3. **Lost OTP / 2FA notifications** after Android 15.+4. **Accounts and cloud** (Phone Link's Microsoft account).+5. **Juggling several apps**: scrcpy for mirroring, LocalSend for files, KDE Connect for everything else.+6. **Setup friction**: ADB, Shizuku, manual scrcpy paths, firewall rules, restricted-settings toggles.+7. **Only works on the same Wi-Fi.** People want Ethernet PCs, USB, and mobile data / away use.+8. **Ugly or confusing UI** (KDE Connect on Windows).+9. **Wishlist:** phone apps as separate PC windows, phone as webcam, phone as touchpad/keyboard, contacts, keyboard shortcuts, phone toggles (Wi-Fi/BT/DND/hotspot) from the PC, Explorer integration, tablet as second screen, mouse flowing across devices.++### 1.3 Hard platform constraints (these shape the architecture)++| Constraint | Impact | Our answer |+|---|---|---|+| Android 10+: no background clipboard read | Auto clipboard sync phone→PC is impossible for normal apps | Elevated mode reads the clipboard. Fallbacks: QS tile, share target, notification button, optional Nectarlink keyboard (IME) |+| Android 15+: sensitive notifications redacted for untrusted listeners | OTPs and 2FA vanish | Elevated mode grants Nectarlink `RECEIVE_SENSITIVE_NOTIFICATIONS` via appops (one time, persists). Explained clearly in onboarding |+| Android 14+: MediaProjection needs consent **every session** | Standard mirroring shows a dialog each time | Elevated engine (scrcpy-server as shell) has no prompts |+| Android 13+: "restricted settings" for sideloaded apps | Notification-listener and accessibility toggles are greyed out for non-store installs | Onboarding detects it and walks through "Allow restricted settings". Obtainium installs reduce the friction |+| Android developer verification (enforced from 30 Sep 2026 in BR/ID/SG/TH, global 2027) | Unverified sideloads get blocked, and that includes GitHub APKs | Register for verification (non-Play path) before global enforcement. One signing key for every channel from day one |+| Google Play policy: SMS/Call Log, Accessibility, All-files access | Rejection risk *if/when* we go to Play | GitHub-first ships only the **`full`** flavor. The code keeps a `play` flavor seam so a Play build is cheap later |+| No 3rd-party call-audio capture on Android | Can't stream call audio over IP | Bluetooth **HFP** (PC acts as headset). The Windows `PhoneLineTransportDevice` API broke for unpackaged apps on 22H2+, yet Sefirah v3 ships Bluetooth calling, so it's feasible (likely needs package identity). **Spike early** |+| Windows 11 virtual camera API (`MFCreateVirtualCamera`, build 22000+) | Phone-as-webcam needs no kernel driver | COM media-source DLL. Proven by open-source samples (VCamSample, BestCam) |+| Virtual monitor on Windows needs an IddCx driver | Tablet-as-second-screen needs a signed driver | Later phase. Evaluate an MIT-licensed signed IddCx driver |+| Unlock-PC-with-phone needs a custom Windows **credential provider** | Security-critical code running in the logon UI | Dedicated design + external security review before shipping (§3.11) |+++### 1.4 What we take from KDE Connect (inspiration only, no connection to it)+Nectarlink does **not** pair with or talk to KDE Connect. We study what it does well and build our own version:+- **Per-device plugin toggles**: every feature can be switched on/off per paired device. This becomes our per-device feature permissions.+- **Run commands**: user-defined PC commands triggered from the phone. Our custom commands / Deck actions, off by default.+- **Presentation remote**: slide control plus a pointer. Our presentation remote with laser pointer.+- **Remote input**: phone as touchpad and keyboard. Our touchpad / air mouse.+- **Find my phone + ping**: simple and loved. Kept.+- **Battery and connectivity reports**: phone battery and signal on the PC. Kept.+- **Bidirectional media control**: both devices control each other's players. Kept, plus the Windows media flyout.+- **Browse phone storage from the PC**: KDE Connect uses SFTP; we use native Explorer integration.+- **Pairing with explicit confirmation on both sides**: kept, with our QR / 6-digit code flow.++What we deliberately do differently: discovery and connectivity (their #1 weakness), the Windows UI, and setup friction.++---++## 2. Product principles++1. **It just works.** Connection reliability beats every feature, and setup takes under 60 seconds. When something breaks, the app tells you *why* and fixes it with one click.+2. **Every Android phone is first-class.** No OEM gating, and nothing is held back as a Samsung-only feature.+3. **Local-first and private.** No account, no telemetry by default, E2E encryption always, open protocol.+4. **One app, not five.** Mirroring, files, clipboard, notifications, messages, calls and webcam live in one place, with one pairing.+5. **Beautiful, fast, light.** Native GPU rendering, 60–120 fps, spring physics, fast start, and a tray app that stays light all day.+6. **Graceful power tiers.** Everything works with standard permissions. Elevated adds superpowers, and Root adds a little more. The UI always shows which tier you're on and what the next tier unlocks.+7. **Keyboard-first on PC, thumb-first on phone.**++---++## 3. Feature set++Tiers: **P0** = needed for the first public release, **P1** = 1.0, **P2** = after 1.0.+Power: 🟢 Basic · 🔵 Assist · 🟣 Elevated · 🔴 Root (see §4.6).++### 3.1 Connection & setup+| Feature | Tier |+|---|---|+| Pair by **QR code** (PC shows QR → phone scans), by **tap a nearby device + 6-digit code match**, or **plug in USB** (auto-pair) | P0 |+| Auto-reconnect everywhere: PC wake from sleep, Wi-Fi changes, phone reboot, app updates | P0 |+| Works over **Wi-Fi, Ethernet-to-Wi-Fi, USB**, and **away from home** (hole punching + relay, opt-in, self-hostable) | P0 (LAN/USB), P1 (away) |+| **Connection Doctor**: detects firewall, Public network profile, AP isolation, VPN, battery optimization, OEM killers. One-click fixes plus per-OEM guides | P0 |+| Companion Device Manager association + PC BLE beacon, so the phone app is woken when the PC is nearby | P1 |+| Bluetooth fallback link for low-bandwidth features (notifications, SMS, calls) when there's no shared network | P2 |+| Multiple phones per PC, multiple PCs per phone, per-device feature permissions | P0 (model), P1 (UI) |++### 3.2 Notifications+| Feature | Tier |+|---|---|+| Mirror notifications as native Windows toasts with **app icon, big images, actions, inline reply** | P0 🟢 |+| Dismiss sync (clear on one side → cleared on the other), per-app allow/block, quiet hours | P0 🟢 |+| Notification feed in the app: history, search, grouping by app/conversation | P0 🟢 |+| **Sensitive notifications / OTPs** | P0 🟣 |+| **Smart OTP**: detect codes and offer a "Copy code" toast; auto-copy optional | P1 |+| **Live Updates** (Android 16 progress notifications: rides, deliveries, timers) shown live on PC | P1 |+| DND sync both ways (Focus on PC ↔ DND on phone) | P1 🟢/🟣 |+| PC notifications → phone (optional) | P2 |++### 3.3 Messages (SMS/MMS + chat apps)+| Feature | Tier |+|---|---|+| SMS/MMS threads, send, receive, search, **attachments (MMS images)** | P0 🟢 |+| **Unified Conversations**: RCS, WhatsApp, Telegram, Signal and others built from MessagingStyle notifications, with reply via RemoteInput. One inbox on PC | P1 🟢 |+| Contacts (photos, search, favorites), start a conversation or call from PC | P1 🟢 |+| Drag an image from the desktop into a thread to send it as MMS | P1 |++### 3.4 Calls+| Feature | Tier |+|---|---|+| Incoming call alert on PC with caller photo; answer / decline / silence (audio stays on phone) | P0 🟢 |+| Call log, dialer, call from contacts | P1 🟢 |+| **Call audio on PC via Bluetooth HFP** (PC mic/speakers) | P1 (after spike) |+| Auto-pause PC media during calls | P1 |++### 3.5 Clipboard+| Feature | Tier |+|---|---|+| Text + images + rich text, bidirectional, auto | P0 (PC→phone 🟢, phone→PC auto 🟣) |+| Fallbacks without Elevated: "Send clipboard" QS tile, share target, notification button | P0 🟢 |+| Clipboard history (both devices, local, encrypted), pin items | P1 |+| **Smart clipboard (context chips)**: copy an address → "Open in Maps"; a phone number → "Call"; a tracking code → "Track"; a link → "Open on phone"; an OTP → "Paste on PC" | P1 |+| Respect password managers' "exclude from clipboard history" flags on both sides; never sync sensitive clips | P0 |+| Copy files on PC → paste on phone (and the reverse) | P2 |++### 3.6 Files & photos+| Feature | Tier |+|---|---|+| Send files/folders both ways: drag-drop, share sheet, Explorer **"Send to phone"** context menu, Windows share sheet | P0 |+| Fast, resumable, multi-stream transfers with progress, pause/resume, and integrity hashing | P0 |+| **Flick to send**: flick a photo/file upward on the phone and it lands on the PC. Drag a file to the screen edge on the PC and it flies to the phone. Physics-based animation on both ends | P1 |+| **LocalSend protocol interop**: send to and receive from any LocalSend device (iOS, Mac, Linux). We implement its open protocol in Rust; we don't reuse its (Dart) code | P1 |+| **Coexistence**: runs side by side with KDE Connect (ports 1714–1764) and LocalSend (53317) on the same PC without conflicts. If LocalSend's port is taken, Nectarlink still sends but leaves receiving to the LocalSend app | P0 |+| **Phone storage in Explorer** (Cloud Files API: placeholders, on-demand download, native sync icons) | P1 |+| **Photos**: gallery with thumbnails, recent screenshots/photos pop up on PC, drag out to the desktop | P0 (recent), P1 (gallery) |+| Folder sync (Syncthing-style two-way folders, e.g. Camera → PC) | P2 |++### 3.7 Screen mirroring & phone apps on PC+| Feature | Tier |+|---|---|+| Mirror and control the full phone screen. **Hardware decode**, ≤50 ms on LAN, 1080p60+, H.264/H.265/AV1 | P0 (Standard 🟢 view / 🔵 control, Elevated 🟣) |+| **Built-in**. Nothing to download and no scrcpy path to configure | P0 |+| **Audio forwarding** (phone audio plays on PC) | P1 🟣 (or 🟢 via playback capture) |+| **App windows**: launch a phone app as its own resizable PC window with taskbar icon (virtual display, flex resize). App list and pinning | P1 🟣 |+| Keyboard (physical layout via UHID), mouse, scroll, gamepad, IME text, copy/paste inside the mirror, drag files in to send | P1 |+| Screen off while mirroring, keep awake, record, screenshot | P1 |+| Recent apps / notifications open directly into an app window | P1 |++### 3.8 Media & audio+| Feature | Tier |+|---|---|+| Control phone media from PC. Phone media appears **in Windows' own media flyout** with artwork | P0 🟢 |+| Control PC media from phone (media notification with artwork, seek, volume) | P0 🟢 |+| PC volume and output device switch from phone | P1 |+| **Voice Recorder → PC**: record with the phone's (better) mic, hit send, and the file lands on the PC in your chosen format (Opus/M4A/MP3/WAV/FLAC) and folder. Optional: record *straight into* the PC (live stream, appears when you stop), noise suppression, markers | P1 🟢 |+| Phone as speaker / headphones for PC audio | P2 |+| Phone as live microphone for PC apps | P2 (needs a virtual audio driver, evaluate) |++### 3.9 Camera+| Feature | Tier |+|---|---|+| **Phone as webcam** (Windows 11 virtual camera, shows up in Teams/Zoom/OBS/Camera app). Front/back, zoom, torch, HDR, 1080p/4K | P1 🟢 (CameraX) |+| **Continuity Camera**: right-click in any PC app → "Take photo / Scan document with phone" → the phone opens the camera (with document edge detection) → the result is pasted at the cursor | P1 🟢 |++### 3.10 Remote input & control+| Feature | Tier |+|---|---|+| Phone as **touchpad + keyboard** for PC, presentation remote (with laser pointer) | P1 🟢 |+| **Air mouse**: point the phone and its gyroscope moves the PC cursor, for presentations and couch use | P1 🟢 |+| **Voice typing into PC**: hold a button on the phone, speak, and the text (from the phone's own speech engine) is typed into the PC's focused field | P1 🟢 |+| Type on the phone with the PC keyboard (without mirroring) | P1 🟣 |+| **Deck**: the phone becomes a Stream-Deck-style macro pad for the PC with live tiles: mic mute, media, app launchers, scripts, OBS scenes, window switching, multiple pages, haptic feedback | P1 🟢 |+| **Flow**: move the PC mouse off the screen edge onto the phone/tablet and back, with clipboard following | P2 🟣 |+| Phone toggles from PC: Wi-Fi, BT, DND, ringer, flashlight, brightness | P1 (partly 🟣) |+| PC actions from phone: lock, sleep, shutdown, mute, custom commands/scripts | P0 (lock/sleep), P1 (custom, off by default) |+| Wake-on-LAN | P1 |+| **Unlock PC with phone fingerprint**: the PC lock screen offers "Unlock with phone" → the phone shows a biometric prompt → a signed challenge unlocks Windows. Built as a Windows credential provider. Keys live in Android Keystore (StrongBox where available) and are bound to biometrics. Works only when paired and nearby (BLE proximity + LAN). Rate-limited, revocable, and **external security review before release** | P2 (dedicated workstream) |++### 3.11 Ambient & signature experiences (what makes Nectarlink special)+| Feature | Tier |+|---|---|+| **Nectar Island** (optional extra, off by default): a small, animated pill at the top of the PC screen showing live phone activity (call, timer, music, transfer, Live Update, OTP, voice recording). Expands on hover. A nice touch, not a pillar | P2 |+| **Shelf**: slide-out edge panel with the latest photo, screenshot, clipboard and recent files. Drag anything in to send | P1 |+| **Command Palette** (global hotkey): "send clipboard", "find my phone", "text Mom", "open last photo", "mirror Spotify", "record voice" | P1 |+| **Material You sync**: the PC app takes its accent and theme from the phone's wallpaper colors, so both apps look like one | P1 |+| **Handoff**: send a link, map location, document or YouTube timestamp to open on the other device | P0 (links), P1 (rich) |+| **"Ping me when it's done"**: right-click a download, a running process, a build or a render → get a phone notification (as an Android Live Update with progress) when it finishes or fails. Also `nectarlink notify-when <pid>` and a CLI hook for scripts | P1 |+| **Timeline**: one searchable history of everything that moved between devices (files, clips, links, photos, recordings), with "send again" | P1 |+| **Your PC in your pocket**: from anywhere (Away mode), browse and grab PC files, see what the PC is doing (Ping-me tasks, downloads), wake it (relayed Wake-on-LAN through another Nectarlink device left at home), and later view/control the PC screen (reverse mirroring) | P2 (files/status in P1 if Away mode lands early) |+| **Proximity lock**: lock the PC when the phone walks away (BLE RSSI) | P2 |+| **Automations**: triggers (connected, battery low, call started) → actions | P2 |+| Find my phone (ring even on silent), battery & signal in tray, low-battery alerts | P0 |++### 3.12 Platform & ecosystem+| Feature | Tier |+|---|---|+| Tray app, start on login, jump list, global hotkeys, Windows Widgets board widget | P0/P1 |+| Android Quick Settings tiles, home-screen widgets (Glance), share target, Direct Share to PC | P0/P1 |+| **CLI** (`nectarlink send file.pdf`, `nectarlink clip`, `nectarlink notify`, `nectarlink notify-when`) and local authenticated API for scripts and PowerToys Command Palette | P1 |+| Tablet as second screen (IddCx virtual monitor) | P2 |+| macOS desktop build | P2 (future scope) |+| Plugin/extension API over the open protocol | P2 |+| Full i18n, accessibility (screen readers, keyboard nav, contrast), reduced motion | P1 |++### 3.13 Rejected for now (parked, can be revived later)+| Idea | Why parked |+|---|---|+| **Smart notification routing** (phone silent while you're active on PC, buzz when idle) | Not prioritized by the maintainer. Depends on presence heuristics that are easy to get wrong |+| **Desk Mode** (phone goes quiet + ambient dock screen when charging at desk, PC locks when you leave) | Not prioritized. Overlaps partly with Proximity lock |+| **Instant Hotspot** (one click: phone hotspot on + PC joins) | Not prioritized. Needs Elevated plus per-OEM hotspot quirks |+| **"Catch me up"** (on-device AI summary of missed notifications) | Not prioritized. Depends on local-AI availability (Copilot+ PCs / phone models) |++---++## 4. Architecture++### 4.1 Big picture++```+┌──────────────────────── Windows PC (one native process) ──┐ ┌───────────────────────── Android phone ─────────────────────────┐+│ Qt Quick UI (QML screens, Nectarlink design system) │ │ Compose UI (Material 3 Expressive) │+│ main window · Island · Shelf · Deck editor · palette │ │ home · devices · onboarding · Deck · tiles · widgets │+│ mirror/app windows: decoded D3D11 video inside the UI │ │ ▲ Kotlin facades (Flows) │+│ ▲ nectarlink-qt bridge (cxx-qt view-models, in-proc) │ │ ┌─────┴───────────────────────────────────────────────────┐ │+│ ┌─────┴──────────────────────────────────────────────┐ │ │ │ Android services (Kotlin) │ │+│ │ nectarlink-desktop (Rust) │ │ │ │ NotificationListener · SMS/Calls/Contacts · MediaSession│ │+│ │ nectarlink-win: toasts+reply · Cloud Files · GSMTC/ │ │ │ │ CameraX · AudioRecord · MediaProjection · CDM · FGS │ │+│ │ SMTC · clipboard · share · context menu · BLE · │ │ │ └─────┬───────────────────────────────────────────────────┘ │+│ │ MF decode/D3D11 · vcam (COM DLL) · HFP · cred. │ │ │ │ UniFFI │+│ │ provider · firewall · tray · hotkeys │ │ │ ┌─────┴──────────────────────────────────────────────────┐ │+│ └─────┬──────────────────────────────────────────────┘ │ QUIC │ │ nectarlink-core (same crate, compiled for arm64/x86_64) │ │+│ ┌─────┴──────────────────────────────────────────────┐ │◄──────►│ └─────────────────────────────────────────────────────────┘ │+│ │ nectarlink-core (Rust, shared) │ │ iroh │ ┌─────────────────────────────────────────────────────────┐ │+│ │ identity · pairing · sessions · capabilities │ │ │ │ Elevated mode (Nectarlink's own code as shell uid) │ │+│ │ services · transfer engine · store (SQLite) │ │ │ │ clipboard · appops · screen capture · input injection │ │+│ └────────────────────────────────────────────────────┘ │ │ │ virtual displays · toggles · scrcpy-server engine │ │+│ nectarlink-adb (built-in ADB client) ─ USB / wireless dbg ───┼────────┼─►│ │ │+└────────────────────────────────────────────────────────────┘ └──┴─────────────────────────────────────────────────────────┴─────┘+```++The desktop is **one native process**: Rust owns the core, networking and OS integration, and Qt Quick draws the UI. Heavy windows (main, mirror, app windows) are created on demand and destroyed when closed. The always-on part (core + tray + toasts + Island) stays small.++### 4.2 Repository layout (monorepo)+```+nectarlink/+ core/ Rust workspace+ nectarlink-core/ engine: identity, pairing, session, capabilities, services, transfer, store+ nectarlink-protocol/ message types + versioning (CBOR); spec generated into docs/protocol+ nectarlink-localsend/ LocalSend v2 interop (HTTP(S) server + multicast discovery)+ nectarlink-adb/ pure-Rust ADB client (USB + wireless pairing via SPAKE2/TLS)+ nectarlink-ffi/ UniFFI bindings for Kotlin+ nectarlink-cli/ command-line client+ desktop/+ app/ Rust host: startup, tray, window lifecycle, wiring to core+ nectarlink-qt/ the ONLY Rust↔Qt bridge: cxx-qt view-models exposed to QML+ qml/ Nectarlink design system (tokens, ~30 components) + screens. Presentation only+ platform/ `Platform` trait: nectarlink-win (windows-rs) now, nectarlink-mac later+ video/ `VideoSink`: MF decode + D3D11 texture → Qt Quick scene-graph item (small C++)+ now; VideoToolbox + Metal later+ vcam/ virtual camera media source (COM DLL)+ credprov/ credential provider for "Unlock with phone" (P2, isolated, audited)+ android/+ app/ Compose app (flavor `full` now; `play` seam kept)+ elevated/ privileged-mode entry point (dex launched with app_process)+ mirror/ encoders, scrcpy-server engine integration+ relay/ deployable iroh relay config (self-hosting docs)+ docs/ protocol spec, design system, ADRs, contributor guide+```++### 4.3 Identity, pairing, security+- **Identity:** each install has an Ed25519 key (the iroh endpoint ID). Private keys live in DPAPI-protected storage on Windows and Android Keystore-wrapped storage on the phone.+- **Trust = pinned public key.** No CA, no server. Unpaired peers can only reach the pairing handshake.+- **Pairing flows**+ - *QR:* the PC shows a QR with `{endpoint id, LAN addresses, 128-bit one-time secret, name}`. The phone scans, dials, and proves the secret. This gives mutual authentication with no codes to compare.+ - *Nearby:* pick the device from a discovered list, then both screens show a 6-digit SAS derived from the handshake transcript. Tap "matches".+ - *USB:* if USB debugging is on, the PC exchanges keys over ADB automatically.+- **Encryption:** QUIC + TLS 1.3 (raw public keys), always. Relays only forward ciphertext.+- **Per-device permissions:** each paired device has feature toggles. Dangerous ones (run commands, remote input into PC, file browse, PC unlock) are **off by default**.+- **Local API/CLI:** a named pipe with a per-user token. No open localhost TCP port.+- **At-rest:** message and notification caches are encrypted with a device key, with an auto-purge window (default 7 days for notifications).+- Security audit before 1.0. Fuzz the protocol decoder and pairing handshake. The credential provider gets its own threat model and review.++### 4.4 Connectivity: "it just works"+Order of attempts (iroh races paths and keeps the best one; multipath lets two paths coexist):+1. **LAN direct:** mDNS address lookup + last-known addresses + a tiny UDP beacon fallback for networks that filter mDNS.+2. **USB:** when ADB is available, a forwarded path (iroh custom transport, currently `unstable-custom-transports`; fallback is a TCP-framed tunnel). It also works with no network at all.+3. **Away:** hole punching, then relay. **Opt-in** ("Reach my phone away from home"). Default relays at first, with a one-click self-hosted relay option. A Nectarlink-operated relay pool is possible later if donations allow.+4. **Bluetooth** (P2): low-bandwidth link for notifications, SMS and calls.++**Staying connected:**+- Android: foreground service (`connectedDevice`), CDM association (exempts us from many background limits and lets the OS wake us on BLE presence), battery-optimization exemption request, and OEM-specific guidance (dontkillmyapp data).+- Windows: resume on `PBT_APMRESUMEAUTOMATIC`, network-change listener, BLE advertising so the phone's CDM sees the PC.+- Heartbeats with adaptive interval, instant reconnect on network change, exponential backoff, and a visible "connection health" indicator.++**Connection Doctor** checks and fixes: firewall rule (the installer adds it, Doctor repairs it), network profile Public→Private prompt, AP isolation (detected when the relay path works but the LAN path doesn't), VPN split tunnelling, phone battery mode, restricted settings, and Power Level status.++### 4.5 Protocol+- One QUIC connection per device pair.+- **Control stream:** `Hello` (versions, capabilities, power level, device info), then the event bus (battery, notification posted/removed, clipboard, media state…).+- **Per-operation streams:** each RPC, file transfer, thumbnail fetch, voice recording or mirror session opens its own bidirectional stream with a typed header. There's no head-of-line blocking, so a 4 GB transfer never delays a notification.+- **Datagrams:** pointer/touchpad/air-mouse motion and other latency-critical, loss-tolerant input.+- **Versioning:** capability flags, unknown fields ignored, unknown message types answered with `Unsupported`. A newer phone always works with an older PC (minus new features).+- **Transfers:** chunked, content-hashed (BLAKE3), resumable by offset, parallel streams for many small files, zero-copy reads where possible.++### 4.6 Power Levels (one APK, no extra apps)+Everything ships inside the single Nectarlink APK. "Elevated" is **not a separate app**: it's a mode where Nectarlink launches a copy of its *own* code (via `app_process`) with `shell`-user privileges. That process talks back to the app over a local socket with strict caller checks (our UID + signing certificate). Shizuku is only **one optional path** for people who already have it.++| Level | How you get it | Effort | Lasts | Adds (on top of the level above) |+|---|---|---|---|---|+| **🟢 Basic** | Install + grant normal permissions | ~1 min | Forever | Notifications (non-sensitive), SMS/MMS, calls, contacts, files, photos, media both ways, PC→phone clipboard, webcam, Continuity Camera, voice recorder, voice typing, touchpad/air mouse/Deck, standard mirroring (consent prompt each session, view-only) |+| **🔵 Assist** | Turn on Nectarlink's Accessibility service (one toggle, plus the "restricted settings" step for sideloaded installs) | ~1 min | Forever | Control the phone during standard mirroring, global actions (back/home/recents/lock) |+| **🟣 Elevated** | Any one of the setup paths below | 1–3 min | Until phone reboot (auto re-arms) | **Auto** phone→PC clipboard, OTP/sensitive notifications, prompt-free mirroring with full control, phone audio to PC, **app windows**, type into the phone with the PC keyboard, Wi-Fi/BT/DND toggles from PC, install APKs from PC, self-whitelist from battery killers |+| **🔴 Root** | Magisk / KernelSU / APatch detected | Instant | Forever | Elevated features survive reboots with no re-arm, plus deeper system toggles |++**Setup paths to Elevated** (Nectarlink recommends the best one by detecting Android version, USB state, root and Shizuku):+1. **USB cable:** guided "enable USB debugging" (animated, per-OEM steps), then plug in. The PC app has a **built-in ADB client**, so there's nothing else to install. This also turns on the USB connection path.+2. **Wireless, using the PC's QR** (Android 11+): the PC shows an ADB-pairing QR, and the phone scans it in *Developer options → Wireless debugging → Pair with QR code*. No cable.+3. **Phone only** (Android 11+): Nectarlink opens Wireless debugging, the user types the pairing code into a Nectarlink notification, and Nectarlink pairs with itself. No PC needed.+4. **Shizuku / Sui:** one tap if already installed. Never required.+5. **Root:** auto-detected.++**Re-arming after a reboot (keeping it painless):**+- If the PC is paired for wireless debugging, the PC silently re-arms the phone the next time both are on the same network.+- On Android 13+, Nectarlink grants itself `WRITE_SECURE_SETTINGS` during the first Elevated session. After that it can switch wireless debugging back on by itself on trusted Wi-Fi, on devices where the OEM allows it.+- Otherwise it shows a single quiet notification: "Tap to restore superpowers".++**Capability-driven UI** (the same rules on both apps):+- Every feature declares its requirements: power level, Android version, Windows add-on, permission, connection path.+- The core computes a **capability matrix per paired device**, and both UIs render from it, so they never disagree.+- Each feature has one of four states:+ - **Available**+ - **Partial:** works with an inline limit, e.g. "Manual: tap to send · Auto needs Elevated"+ - **Locked:** greyed, with a chip showing the level and effort, e.g. "Elevated · ~2 min"+ - **Unsupported:** explained, e.g. "Needs Android 11+"+- Tapping anything locked opens *that exact* setup sheet, then drops you back into the feature, now working.+- **Onboarding: "Choose your power"** (after pairing). Cards for Basic / Elevated / Root, each showing what it unlocks, what you need, how long it takes, how to undo it, and a plain-language "what this access means" explainer. A smart default is pre-selected, and "Decide later" is always available.+- **Settings → Power:** current level, how it was obtained, re-arm status, and a one-tap **Revoke**.+- **Settings → Connections** (separate axis): Wi-Fi/LAN, USB, Away (relay), Bluetooth. Each shows live status, or a greyed state with "Set up".+- **PC add-ons** use the same pattern on Windows: Virtual camera, Explorer integration, Bluetooth calling, Firewall rule, Unlock with phone. Each is opt-in with an explanation, and asks for admin only when it truly needs it.++### 4.7 Mirroring pipeline+- **Phone:** MediaCodec hardware encoder (H.265 → H.264 fallback, AV1 where hardware supports it), adaptive bitrate from QUIC congestion signals, intra-refresh to avoid big keyframes. The Elevated engine reuses scrcpy-server's capture/virtual-display/UHID code (Apache-2.0, credited), carried over **our** QUIC stream instead of an ADB socket.+- **PC (native, no WebView):** Media Foundation hardware decoder (DXVA) → D3D11 texture → wrapped directly as a texture in Qt Quick's scene graph (Qt renders with D3D11 on Windows, so both share the GPU device). Zero copies from decoder to screen. Controls, rounded app windows, overlays and transitions are ordinary QML on top of live video. If the scene-graph path ever adds latency, the fallback is a dedicated low-latency swapchain for the video surface. On Mac later: VideoToolbox → Metal behind the same `VideoSink`.+- **Input:** keyboard via UHID (correct layouts, shortcuts), mouse via UHID/inject, touch emulation, gamepad. Motion events go over datagrams.++### 4.8 Windows integration map+| Need | API |+|---|---|+| Toasts with images, actions, inline reply | Windows App Notifications + COM activator (AUMID) |+| Package identity (share target, Win11 context menu, HFP, toasts) | **Sparse package ("packaged with external location")** on top of the normal installer |+| Phone storage in Explorer | Cloud Files API (`cfapi`) sync root with placeholders |+| PC media → phone | `GlobalSystemMediaTransportControlsSessionManager` |+| Phone media → Windows media flyout | `SystemMediaTransportControls` |+| Clipboard | Clipboard listener, honoring `ExcludeClipboardContentFromMonitorProcessing` |+| Webcam | `MFCreateVirtualCamera` + custom media source |+| Calls | Bluetooth HFP via `PhoneLineTransportDevice` (spike) |+| Mirror video | Media Foundation decode → D3D11 texture shown in the Qt Quick scene graph |+| Voice typing / Deck / air mouse into PC | `SendInput` (Unicode text + mouse), virtual-key macros |+| Unlock with phone | Credential provider (`ICredentialProvider`) |+| "Ping me when done" | Process wait handles, BITS/download folder watchers, CLI hooks |+| Proximity / wake | `BluetoothLEAdvertisementPublisher` / watcher |+| Window materials | Mica / Mica Alt / Acrylic via `DwmSetWindowAttribute` (DWMWA_SYSTEMBACKDROP_TYPE) |+| Firewall, startup, tray, jump list, hotkeys | installer custom action, Run key / StartupTask, Shell_NotifyIcon, `ITaskbarList`, `RegisterHotKey` |+| Power events | `RegisterPowerSettingNotification`, network list manager |++### 4.9 Android integration map+| Need | API |+|---|---|+| Stay alive | FGS `connectedDevice`, CompanionDeviceManager + presence observing, battery exemption |+| Notifications | `NotificationListenerService` (+ RemoteInput replies, actions, MessagingStyle parsing) |+| SMS/MMS, call log, contacts | Telephony & Contacts providers |+| Calls | `TelephonyCallback`, `TelecomManager.acceptRingingCall/endCall` |+| Media | `MediaSessionManager.getActiveSessions`, our own `MediaSession` for PC media |+| Voice recorder | `AudioRecord` / MediaCodec (Opus/AAC), with format conversion in the Rust core on PC for MP3/WAV/FLAC |+| Voice typing | `SpeechRecognizer` (on-device where available) |+| Air mouse | Rotation-vector / gyroscope sensors |+| Unlock PC | `BiometricPrompt` + Keystore keys (StrongBox) bound to user authentication |+| Photos/files | MediaStore, SAF, `MANAGE_EXTERNAL_STORAGE` |+| Camera / Continuity Camera | CameraX → MediaCodec, ML Kit document scanner (or open-source edge detection) |+| Mirror (standard) | MediaProjection, AccessibilityService input |+| Surfaces | QS tiles, Glance widgets, share target, Direct Share, App Shortcuts |++### 4.10 Performance & quality budgets+| Metric | Target |+|---|---|+| PC cold start → window | < 500 ms (QML pre-compiled at build time) |+| PC RAM, tray + Island / main window open | **< 60 MB / < 120 MB** (+5–15 MB per extra window) |+| PC idle CPU | ~0 % |+| Phone battery while connected and idle | < 2 % per day |+| Notification latency (LAN) | < 300 ms |+| Mirror glass-to-glass (LAN, 1080p60) | < 50 ms |+| File transfer | ≥ 80 % of link speed |+| Reconnect after PC wake | < 3 s |+| UI | 60 fps minimum, 120 fps on capable displays, no frame > 8 ms of UI work during animations |++---++## 5. Tech stack: reasoning and trade-offs++What we optimize for, in order:+1. Reliability of the connection+2. Design ceiling and smoothness+3. **Low resource use** (the maintainer's hard requirement: no RAM-hungry web stack)+4. Depth of OS integration on both sides+5. One shared engine+6. A path to macOS later++### 5.1 Desktop UI framework: decision record++**Decision: Qt Quick (QML) for the UI, Rust for everything else.** Fallback: web UI (Tauri) with native Rust video windows.++#### Final three, scored (1–5, weighted for Nectarlink; RAM/size/start figures are estimates to verify in Phase 0)+| Criterion | Weight | A. Web (Tauri 2 + React) | **B. Qt Quick + Rust** ✅ | C. Slint |+|---|---|---|---|---|+| Visual ceiling (blur, glass, effects, type) | 15 | 5 | **5** (real blur, shaders, particles) | 3 (no in-app blur/shaders yet) |+| Smoothness under load | 10 | 4 (busy JavaScript can stutter) | **5** (animations on a render thread) | 4 |+| RAM / idle CPU | 10 | 2 (~120–200 MB with a window, +30–60 MB per window) | **4** (~50–60 MB tray + Island, ~80–120 MB with a window) | 5 (~15–60 MB) |+| Startup + install size | 5 | 4 (~8–15 MB, 0.5–1 s) | **3** (~35–60 MB, 0.3–0.6 s) | 5 |+| Mirroring & app windows | 15 | 3 (extra frame copy, a web process per window) | **5** (video inside the UI, no copies, cheap windows) | 3 (separate surface beside the UI) |+| Always-on windows (Island, Shelf) | 5 | 2 | **5** | 5 |+| Windows integration & native feel | 5 | 4 | **4** | 4 |+| Accessibility | 5 | 5 | **4** | 3 |+| Development speed (incl. how accurately Claude writes it) | 10 | 5 | **3** | 3 |+| Build / CI simplicity | 5 | 4 | **2** | 5 |+| Ecosystem & contributors | 5 | 5 | **3** | 2 |+| Maturity / long-term risk | 5 | 4 | **3** (cxx-qt is pre-1.0) | 3 |+| Fit with the Rust core | 3 | 4 | **3** | 5 |+| Mac later | 2 | 4 | **4** | 4 |+| **Weighted total / 100** | | **≈ 78** | **≈ 81** | **≈ 74** |++**Why B wins (narrowly):** Nectarlink is *always running*, *video-heavy* (mirroring plus one window per phone app) and has *always-on overlays* (Island, Shelf). Those are exactly the web stack's weakest points and Qt's strongest, and Qt gives up nothing on looks. If development speed were weighted above ~20 %, web would win, which is why it is the fallback.++**Rejected outright:** Flutter (maintainer's call; multi-window still experimental), Electron (RAM), WinUI 3 (Windows-only), Compose Multiplatform (JVM RAM), Avalonia (C# bridge), GPUI (development slowed in 2026), iced/egui (not built for this).++#### Known issues with B, and the rules that contain them+| Issue | Rule / mitigation |+|---|---|+| Three languages in the UI layer (QML, Rust, a little C++) | **QML is presentation only**: screens, layout and animation. No business logic in QML/JavaScript. C++ is limited to the video item and a few window tweaks |+| cxx-qt is pre-1.0 (0.9.x, KDAB) | Pin the version, upgrade on purpose. **One bridge crate (`nectarlink-qt`)** is the only place Rust touches Qt |+| Heavier build (Qt install, C++ glue, separate ARM64 build) | Install Qt via aqtinstall, cached in CI. Windows ARM64 is a supported Qt platform (MSVC 2022). Scripts make it one command locally |+| Two threading worlds (Rust async runtime vs Qt's screen thread) | **One pattern everywhere** for handing core events to the screen thread (cxx-qt's thread queue). No ad-hoc cross-thread calls |+| Bigger installer (+30–50 MB) | Ship only the Qt modules we use. `windeployqt` with an explicit module list |+| Startup cost of QML | Pre-compile QML to bytecode at build time (`qmlcachegen`, LGPL) |+| Mica on a Qt window | Direct DWM calls on the native window handle, plus a transparent QML root |+| **Qt licensing pitfalls** | Use only LGPL modules (Core, Gui, Qml, Quick, Quick Controls, Quick Effects/MultiEffect, Quick Shapes, Svg, Multimedia). **Avoid GPL-only modules:** Qt Qml Compiler (`qmlsc`), Lottie, Quick Timeline, Graphs, Quick 3D, Virtual Keyboard, Canvas Painter. They'd conflict with the future app-store exception. Dynamic linking satisfies LGPL relinking |+| Qt LTS patch releases become **commercial-only** after their first period | Track the **latest Qt 6 minor release** (currently 6.12), pinned per Nectarlink release, instead of relying on LTS patches |+| Qt's long-term openness | Guaranteed by the KDE Free Qt Foundation agreement: if open-source releases ever stop, Qt becomes BSD-licensed |++#### Risk gate (Phase 0): "Qt + Rust proof"+Build Home, a notification card, the Deck grid, one hero transition and a live mirrored-video window from the approved mockups.+- **Pass:** it matches the mockups, holds 120 fps on a mid-range laptop, meets the §4.10 RAM and startup budgets, shows video inside the UI without copies, Mica works, core→UI updates survive a stress test, and CI builds x64 + ARM64 installers.+- **Fail:** switch to **A: web UI (Tauri) with native Rust video windows** (mirroring and app windows as pure D3D11 windows, which removes web's worst weakness). The core, protocol, Windows integrations and video path don't change.++### 5.2 Android+| Option | Verdict |+|---|---|+| **Kotlin + Jetpack Compose + Material 3 Expressive** ✅ | Native (no web). Every system API is first-class: notification listener, telephony, Companion Device Manager, MediaProjection, CameraX, Glance widgets, Quick Settings tiles. M3 Expressive gives shape morphing and spring motion out of the box. Best performance and battery |+| Flutter / React Native | Rejected. Every key feature would be a hand-written native plugin anyway. You pay for two stacks and get worse background-service behavior |+| Compose Multiplatform | Only pays off if the desktop were also Kotlin (rejected: JVM RAM) |++### 5.3 Shared core language+| Option | Pros | Cons | Verdict |+|---|---|---|---|+| **Rust** ✅ | Fast, no GC pauses (matters for video and transfers), memory-safe network parsing, runs on Windows/Android/macOS/iOS, iroh is native Rust | Slower compile times, steeper learning curve, UniFFI layer on Android, +5–8 MB per ABI in the APK (we ship arm64 mainly) | **Chosen** |+| Go (gomobile) | Simple | gomobile is stagnant, GC, large binaries, weak FFI story | ✗ |+| Kotlin Multiplatform | Native on Android | Desktop isn't Kotlin | ✗ |+| C++ | Universal | Memory-safety risk in exactly the code that parses untrusted network input | ✗ |+| No shared core (two implementations) | Simpler builds | KDE Connect's lesson: two implementations drift and cause interop bugs | ✗ |++### 5.4 Transport+| Option | Pros | Cons | Verdict |+|---|---|---|---|+| **iroh (QUIC)** ✅ | Dial by key, E2E by default, LAN discovery, ~90 % hole-punch success, relay fallback over HTTPS (works even where UDP is blocked), multipath, many streams per connection. MIT/Apache, stable 1.x | Young (1.0 in June 2026). Away mode depends on relays | **Chosen**, behind our own `Connection` trait so it's swappable |+| Hand-rolled TCP + TLS (KDE Connect, Sefirah) | Full control | We'd re-implement discovery, NAT traversal and multiplexing, which is exactly where competitors break | ✗ |+| HTTP/REST (LocalSend) | Simple, debuggable | One request per action, no push, no NAT traversal | Implemented **only** for LocalSend interop |+| WebRTC | NAT traversal + media pipeline | Huge dependency (libwebrtc), needs a signaling server, hard to debug | ✗ |+| libp2p | Feature-rich | Heavier and more complex than we need | ✗ |++### 5.5 Smaller choices+| Choice | Picked | Alternative | Why |+|---|---|---|---|+| Wire format | CBOR (serde) | Protobuf | No codegen toolchain, self-describing, forward-compatible. A versioned spec still lets others implement it |+| Local storage | SQLite (in core) | Room / per-platform DBs | One schema, one migration path, shared by both apps |+| Hashing | BLAKE3 | SHA-256 | Much faster for large files, built for streaming and verification |+| Desktop rendering | Qt Quick scene graph via RHI (Direct3D 11 on Windows, Metal on Mac) | OpenGL / software | Native GPU APIs, and our decoded video shares the same D3D11 device |+| Audio formats (voice recorder) | Opus/AAC on phone, transcode on PC in Rust (Symphonia decode + encoders) | Transcode on phone | Saves phone battery, PC is faster |+| Fonts | Bundled (Segoe UI Variable on Windows + one display face) | Downloaded at runtime | Works offline, no third-party requests |+| Mirroring engine | scrcpy-server (Elevated) + MediaProjection (Basic) | Write our own from scratch | scrcpy is the best in the world at this, and Apache-2.0. We add what it lacks (UX, pairing, transport) |++---++## 6. Design direction++**Feel:** calm, premium, alive. Think "Apple Continuity polish with Material You warmth". It should never look like a settings dump.++**Shared language across both apps**+- Same iconography, the same names for features, and the same power-level badges (🟢🔵🟣🔴 mapped to a refined palette).+- **Dynamic color:** default warm honey/amber accent (on brand for Nectarlink). Once paired, both apps can adopt the phone's Material You palette.+- Motion: spring-based (no linear easing), choreographed transitions (a notification card grows into the conversation view), honoring reduced motion.++**Desktop (Qt Quick)**+- Mica backdrop, layered surfaces, real in-app blur and glass (MultiEffect), subtle shader accents, Segoe UI Variable for body text plus a characterful display face for headings.+- Layout: slim left rail (device switcher at top) → **Home** with a live "phone hero" (wallpaper, battery, signal, now playing, quick toggles), feature surfaces (Messages, Notifications, Photos, Files, Apps, Calls, Deck), and settings that read like explanations, not checkboxes.+- Keyboard-first: Ctrl+K palette in-app plus a global hotkey. Every action is reachable by keyboard.+- Ambient UI: Nectar Island, Shelf and tray flyout, so most interactions never open the main window.++**Phone (Compose)**+- Material 3 Expressive. A big tactile card for the connected PC (online state, laptop battery, quick actions: send clipboard, record voice, Deck, lock PC, mirror, touchpad).+- Onboarding is one live checklist where each permission shows its real state, why it's needed, and one tap to grant. Then "Choose your power".+- Predictive back, haptics, edge-to-edge, and adaptive layouts for tablets and foldables.++**Setup target (< 60 s):** install PC app → it shows a QR → install phone app → scan → checklist → done. No firewall dialogs (the installer handles it) and no ADB knowledge needed.++Phase 0 produces the design system doc + 2–3 visual directions + hi-fi mockups of Home, Onboarding, Choose-your-power, Messages, Mirror window, Island and Deck, before any UI code.++---++## 7. Distribution++**GitHub-first.** No Play account and no Microsoft Store for now.++- **Windows 11 only** (Windows 10 is dropped), x64 + **native ARM64** (Snapdragon laptops are a big Phone Link audience).+ - **Installer:** NSIS or WiX installer on GitHub Releases, which adds the firewall rule and registers the sparse-package identity.+ - **winget:** manifest pointing at the GitHub release (free).+ - **Auto-update:** signed update manifests, with delta updates where possible.+ - **Code signing:** see §10.6. Early alphas may ship unsigned, with an honest SmartScreen note.+- **Android:** the `full` flavor only.+ - **GitHub Releases APK** with a built-in updater that checks GitHub releases and installs through `PackageInstaller`.+ - **Obtainium**-friendly release naming. Recommended in docs, since session-based installs also reduce "restricted settings" friction.+ - **IzzyOnDroid** repo once builds are reproducible.+ - One signing key forever, enrolled in developer verification before global enforcement.+- **Later:** Microsoft Store (MSIX), Google Play (`play` flavor), Mac (needs an Apple Developer account for notarization).+- **Process:** reproducible builds where feasible, public CI (GitHub Actions is free for public repos, Windows and macOS runners included), signed release artifacts and readable changelogs.+- **Community:** build in public via the maintainer's existing X audience, run a tester program from that audience (no in-house test-device budget), and a public roadmap + changelog.++---++## 8. Roadmap++Each phase ends with a usable, releasable product. Phase sizes are relative; actual pace depends on contributors.++### Phase 0: Foundations+- Monorepo, CI, coding standards, ADRs, contribution guide, DCO, license files, trademark policy.+- Design system + 2–3 visual directions + mockups for both apps (sign-off before UI code).+- `nectarlink-core`: identity, iroh endpoint, pairing (QR + SAS), session/hello/capabilities, event bus, SQLite store.+- Desktop shell (tray, window, Mica, theming, onboarding with QR); Android shell (FGS, CDM, onboarding checklist, QR scanner).+- **Spikes (de-risk early):**+ - **Qt + Rust proof (§5.1 risk gate)**+ - Native mirror latency (MF + D3D11)+ - HFP calling on Win11 24H2/25H2+ - iroh on Android (battery + reconnect behavior)+ - iroh USB custom transport+ - Sparse package identity + toast inline reply+ - Phone-only wireless-debugging self-pairing and automatic re-arm (Android 11–16; Pixel/Samsung/Xiaomi)+- **Exit:** pair phone and PC by QR in under 60 s, see each other live (battery, name), survive PC sleep and Wi-Fi changes, and the Qt + Rust proof passed (or the web-UI fallback chosen).++### Phase 1: Daily Driver (public alpha, v0.1–0.3)+- Notifications (images, actions, replies, dismiss sync, filters, history).+- Clipboard (text/images; PC→phone auto; phone→PC via tile/share).+- Files both ways (drag-drop, share sheet, Explorer "Send to phone"), resumable transfers.+- Media control both ways (incl. Windows media flyout), battery/status, find my phone, lock/sleep PC, link handoff.+- Connection Doctor v1, auto-start, auto-update, crash-free reconnect.+- **Exit:** a KDE Connect / Phone Link-basics user can switch fully. Reliability green for 7 days across the tester group's phones (Pixel, Samsung, Xiaomi, OnePlus at minimum).++### Phase 2: Superpowers (beta, v0.4–0.6)+- **Power Levels** with all setup paths (USB, PC QR, phone-only self-pairing, Shizuku, root) + capability-driven greyed UI + re-arm → auto clipboard, OTP notifications.+- **Mirroring** (Standard + Elevated engines), audio, keyboard/mouse.+- **App windows** (virtual displays, taskbar icons).+- SMS/MMS + contacts. Calls (alerts, control, log; HFP audio if the spike passed).+- Recent photos + gallery. Phone storage in Explorer.+- Touchpad/keyboard/presentation remote, **air mouse**, **voice typing**, **voice recorder → PC**.+- **Exit:** replaces scrcpy and Sefirah for typical users, with no manual tooling.++### Phase 3: Magic (v0.7–0.9)+- Shelf, Command Palette, Material You sync, Smart OTP, Live Updates, **Timeline**.+- **Deck**, **Ping me when it's done**, **Continuity Camera**, **Smart clipboard chips**, **Flick to send**.+- Phone as webcam. Unified Conversations (chat apps).+- **Away mode** (relay, self-host guide) + first slice of **PC in your pocket** (files + status), CDM/BLE wake, USB transport.+- LocalSend interop, CLI + local API, phone toggles from PC, custom commands, Wake-on-LAN.+- **Exit:** feature superset of Phone Link + KDE Connect + LocalSend + scrcpy for Android↔Windows.++### Phase 4: 1.0 and beyond+- Security audit, fuzzing, accessibility audit, i18n (community translations), docs site.+- **1.0 release.**+- After 1.0:+ - **Unlock PC with phone fingerprint** (own workstream + external review)+ - PC in your pocket: reverse mirroring+ - Flow (cross-device mouse)+ - Nectar Island (optional), proximity lock, automations, folder sync+ - Tablet as second screen, phone as mic/speaker+ - Bluetooth fallback link+ - **macOS desktop**, plugin API++---++## 9. Risks & mitigations+| Risk | Mitigation |+|---|---|+| OEM battery killers break reliability | CDM association, FGS, BLE wake, per-OEM Doctor guides, opt-in local diagnostics export for testers |+| **Qt + Rust build or bridge proves painful** (cxx-qt pre-1.0, C++ glue, CI) | Phase 0 proof with explicit pass criteria. Single bridge crate, pinned versions. Fallback: web UI (Tauri) + native Rust video windows, with an unchanged core |+| Qt licensing / LTS changes | Only LGPL modules, track latest Qt 6 minor releases, KDE Free Qt Foundation guarantee |+| Developer verification limits sideloading | Verify identity before global enforcement. One signing key across channels |+| HFP API locked down by Microsoft | Early spike. Fallback: call control with audio on phone (still useful) |+| Credential provider ("Unlock with phone") is security-critical | Post-1.0, isolated module, threat model, external review, off by default, easy revoke |+| iroh relay cost/availability for away mode | Opt-in, self-host option, documented. Donation-funded relays later |+| Scope explosion | Strict phase exits. P2 and rejected features wait. Every feature needs a design + reliability check |+| Elevated mode seen as scary/abused | Transparent UI, open-source code, strict caller verification, revoke anytime |+| Upstream scrcpy changes | Pin a vendored version. Contribute fixes upstream |+| High-visibility launch (large X audience) exposes rough edges | Private tester waves first, public alpha only after Phase 1 exit criteria |++---++## 10. Decisions & open questions++### 10.1 Name: **Nectarlink** ✅+- Repo: `github.com/thtbee/nectarlink` (private until most things work locally; no pushing before that).+- Checks done: no conflicting products found on the web; `nectarlink.app`, `nectarlink.dev`, `getnectarlink.com` and the GitHub name were free (2026-10-05).+- **Still to do before any announcement:** official trademark searches (USPTO, TMview, IP India), register the domain, X handle, and reserve `nectar-link` as a redirect.+- History: "Hive" (folder codename) and "Waggle" were dropped. Hive collides with Centrica's smart-home brand; WAGGLE is a **registered, active US trademark** (Nimble Wireless, class 9, reg. 9 May 2023) that covers "software for transmission of voice, data, images, audio, and video between devices". Dozens of other candidates were checked and rejected (Honeylink, Tandem, Skein, Wingbeat, Murmur and others).++### 10.2 License ✅+| Part | License | Why |+|---|---|---|+| Desktop + Android apps | **GPL-3.0-or-later**, plus an *additional permission* (GPLv3 §7) allowing distribution via app stores with conflicting terms | Anyone who ships a modified app must publish the source, which stops closed, ad-stuffed rebrands. It's compatible with code from Sefirah (GPL-3.0) and KDE Connect (GPL-2.0-or-later) if we ever borrow, and with scrcpy (Apache-2.0) and Qt (LGPL-3.0, dynamically linked; GPL-only Qt modules avoided, see §5.1). The app-store permission keeps a future App Store (iPhone/Mac) release legally clean, and it only works if it's there from the very first commit |+| Core crates (`nectarlink-core`, protocol, adb, localsend) | **MPL-2.0** | File-level copyleft: improvements to *our files* must stay open, but anyone can link the core. That grows the ecosystem without letting someone fork it closed |+| Protocol spec + docs | **CC BY 4.0** | Anyone can implement the protocol |+| Name + logo | **Trademark policy** (like Firefox/Signal) | Forks are welcome but must rebrand |+| Contributions | **DCO** sign-off (no CLA) | Contributor-friendly, with a clear provenance trail |++### 10.3 Design direction (deferred to Phase 0)+We'll explore 2–3 visual directions before any UI code.++### 10.4 Windows ✅+**Windows 11 only**, x64 + ARM64.++### 10.5 Crash reporting ✅ (opt-in)+- Nothing is sent unless you say yes. After a crash, Nectarlink asks once and shows the exact redacted report (no notification text, message content, file names or keys).+- **v1 uses no server at all:** "Report on GitHub" opens a prefilled issue, and you attach the redacted bundle yourself.+- If volume grows: an opt-in, self-hosted GlitchTip (Sentry-compatible) server.+- Tooling: Rust minidumps (`crash-handler`) on desktop, ACRA with a consent dialog on Android.++### 10.6 Budget ✅ (GitHub-only, no Play account, no test phones)+| Item | Cost | Notes |+|---|---|---|+| Domain (site + docs on GitHub Pages) | ~$10–20 / yr | Hosting is free |+| CI | $0 | GitHub Actions is free for public repos |+| Windows code signing | **$0** (SignPath Foundation, free for eligible OSS) · or ~€30–100 / yr (Certum open-source cert) · or ~$10 / mo (Azure Artifact Signing, where individuals are eligible) | Unsigned is OK for early alphas, but SmartScreen will warn. Reputation builds over time |+| Android signing | $0 | Our own keystore. Back it up in two places |+| Android developer verification | Likely a small one-time fee (unconfirmed) | Needed before global enforcement (2027) for GitHub APKs to install normally |+| Relays for Away mode | $0 in alpha (public iroh relays) → ~$10–20 / mo for 2 small VPS regions | ~95 % of traffic goes direct, so relay bandwidth stays small. Self-hosting is documented |+| Test devices | $0 | Covered by the maintainer's tester community |+| Later: Apple Developer (Mac notarization) | $99 / yr | Only when the Mac build ships |+| **Total, year 1** | **Bare minimum ≈ $10–50 · Comfortable ≈ $250–450** | Funded via GitHub Sponsors / Open Collective once public |++### 10.7 Future scope (recorded)+- **macOS desktop:** the maintainer has a MacBook. A port, not a rewrite: the Rust core, the `nectarlink-qt` bridge and ~90 % of the QML screens are shared (Qt Quick renders with Metal on Mac). Mac-specific work sits behind `Platform`/`VideoSink`:++ | Feature | Windows | Mac |+ |---|---|---|+ | Mirrored video in the UI | Media Foundation + D3D11 | VideoToolbox + Metal (small Mac-only C++/Obj-C++ piece) |+ | Notifications | Windows toasts | UserNotifications (needs a signed app) |+ | Window glass | Mica | macOS vibrancy |+ | Tray | System tray | Menu-bar icon |+ | Nectar Island | Top-of-screen pill | Around the MacBook notch |+ | Phone storage in file manager | Explorer (Cloud Files) | Finder (File Provider extension) |+ | "Send to phone" right-click | Explorer context menu | Finder Share / Sync extension |+ | Phone as webcam | Windows 11 virtual camera | Camera Extension (approved once by the user) |+ | Unlock computer with phone | Credential provider | **Not portable** (no public equivalent) |+ | Call audio over Bluetooth | HFP (if spike passes) | **Unclear / likely not** (deprecated APIs); calls = alerts + controls |++ Needs the Apple Developer account ($99/yr) for signing and notarization, and universal builds (Apple Silicon + Intel) on GitHub's macOS runners.+- **iPhone:** later. Expect KDE Connect-style iOS limits (no notification mirroring, no SMS access).++---++## 11. Pre-flight checklist++### Must resolve before writing code+1. **Name clearance.** Trademark search for "Nectarlink" in software classes (9 and 42) in the US, EU and India, then secure the domain, GitHub org and X handle. Do this *before* teasing the name to the X audience, because renaming after a public announcement is costly.+2. **Signing-key custody.** The Android signing key is Nectarlink's permanent identity: lose it and every user has to uninstall to update, and developer verification is tied to it. Generate it once, keep two offline backups, and store it as a CI secret. The same applies to the auto-update signing key.+3. **Dev environment ✅ (done 2026-10-04)**:+ - Installed: Qt 6.12.0 (MSVC x64 + ARM64) in `C:\Qt`, Android NDK 30.0.16248370 + CMake 4.1.2, Android command-line tools, Rust targets (Android ×4, Windows ARM64), `cargo-ndk` 4.1.2.+ - Already present: Android platform 37, build-tools 36, platform-tools, Rust 1.99, MSVC Build Tools 2022, Node 24, Python 3.14.+ - Environment variables set: `JAVA_HOME` (Android Studio's JDK 25), `ANDROID_HOME`, `ANDROID_NDK_HOME`, `QMAKE`, plus PATH entries for the JDK, Qt, platform-tools and the Android CLI.+ - ✅ MSVC ARM64 compiler (installed by the maintainer).+4. **Repo files from the first commit.** License texts (including the app-store exception), DCO, SECURITY.md with private vulnerability reporting, CODE_OF_CONDUCT, CONTRIBUTING, trademark policy, issue templates.++### Decide during Phase 0+5. **Installer scope.** Recommended: **per-machine** (one UAC prompt at install), which lets the installer add the firewall rule and so avoids the #1 complaint in this category. Per-user installs need no admin, but Windows then shows an "allow network access" prompt that users often cancel.+6. **Antivirus false positives.** Input injection, a built-in ADB client, listening sockets and (later) a credential provider look suspicious to antivirus heuristics, especially in unsigned builds. Sign early (SignPath), submit builds to Microsoft's false-positive portal, and never use executable packers.+7. **Version skew.** Testers will run mismatched phone and PC versions. CI tests the current release against the previous two in both directions.+8. **Android target-SDK rules.** Foreground-service type requirements for `connectedDevice`, background-start limits, edge-to-edge enforcement, and Android 14+'s read-only rule for dynamically loaded code (Elevated mode loads its code straight from the installed APK, which satisfies it).+9. **Testing strategy.**+ - Protocol conformance and fuzzing in CI.+ - Network chaos tests (packet loss, Wi-Fi switching, sleep/wake).+ - Qt Quick Test and Compose UI tests.+ - Battery soak tests on testers' phones.+ - An opt-in diagnostics bundle, since there's no telemetry.+10. **Island etiquette.** Auto-hide during fullscreen games, videos and presentations and when Windows is in Do Not Disturb. Handle multiple monitors.+11. **Data retention defaults** for Timeline, clipboard history, notification history and message cache: size caps, auto-purge, and one "Clear everything" button.+12. **Accessibility and translations from day one.** All strings translatable (`qsTr`, Android resources), RTL layouts, screen-reader labels, keyboard focus order. Retrofitting is expensive.+13. **Asset licenses.** The display font under OFL, an icon set under a permissive license (e.g. Material Symbols, Apache-2.0). No Microsoft or Google logos; competitor names only in plain comparison wording.+14. **Realistic pacing.** Claude writes most of the code, but every phase needs maintainer review and tester feedback. Estimate phase durations after Phase 0 from real velocity, not before.++### Keep in mind+- Publish a short privacy page even though nothing is collected. Testers and press will ask.+- Gate public announcements behind phase exits, and run a tester sign-up from the X audience.++---++## 12. Next steps++| # | Step | Owner | Output |+|---|---|---|---|+| 1 | Name clearance + grab domain, GitHub org, X handle | Maintainer | "Nectarlink" cleared by official searches |+| 2 | Phase 0 detailed spec: protocol v0 (Hello, pairing, capabilities), `nectarlink-core` public API, capability-matrix schema, repo scaffolding plan, ADRs, spike test plans with pass criteria | Claude | `docs/` specs |+| 3 | Design foundations + 2–3 visual directions (both apps) | Claude → maintainer picks | Chosen direction, then hi-fi mockups |+| 4 | Dev environment setup (Qt 6.12, JDK, Android SDK/NDK, Rust targets) | Together | One-command build prerequisites |+| 5 | Create the repo (private until Phase 0 exit), license files, DCO, policies | Together | Repo skeleton |+| 6 | Generate signing keys with offline backups | Maintainer (guided) | Keys stored safely |+| 7 | Start Phase 0 coding: **Qt + Rust proof first** (it's the gate), core + pairing and the other spikes in parallel | Claude | Phase 0 exit criteria met |+| 8 | Tester sign-up (devices, Android versions, OEMs) | Maintainer | Tester list for Phase 1 |++Later: SignPath application (needs a public repo with history), Android developer verification (before 2027 global enforcement), relay servers (Phase 3), privacy page, phase duration estimates after Phase 0.++---++## Sources+- Sefirah: [Windows repo](https://github.com/shrimqy/Sefirah), [Android repo](https://github.com/shrimqy/Sefirah-Android), [releases](https://github.com/shrimqy/Sefirah/releases), [issues](https://github.com/shrimqy/Sefirah/issues), [Sefirah-old fork](https://github.com/AlexbeatsZ/Sefirah-old), [Android Police review](https://www.androidpolice.com/forget-phone-link-this-ad-free-open-source-app-beats-it-in-every-category/)+- Phone Link: [disconnect reports](https://learn.microsoft.com/en-us/answers/questions/5516264/problem-with-phone-link-constantly-disconnecting), [sensitive notifications complaint](https://learn.microsoft.com/en-us/answers/questions/5758796/microsoft-just-broke-phone-link-in-the-name-of-saf), [Android 15 change](https://www.windowscentral.com/software-apps/windows-11/microsoft-warns-that-android-15-will-make-windows-phone-link-worse), [expanded screen OEM list](https://www.windowslatest.com/2026/01/07/windows-11s-almost-full-screen-android-apps-mirroring-now-available-for-everyone-via-phone-link-app-with-supported-phones/), [recent features](https://www.makeuseof.com/windows-11-phone-link-is-better-than-ever/)+- KDE Connect: [Windows discovery/firewall guide](https://windowsforum.com/news/kde-connect-on-windows-pair-android-or-iphone-enable-remote-control-and-fix-discovery.446592/), [feature requests](https://discuss.kde.org/t/features-request-for-kde-connect/40288), [XDA alternatives + comments](https://www.xda-developers.com/forget-phone-link-use-these-5-apps-instead/)+- LocalSend: [protocol](https://github.com/localsend/protocol), [VPN discovery bug](https://github.com/localsend/localsend/issues/1598), [Windows discovery issues](https://windowsforum.com/news/fix-localsend-not-detecting-devices-on-windows-troubleshooting-guide.354562/)+- Intel Unison: [gHacks](https://www.ghacks.net/2025/07/04/intel-unison-is-dead-here-are-some-alternatives-you-can-switch-to/), [Wikipedia](https://en.wikipedia.org/wiki/Intel_Unison)+- scrcpy: [4.0 release notes](https://ubuntuhandbook.org/index.php/2026/05/scrcpy-4-0-resizable-virtual-display/), [3.3 UHID on virtual display](https://ubuntuhandbook.org/index.php/2025/06/scrcpy-3-3-added-uhid-mouse-to-android-virtual-display/)+- iroh: [1.0 coverage](https://www.techtimes.com/articles/318490/20260616/peer-peer-library-iroh-10-ships-dial-devices-key-not-ip-address.htm), [roadmap](https://www.iroh.computer/roadmap), [0.96 QUIC multipath](https://www.iroh.computer/blog/iroh-0-96-0-the-quic-multipaths-to-1-0)+- UI frameworks: [Qt licensing (GPL-only modules)](https://doc.qt.io/qt-6/licensing.html), [Qt supported platforms](https://doc.qt.io/qt-6/supported-platforms.html), [Qt for Windows on ARM](https://www.qt.io/blog/qt-for-windows-on-arm), [Commercial-only LTS patches](https://www.qt.io/blog/commercial-lts-qt-6.8.9-released), [CXX-Qt changelog](https://github.com/KDAB/cxx-qt/blob/main/CHANGELOG.md), [Caelestia shell (QML)](https://github.com/caelestia-dots/shell), [Slint 1.18](https://slint.dev/blog/slint-1.18-released), [Slint 1.16](https://slint.dev/blog/slint-1.16-released), [Slint changelog](https://github.com/slint-ui/slint/blob/master/CHANGELOG.md), [Slint backdrop-filter request](https://github.com/slint-ui/slint/issues/13502), [Flutter desktop → Canonical](https://www.omgubuntu.co.uk/2026/05/flutter-desktop-canonical-maintained), [Flutter multi-window status](https://startdebugging.net/2026/08/how-to-enable-multi-window-support-in-a-flutter-desktop-app/), [GPUI slowdown discussion](https://news.ycombinator.com/item?id=47003569)+- Android platform: [sensitive notifications / ADB appops](https://www.androidauthority.com/android-15-two-factor-authentication-codes-3492585/), [Android 14 MediaProjection consent](https://developer.android.com/about/versions/14/behavior-changes-14), [background clipboard block](https://www.xda-developers.com/android-q-blocks-background-clipboard-access/), [developer verification timeline](https://www.androidauthority.com/android-sideloading-changes-timeline-3679204/), [F-Droid 2.0](https://pinggy.io/blog/f_droid_2_0_android_developer_verification/)+- Windows platform: [PhoneLineTransportDevice](https://learn.microsoft.com/en-us/uwp/api/windows.applicationmodel.calls.phonelinetransportdevice), [22H2 breakage](https://github.com/BestOwl/MyPhone/issues/26), [virtual camera sample](https://github.com/smourier/VCamSample), [BestCam](https://github.com/OneLimeStudio/BestCam)+- Name check: [getwaggle.app (desktop app)](https://www.getwaggle.app/download), [Waggle pet app](https://play.google.com/store/apps/details?id=com.nimble.petsafety&hl=en_US), [nectarlink-sensor](https://github.com/nectarlink-sensor)+- Quick Share: [Windows update](https://www.androidauthority.com/quick-shares-windows-app-now-looks-a-little-more-like-an-android-app-3661953/)