Skip to content

Latest commit

 

History

History
128 lines (95 loc) · 5.76 KB

README.md

File metadata and controls

128 lines (95 loc) · 5.76 KB
Raw

TheBoringNotch

TheBoringNotch Build & Test

Download

Warning

We don't have Apple Developer account yet. The applications will show a popup on first start. Click Okay, then go to Settings / Privacy & Security and scroll down until you see a button Open anyway. You'll have to do this once.

Star History

Star History Chart

Buy us coffee

Buy Me A Coffee

Join our Community on Discord

Discord - Human Action, HD Png Download@kindpng.com

Preview

BoringNotch.mp4

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!

Icon credits: @maxtron95

Website credits: @himanshhhhuv

🚀 Getting Started

Prerequisites

  • A MacBook: With a boring notch.
  • macOS 14.2 or later: If you’re not on the latest macOS, we might need to send a search party.
  • Xcode 15.0 or later: This is where the magic happens, so make sure it’s up-to-date.

Installation

  1. Clone the Repository:

    git clone https://github.com/TheBoredTeam/boring.notch.git
cd boring.notch

  2. Open the Project in Xcode:

    open boringNotch.xcodeproj

  3. Build and Run:

    • Select your target device (MacBook—you do have one, right?).
    • Click the "Run" button or press Cmd + R. Watch the magic unfold!

🎸 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.

📋 Roadmap

  • Proper notch sizing and animations 📐
  • Delayed notch opening ⏲️
  • Charging indicator and current percentage 🔋
  • Playback live activity 🎧
  • Calendar integration 📆
  • Customizable gesture control 👆🏻
  • Shelf functionality with AirDrop 📚
  • Extension system with starter template 🧩
  • Clipboard history manager 📌 Extension
  • System HUD replacements (volume, brightness, backlight) 🎚️💡⌨️ Extension
  • Download indicator of different browsers (Safari, Chromium browsers, Firefox) 🌍 Extension
  • Customizable function buttons 🎛️
  • Layout customization options 🛠️
  • Notch sizing customization, finetuning on different display sizes 🖥️
  • App switcher 🪄
  • Notifications (under consideration) 🔔

🧩 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.

🤝 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: 
    git clone https://github.com/{your-name}/boring.notch.git
# Replace {your-name} with your GitHub username
  3. Make sure to use dev branch as base.
  4. Create a New Branch: 
    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: 
    git commit -m "insert descriptive message here"
  7. Push to Your Fork: 
    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!

📝 License

This work is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-nd/4.0/.

🎉 Acknowledgments

We would like to express our appreciation to the developers of NotchDrop, an open-source project that has been instrumental in developing the "Shelf" feature in Boring.notch. Special thanks to Lakr233 for their contributions to NotchDrop and to Hugo Persson for integrating it into our project.

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