Portal

A home-screen launcher for Android TV and Google TV. It replaces the stock launcher with a clean home screen that has a live video background, the time and weather, your apps, per-person profiles, parental controls, a screen saver, and a search box that can find apps, chat with your own AI, and search the web.

Android 14 or newer (minSdk 34). Package com.portal.tv. Website: getportaltv.net. If Portal is useful to you, you can buy me a coffee.

Source-available, not open source. Portal is free for personal and other noncommercial use under the PolyForm Noncommercial License 1.0.0. Commercial use needs a separate license: write to [email protected]. If you share it, modified or not, keep the notices in NOTICE. See also CONTRIBUTING and third-party notices.

Quick install

You need adb (part of the Android SDK platform-tools) and a way to reach your TV. Turn on Developer options on the TV (Settings, Device Preferences, About, press Build several times), then enable USB debugging and network debugging.

From the TV itself

Once Portal is installed (for example from the release APK), its first-run setup can do the rest without a computer. It walks you through turning on Developer options and Wireless debugging, then connects to the TV's own debug service (the TV asks you once to allow it: choose Always allow) and does what the script below does: turns off the TV's own home screen, makes Portal the home app, allows alerts over other apps and voice search, and makes Portal the TV's screen saver in place of its ambient mode, so it also starts over other apps. You can turn Wireless debugging off afterwards. Settings, System, Restore the TV's own home screen undoes the launcher and screen saver changes. If your TV doesn't offer Wireless debugging (it needs Wi-Fi on some TVs), the setup falls back to asking for each permission, and the script below still does everything.

Basic TV mode: tested on a TCL Google TV (Android 14) that was factory reset and set up as a Basic TV instead of a Google TV. Developer options, Wireless debugging and installing Portal with adb all still worked, the setup above finished normally, and installing other apps and creating profiles worked afterwards. Other TVs may differ, so if Developer options or Wireless debugging is missing in Basic TV mode, switch the TV to Google TV mode, or use the script below from a computer.

One script

scripts/install.sh (macOS, Linux) and scripts/install.ps1 (Windows PowerShell) do every step below in one go: connect, install, make Portal the home screen, make Portal the TV's screen saver in place of its ambient mode, and start Portal. They are safe to run again.

scripts/install.sh 192.168.1.20

.\scripts\install.ps1 192.168.1.20

With no APK given they use a portal*.apk in the current folder, then your release build, then download the latest GitHub release (this needs the GitHub CLI installed and signed in with gh auth login). Options:

Bash	PowerShell
--apk FILE	-Apk FILE	install this APK
--keep-launcher	-KeepLauncher	leave the stock launcher alone
--keep-screensaver	-KeepScreensaver	leave the TV's screen saver alone
--restore	-Restore	undo the launcher and screen saver changes

By hand

1. Connect to the TV.

adb connect <tv-ip>:5555

If the connection fails on a recent adb, set ADB_MDNS_OPENSCREEN=0 first.

2. Install the APK. Either use a prebuilt one or build it (see Build):

adb install -r portal-1.0.0-build1-release.apk

3. Make it the home screen. Press Home on the remote and choose Portal if the TV asks. If the stock launcher still wins, list what answers Home and turn those off for your user:

adb shell cmd package query-activities --brief --user 0 -a android.intent.action.MAIN -c android.intent.category.HOME
adb shell pm disable-user --user 0 <stock-launcher-package>
adb shell cmd role add-role-holder --user 0 android.app.role.HOME com.portal.tv

Repeat the pm disable-user for each package the first command lists, except com.portal.tv and com.android.tv.settings (its FallbackHome has to stay). Disabling one launcher can reveal another, so run the list again until only those two are left. On Google TV devices that is usually com.google.android.apps.tv.launcherx and com.google.android.tungsten.setupwraith.

To undo that later: adb shell pm enable --user 0 <package> for each one you disabled.

以上为 README 的开头部分。其余内容请阅读原文。 查看完整 README ↗