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!
---
## Installation
**System Requirements:**
- macOS **14 Sonoma** or later
- Apple Silicon or Intel Mac
---
> [!IMPORTANT]
> We don't have an Apple Developer account yet. The application will show a popup on first launch that the app is from an unidentified developer.
> 1. Click **OK** to close the popup.
> 2. Open **System Settings** > **Privacy & Security**.
> 3. Scroll down and click **Open Anyway** next to the warning about the app.
> 4. Confirm your choice if prompted.
>
> You only need to do this once.
### Option 1: Download and Install Manually
---
### Option 2: Install via Homebrew
You can also install the app using [Homebrew](https://brew.sh):
```bash
brew install --cask TheBoredTeam/boring-notch/boring-notch --no-quarantine
```
## 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
- [x] Playback live activity 🎧
- [x] Calendar integration 📆
- [x] Reminders integration ☑️
- [x] Mirror 📷
- [x] Charging indicator and current percentage 🔋
- [x] Customizable gesture control 👆🏻
- [x] Shelf functionality with AirDrop 📚
- [x] Notch sizing customization, finetuning on different display sizes 🖥️
- [x] 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) 🔔
## 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! Here’s how you can join the fun:
1. **Fork the Repo**: Click that shiny "Fork" button and make your own version.
2. **Clone Your Fork**:
```bash
git clone https://github.com/{your-name}/boring.notch.git
# Replace {your-name} with your GitHub username
```
3. **Make sure to use the `dev` branch as base.**
4. **Create a New Branch**:
```bash
git checkout -b feature/{your-feature-name}
# Replace {your-feature-name} with a descriptive and concise name for your branch
# It is best practice to use only alphanumeric characters, write words in lowercase
# and seperate words with a single hyphen
```
5. **Make Your Changes**: Add that feature or fix that bug.
6. **Commit Your Changes**:
```bash
git commit -m "insert descriptive message here"
```
7. **Push to Your Fork**:
```bash
git push origin feature/{your-feature-name}
# Remember to replace {your-feature-name} with the name you chose
```
8. **Create a Pull Request**: Head to the original repository and click on "New Pull Request." Fill in the required details, **make sure the base branch is set to `dev`**, and submit your PR. Let’s see what you’ve got!
## Join our Discord Server
## Star History
## Support us on Ko-fi!
## 🎉 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](https://github.com/ungive/mediaremote-adapter)** – An open-source project that allowed us to use the Now Playing source in macOS 15.4+
- **[NotchDrop](https://github.com/Lakr233/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](./THIRD_PARTY_LICENSES.md) file.
### Icon credits: [@maxtron95](https://github.com/maxtron95)
### Website credits: [@himanshhhhuv](https://github.com/himanshhhhuv)
- **SwiftUI**: For making us look like coding wizards.
- **You**: For being awesome and checking out **boring.notch**!
## Star History