Skip to content

Repository files navigation

PocketPlanet

A notch companion for macOS, built with Electron. PocketPlanet turns the notch area at the top of your screen into a small panel with tabs for the stuff you check most often.

PocketPlanet demo

Features

  • Music - shows what's currently playing system-wide (Spotify, Apple Music, or anything using the Web MediaSession API) with playback controls and a live audio visualizer.
  • Notes - a quick scratchpad you can open without switching apps.
  • Shelf - drag files onto the notch to hold them for a bit, then drag them back out wherever you need them.
  • App Launcher - pin your most used apps for one click launching.
  • Mirror - a quick camera preview so you can check yourself before a call.
  • Settings - configure the app from its own window.

The panel stays collapsed to a small pill near the notch until you hover or click it, then expands with a shape that curves to match the notch.

Prerequisites

  • macOS
  • Node.js 18+
  • A local checkout of mediaremote-adapter sitting next to this repo (so ../mediaremote-adapter relative to this project's root). MediaService shells out to it for Now Playing data. It's not bundled into this repo yet, see electron-builder.yml for where it's expected.

Getting started

npm install
npm run dev

That starts the app in dev mode with hot reload.

Other scripts

  • npm run typecheck - type check main and renderer
  • npm run build - production build
  • npm run dist - build and package a signed, notarized .dmg (full process in RELEASING.md)
  • npm run clear - kill any running dev or packaged instances

Project structure

  • src/main - the Electron main process: window management, tray, and the services behind each tab (media, notes, settings, shelf, app launcher)
  • src/preload - the IPC bridge exposed to the renderer
  • src/renderer - the React UI rendered inside the notch panel
  • src/shared - types, IPC channel names, and layout constants shared between main and renderer

Contributing

See CONTRIBUTING.md.

License

Apache License 2.0, see LICENSE.

About

Functional Notch for macOS, built with ElectronJS

Topics

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Contributors

Languages