BrimDeck README

The project's README from github.com/MoFeng2223/BrimDeck. As one markdown file: README.md.

English 简体中文

BrimDeck icon

BrimDeck - A Dynamic Island for Windows

BrimDeck is a Dynamic Island for Windows 11 that brings your AI coding tool quotas and usage, the music you are playing, system readings and wireless device batteries together at the top of the screen, with a clipboard history and a file transfer.
It stays collapsed at the top of the screen and opens only when you need it.
A native Windows app built with C# and WPF, designed for performance and smoothness.

Download Latest release License Interface languages

Features · Install · Quick start · Privacy · FAQ · Community · Contributing · 简体中文

BrimDeck opens from the notch at the top of the screen into the AI usage panel, switches to the music page, the system monitor page, the clipboard and file transfer page and the device batteries page, then collapses

Why BrimDeck

Features

Collapsed styles

BrimDeck sits at the top center of the screen and comes in three styles: Notch (default), Capsule and Indicator.

Notch
Notch (default)
Capsule
Capsule
Indicator
Indicator

AI usage

AI usage page: quotas of Claude, Codex, Cursor and Antigravity in four columns Model details page: tokens and cost by app and model

You can choose the quota providers and set the quota and usage source of each column separately. See Supported tools.

Music

Music page: cover, title, lyrics, progress bar and playback controls

Works with players that use Windows media controls, with extra support for NetEase Cloud Music, QQ Music, Apple Music and KuGou Music. See Supported players.

System monitor

System monitor page: CPU usage, temperature and each core, GPU, memory, network speed, drives, system power and battery, and the busiest apps

For where each reading comes from and its limits, see System monitor readings. PCs whose CPU temperature or power cannot be read can turn on enhanced sensors.

The page is adapted from ftop by Nongfsq (MIT License), a system monitor for macOS.

Device batteries

Device batteries page: a battery ring each for a mouse, a keyboard, a headset, AirPods and a controller, with the charge, name and state under it

For the supported connections, brands and models, see Supported devices.

Clipboard and file transfer

Clipboard and file transfer page: copied text, a link, code, a picture and a color on the left; held files with their sizes on the right

For how to use it and its settings, see Clipboard and file transfer.

Panel themes

The same AI usage page in the Dark, Light, Island Holiday 2, Pixel Blocks and Cyberpunk: Edgerunners themes, and in an example custom theme

More settings

Install

Requires Windows 11 (x64). Windows 10 (version 2004 or later) has limited support.

  1. Download one of these files from Releases:
    • Installer: BrimDeck-<version>-Setup.exe. Run it and follow the steps.
    • Portable: BrimDeck-<version>-Portable-x64.zip. Extract it and run BrimDeck.exe in the BrimDeck folder.
  2. If Windows shows "Windows protected your PC", select "More info", then "Run anyway".

Both versions update from within the app, and both keep settings and data in %LOCALAPPDATA%\BrimDeck.

Quick start

  1. After you install and start BrimDeck, the panel appears at the top center of the primary display, showing Claude and Codex by default.
  2. Move the pointer over the panel to open it; move away or press Esc to close it.
  3. Use the page switch at the top left of the open panel to move between AI usage, music, the system monitor, the clipboard and file transfer, and device batteries; pages you do not need can be turned off or reordered under Settings › Expanded view.
  4. Select the settings button at the top right of the open panel to add tools or change settings. You can also right-click the open panel, double-click the tray icon, or right-click the tray icon.

Uninstall

To remove settings and data as well, also delete %LOCALAPPDATA%\BrimDeck. If you turned on enhanced sensors, uninstalling the installed version removes the sensor service too; with the portable version, turn it off under Settings › Enhanced sensors first.

Privacy

For the files BrimDeck reads and the addresses it connects to, see Data and privacy.

FAQ

A tool shows "Not connected" or "Waiting for update". What should I do? Make sure the tool is signed in on this PC; for example, Antigravity needs its desktop app running for its quota to be read. When BrimDeck cannot read the data, it shows the actual status and never makes up numbers.

Is the cost shown what I actually pay? No. Costs come from the amounts reported by each service or from public model prices, and are meant to show how much you use. Your actual subscription charges are on each provider's bill.

Why does the system monitor show no CPU temperature or power? On many PCs Windows does not provide either. Turn on enhanced sensors under Settings › Enhanced sensors, or run HWiNFO or LibreHardwareMonitor alongside. See Enhanced sensors.

My mouse, keyboard or headset shows no battery. Why? The device has to be connected and be one of the connections or models listed in Supported devices. For a device that is not listed, you are welcome to report its model in Issues.

Animations or the equalizer bars never move. Why? BrimDeck's animations and equalizer bars need two settings turned on: BrimDeck's Settings › General › Hover and animation › Animate expanding and collapsing, and Windows Settings › Accessibility › Visual effects › Animation effects. If either is off, the expand animation, the equalizer bars and scrolling text all stop.

Community

QQ group: 1132738200

Contributing

You are welcome to report problems, suggest features or ask for more tools, players and devices in Issues, and to contribute through pull requests.

License

BrimDeck is licensed under the Apache License 2.0. Third-party licenses are listed in ThirdPartyNotices.txt.

BrimDeck (MoFeng2223/BrimDeck)

Searching Database…

What is this?BrimDeck is a Dynamic Island-style panel for Windows 11 that sits at the top of the screen and gathers AI coding tool quotas, music controls, system readings, device batteries, and clipboard and file transfer in one place.
Is it an app or a library?It is a native Windows desktop app built with C# and WPF, not a library you import into your own code.
Do I need to sign in or add API keys?Usually not. It detects Claude, Codex, Cursor and other tools that are already signed in on this PC. API keys are only needed if you enter them yourself, and they are stored encrypted by Windows.
Will the quota numbers always be accurate?Not always. If a tool is not signed in or its data cannot be read, the panel shows the real status such as 'Not connected' or 'Waiting for update' instead of guessing. Antigravity needs its desktop app running for its quota to be read.
Does it upload my data?It only reads the sign-in state and usage records that apps already keep, and it never changes or ends sign-ins. Conversations are not uploaded. It goes online only to read quotas and usage, update prices, fetch lyrics and covers, and check for updates.
Which AI coding tools does it track?Claude, Codex, Cursor and Antigravity are named, plus others, for up to 7 tools at once. Each column shows the plan, quota usage, reset countdown, and token and cost totals for today and the last 7 days.
Which music players does it control?Any player that uses Windows media controls works, with extra support for NetEase Cloud Music, QQ Music, Apple Music and KuGou Music. You can pin one player or hide apps you do not want shown.
Does the clipboard history stay on my PC?Yes. The history is stored encrypted on this PC by Windows and cleared when BrimDeck exits, except for Favorites or categories set to be kept. Apps you choose can be excluded from recording.
Will it pop up over my fullscreen games?No. It hides automatically while you play full-screen games or watch full-screen video, so it never opens by accident. You can adjust this in settings, and mouse pass-through mode also stops hover from opening it.
Creator
MoFeng2223
Size
253.1 MB
Stars
801
Age
2mo
Commits · 90 Days