mirror of
https://github.com/twinksoftware/Gearslip.git
synced 2026-11-11 00:12:24 +01:00
updated broken links
This commit is contained in:
1 parent
e1732f8365
commit
94f8f23a56
1 file changed
+32
-34
@@ -4,36 +4,33 @@
|
|||||||
|
|
||||||
Bring any app to your car screen.
|
Bring any app to your car screen.
|
||||||
|
|
||||||
## What this is
|
## What Gearslip is
|
||||||
|
|
||||||
Gearslip is a phone-side Android Auto client. It speaks the Android Auto protocol directly
|
Gearslip is an Android Auto client for the phone. It speaks the Android Auto protocol
|
||||||
to a car head unit over USB and acts as a **Car App Library host**: apps that ship an
|
directly to a car head unit over USB, with no Google software in the path. Gearslip acts
|
||||||
Android Auto car UI (navigation and media apps) hand Gearslip a template, and Gearslip
|
as a Car App Library host: an app that ships a car interface hands Gearslip a template,
|
||||||
renders it natively on the car screen, full quality, no phone-screen mirroring. A separate
|
and Gearslip renders that template natively on the car screen. Nothing is mirrored from
|
||||||
screen-sharing mode is included for apps that don't ship a car UI at all.
|
the phone. For apps without a car interface, Gearslip offers a separate screen-sharing
|
||||||
|
mode.
|
||||||
|
|
||||||
Built by reverse-engineering the protocol for interoperability - getting a non-Google client
|
The author reverse-engineered the protocol for interoperability, so that a client other
|
||||||
talking to a car head unit that only expects Google's own app.
|
than Google's own can talk to a car head unit.
|
||||||
|
|
||||||
## Status
|
## Status
|
||||||
|
|
||||||
Real progress, with one hard limit that's worth knowing before you build on this:
|
- **Templated apps work.** Gearslip renders all 16 template types that the Car App
|
||||||
|
Library defines, and it draws its own keyboard for search and sign-in. It has been
|
||||||
- **Templated app hosting works.** All 16 template types the Car App Library defines are
|
tested against several real navigation and media apps.
|
||||||
rendered, including a keyboard Gearslip draws itself for search and sign-in. Verified
|
- **Media playback works.** Gearslip lets you browse and control car-enabled media apps
|
||||||
against several real navigation and media apps.
|
from the car screen, with lyrics and playback state, over the same host connection.
|
||||||
- **Media playback works.** Car-enabled media apps are browsable and controllable from the
|
- **A real head unit needs a certificate that Google controls.** A head unit accepts only
|
||||||
car UI, with lyrics and playback state, over the same host connection.
|
a phone identity that chains to Google's Automotive Link certificate authority, and
|
||||||
- **The connection to a real head unit needs a certificate Google controls, and Gearslip
|
Google alone issues those certificates. Gearslip does not ship one. Without it,
|
||||||
doesn't ship one.** A head unit only accepts a phone identity that chains to Google's
|
Gearslip runs and renders correctly against a debug harness, but a real car rejects the
|
||||||
Automotive Link certificate authority - something only Google issues. Without one, Gearslip
|
connection. A leaked certificate exists that older head units accept; newer firmware
|
||||||
still runs and renders everything correctly against a debug harness, but a real car will
|
and Google's reference tooling reject it.
|
||||||
reject the connection outright. See [docs/SPIKE_FINDINGS.md](docs/SPIKE_FINDINGS.md) for what was
|
- **Gearslip needs no adb, root, or Shizuku.** Every feature relies on an ordinary
|
||||||
tested, including one publicly-known leaked certificate that works on some older head
|
Android permission or an on-device consent dialog.
|
||||||
units and is rejected by newer firmware and by Google's own reference tooling.
|
|
||||||
- **No adb, root, or Shizuku is required to run it.** Every feature is gated on an ordinary
|
|
||||||
Android permission or an on-device consent dialog - nothing needs privileged access, on
|
|
||||||
the phone or in the car.
|
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
|
|
||||||
@@ -43,16 +40,17 @@ Real progress, with one hard limit that's worth knowing before you build on this
|
|||||||
|
|
||||||
The APK lands at `build/Gearslip-debug.apk`.
|
The APK lands at `build/Gearslip-debug.apk`.
|
||||||
|
|
||||||
## Further reading
|
A release build needs a signing key. Copy `keystore.properties.example` to
|
||||||
|
`keystore.properties`, fill in your own values, and run
|
||||||
|
`./gradlew :gearslip:assembleRelease`. Git ignores both the properties file and the
|
||||||
|
keystore. Without them, the debug build still works.
|
||||||
|
|
||||||
- [docs/BUILDING_APPS.md](docs/BUILDING_APPS.md) - how to write apps Gearslip can render:
|
## Writing apps for Gearslip
|
||||||
templated apps, media apps, and the Gearslip app protocol.
|
|
||||||
- [docs/SPIKE_FINDINGS.md](docs/SPIKE_FINDINGS.md) - the certificate investigation in full: what was
|
[docs/BUILDING_APPS.md](docs/BUILDING_APPS.md) specifies how to write apps that Gearslip
|
||||||
tried, what a real head unit does and doesn't accept, and why.
|
can render: templated apps, media apps, and the Gearslip app protocol.
|
||||||
- [docs/CUSTOM_HEADUNIT_SCOPING.md](docs/CUSTOM_HEADUNIT_SCOPING.md) - the original scoping of what a
|
|
||||||
custom head unit client would need.
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
AGPL-3.0 - see [LICENSE](LICENSE). A separate commercial license is available for private
|
Gearslip is licensed under AGPL-3.0; see [LICENSE](LICENSE). The author offers a separate
|
||||||
use outside the AGPL's terms; see [NOTICE.md](NOTICE.md).
|
commercial license for private use outside the AGPL's terms; see [NOTICE.md](NOTICE.md).
|
||||||
Reference in new issue
Block a user