Back to Boring Notch

README

README.md

2.7.38.1 KB
Original Source
<h1 align="center">

<a href="http://theboring.name"></a>

Boring Notch

</h1> <p align="center"> <a title="Crowdin" target="_blank" href="https://crowdin.com/project/boring-notch"></a> <a href="https://discord.gg/c8JXA7qrPm"> </a> <a href="https://www.ko-fi.com/alexander5015"> </a> </p> <!--Welcome to **Boring.Notch**, the coolest way to make your MacBook's notch the star of the show! Forget about those boring status barsโ€”our notch turns into a dynamic music control center, complete with a snazzy visualizer and all the music controls you need. It's like having a mini concert right at the top of your screen! -->

Say hello to Boring Notch, the coolest way to make your MacBookโ€™s notch the star of the show! Say goodbye to boring status bars: with Boring Notch, your notch transforms into a dynamic music control center, complete with a vibrant visualizer and all the essential music controls you need. But thatโ€™s just the start! Boring Notch also offers calendar integration, a handy file shelf with AirDrop support, a complete MacOS HUD replacement and more!

<p align="center"> </p> <!--https://github.com/user-attachments/assets/19b87973-4b3a-4853-b532-7e82d1d6b040-->
<!--## Table of Contents - [Installation](#installation) - [Usage](#usage) - [Roadmap](#-roadmap) - [Building from Source](#building-from-source) - [Contributing](#-contributing) - [Join our Discord Server](#join-our-discord-server) - [Star History](#star-history) - [Buy us a coffee!](#buy-us-a-coffee) - [Acknowledgments](#-acknowledgments)-->

Installation

System Requirements:

  • macOS 14 Sonoma or later
  • Apple Silicon or Intel Mac

Option 1: Download and Install Manually

<a href="https://github.com/TheBoredTeam/boring.notch/releases/latest/download/boringNotch.dmg" target="_self"></a>

Once downloaded, open the .dmg and move Boring Notch to your /Applications folder.

[!IMPORTANT] We don't have an Apple Developer account (yet ๐Ÿ‘€), so macOS will warn you that Boring Notch is from an unidentified developer on first launch. This is expected behavior.

You'll need to bypass this before the app will open. You only need to do this once. Use one of the methods below.


Recommended: Terminal (Always Works)

This is the fastest and simplest method. It requires just one command and works reliably for all users, unlike System Settings, which occasionally doesn't.

After moving Boring Notch to your Applications folder, run:

bash
xattr -dr com.apple.quarantine /Applications/boringNotch.app

Then open the app normally.


Alternative: System Settings

[!NOTE] This method doesn't work for all users. If this doesn't work, use the Terminal method above.

  1. Try to open the app โ€” you'll see a security warning.
  2. Click OK to dismiss it.
  3. Open System Settings > Privacy & Security.
  4. Scroll to the bottom and click Open Anyway next to the Boring Notch warning.
  5. Confirm if prompted.

Option 2: Install via Homebrew

You can also install using Homebrew. The Homebrew installation automatically bypasses the macOS security warning described above.

bash
brew install --cask TheBoredTeam/boring-notch/boring-notch

Usage

  • Launch the app, and voilร โ€”your notch is now the coolest part of your screen.
  • Hover over the notch to see it expand and reveal all its secrets.
  • Use the controls to manage your music like a rockstar.
  • Click the star in your menu bar to customize your notch to your heart's content.

๐Ÿ“‹ Roadmap

  • Playback live activity ๐ŸŽง
  • Calendar integration ๐Ÿ“†
  • Reminders integration โ˜‘๏ธ
  • Mirror ๐Ÿ“ท
  • Charging indicator and current percentage ๐Ÿ”‹
  • Customizable gesture control ๐Ÿ‘†๐Ÿป
  • Shelf functionality with AirDrop ๐Ÿ“š
  • Notch sizing customization, finetuning on different display sizes ๐Ÿ–ฅ๏ธ
  • System HUD replacements (volume, brightness, backlight) ๐ŸŽš๏ธ๐Ÿ’กโŒจ๏ธ
  • Bluetooth Live Activity (connect/disconnect for bluetooth devices)
  • Weather integration โ›…๏ธ
  • Customizable Layout options ๐Ÿ› ๏ธ
  • Lock Screen Widgets ๐Ÿ”’
  • Extension system ๐Ÿงฉ
  • Notifications (under consideration) ๐Ÿ””
<!-- - [ ] Clipboard history manager ๐Ÿ“Œ `Extension` --> <!-- - [ ] Download indicator of different browsers (Safari, Chromium browsers, Firefox) ๐ŸŒ `Extension`--> <!-- - [ ] Customizable function buttons ๐ŸŽ›๏ธ --> <!-- - [ ] App switcher ๐Ÿช„ --> <!-- ## ๐Ÿงฉ Extensions > [!NOTE] > Weโ€™re hard at work on some awesome extensions! Stay tuned, and weโ€™ll keep you updated as soon as theyโ€™re released. -->

Building from Source

Prerequisites

  • macOS 14 or later: If youโ€™re not on the latest macOS, we might need to send a search party.
  • Xcode 16 or later: This is where the magic happens, so make sure itโ€™s up-to-date.

Installation

  1. Clone the Repository:

    bash
    git clone https://github.com/TheBoredTeam/boring.notch.git
    cd boring.notch
    
  2. Open the Project in Xcode:

    bash
    open boringNotch.xcodeproj
    
  3. Build and Run:

    • Click the "Run" button or press Cmd + R. Watch the magic unfold!

๐Ÿค Contributing

Weโ€™re all about good vibes and awesome contributions! Read CONTRIBUTING.md to learn how you can join the fun!

Join our Discord Server

<a href="https://discord.gg/GvYcYpAKTu" target="_blank"></a>

Star History

<a href="https://www.star-history.com/#TheBoredTeam/boring.notch&Timeline"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=TheBoredTeam/boring.notch&type=Timeline&theme=dark" /> <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=TheBoredTeam/boring.notch&type=Timeline" /> </picture> </a>

Support us on Ko-fi!

<!-- <a href="https://www.buymeacoffee.com/jfxh67wvfxq" target="_blank"></a> -->

<a href="https://www.ko-fi.com/alexander5015" target="_blank"></a>

๐ŸŽ‰ Acknowledgments

We would like to express our gratitude to the authors and maintainers of the open-source projects that made this possible.

Notable Projects

  • MediaRemoteAdapter โ€“ An open-source project that allowed us to use the Now Playing source in macOS 15.4+
  • NotchDrop โ€“ An open-source project that has been instrumental in developing the first version of the "Shelf" feature in Boring Notch.

For a full list of licenses and attributions, please see the Third-Party Licenses file.

Icon credits: @maxtron95

Website credits: @himanshhhhuv

  • SwiftUI: For making us look like coding wizards.
  • You: For being awesome and checking out boring.notch!