Skip to content

Commit a6b64b9

Browse files
Merge branch 'dev' into feature/artwork-ui-improvement
2 parents 2824b38 + 8460c1d commit a6b64b9

File tree

20 files changed

+902
-520
lines changed

20 files changed

+902
-520
lines changed

.github/workflows/cicd.yml

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Build for macos  platform
1+
name: Build for macOS
22

33
on:
44
push:
@@ -15,31 +15,22 @@ concurrency:
1515

1616
jobs:
1717
build:
18-
name: Build boringNotch
18+
name: Build Boring Notch
1919
strategy:
2020
matrix:
2121
platform:
2222
- macOS
23+
xcode:
24+
- ^16
2325
scheme:
2426
- boringNotch
2527
runs-on: macos-latest
2628
steps:
27-
- name: Switch xcode to latest-stable
28-
uses: maxim-lobanov/setup-xcode@v1
29-
with:
30-
xcode-version: latest-stable
3129
- name: Code Checkout
3230
uses: actions/checkout@v2
33-
- name: Check xcodebuild version
34-
run: xcodebuild -version
35-
- name: Check xcode embedded SDKs
36-
run: xcodebuild -showsdks
37-
- name: Show buildable schemes
38-
run: xcodebuild -list
39-
- name: Show eligible build destinations for ${{ matrix.scheme }}
40-
run: xcodebuild -showdestinations -scheme ${{ matrix.scheme }}
4131
- uses: mxcl/xcodebuild@v3
4232
with:
33+
xcode: ${{ matrix.xcode }}
4334
platform: ${{ matrix.platform }}
4435
scheme: ${{ matrix.scheme }}
4536
action: build

.github/workflows/static.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ name: Deploy static content to Pages
44
on:
55
# Runs on pushes targeting the default branch
66
push:
7-
branches: ["*"]
7+
branches:
8+
- main
89

910
# Allows you to run this workflow manually from the Actions tab
1011
workflow_dispatch:

README.md

Lines changed: 103 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,103 @@
1-
## TheBoringNotch
2-
![TheBoringNotch Build & Test](https://github.com/TheBoredTeam/boring.notch/actions/workflows/cicd.yml/badge.svg)
1+
<h1 align="center">
2+
<br>
3+
<a href="http://thebored.name"><img src="https://framerusercontent.com/images/RFK4vs0kn8pRMuOO58JeyoemXA.png?scale-down-to=256" alt="Markdownify" width="150"></a>
4+
<br>
5+
Boring Notch
6+
<br>
7+
</h1>
38

4-
<img width="150" src="https://github.com/user-attachments/assets/e96f6110-ffad-4d8b-a02d-ead87b7edbe1" />
59

6-
## Download
7-
<a href="https://github.com/TheBoredTeam/boring.notch/releases/latest/download/Flying_Rabbit.dmg" target="_self"><img width="200" src="https://www.adviksoft.com/blog/wp-content/uploads/2023/09/editor_download_mac.png" /></a>
10+
<p align="center">
11+
<img src="https://github.com/TheBoredTeam/boring.notch/actions/workflows/cicd.yml/badge.svg" alt="TheBoringNotch Build & Test" style="margin-right: 10px;" />
12+
<a href="https://discord.gg/c8JXA7qrPm">
13+
<img src="https://dcbadge.limes.pink/api/server/https://discord.gg/c8JXA7qrPm?style=flat" alt="Discord Badge" />
14+
</a>
15+
</p>
816

9-
> [!WARNING]
10-
> We don't have an Apple Developer account yet. The application will show a popup on first start. Click **Okay**, then, go to **Settings / Privacy & Security** and scroll down until you see a button called **Open anyway**. You'll only have to do this once.
17+
<!--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! -->
1118

12-
## Website
13-
> [!NOTE]
14-
> Hey There 👋 We have a new website at https://theboring.name! Go check it out for stuff like:
15-
> - All current bugs
16-
> - People's opinions about Boring.Notch
17-
> - All current features
18-
> - Q&A answers
19+
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 and more!
1920

20-
## Star History
21+
<p align="center">
22+
<img src="https://github.com/user-attachments/assets/2d5f69c1-6e7b-4bc2-a6f1-bb9e27cf88a8" alt="Demo GIF" />
23+
</p>
2124

22-
[![Star History Chart](https://api.star-history.com/svg?repos=TheBoredTeam/boring.notch&type=Timeline)](https://star-history.com/#TheBoredTeam/boring.notch&Timeline)
25+
<!--https://github.com/user-attachments/assets/19b87973-4b3a-4853-b532-7e82d1d6b040-->
26+
---
27+
<!--## Table of Contents
28+
- [Installation](#installation)
29+
- [Usage](#usage)
30+
- [Roadmap](#-roadmap)
31+
- [Building from Source](#building-from-source)
32+
- [Contributing](#-contributing)
33+
- [Join our Discord Server](#join-our-discord-server)
34+
- [Star History](#star-history)
35+
- [Buy us a coffee!](#buy-us-a-coffee)
36+
- [Acknowledgments](#-acknowledgments)-->
2337

24-
## Buy us a coffee!
38+
## Installation
2539

26-
<a href="https://www.buymeacoffee.com/jfxh67wvfxq" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-red.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
40+
**System Requirements:**
41+
- macOS **14 Sonoma** or later
42+
- Apple Silicon or Intel Mac
2743

28-
## Join our Discord Server (new)
44+
---
45+
> [!IMPORTANT]
46+
> 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.
47+
> 1. Click **OK** to close the popup.
48+
> 2. Open **System Settings** > **Privacy & Security**.
49+
> 3. Scroll down and click **Open Anyway** next to the warning about the app.
50+
> 4. Confirm your choice if prompted.
51+
>
52+
> You only need to do this once.
2953
30-
<a href="https://discord.gg/GvYcYpAKTu" target="_blank"><img src="https://iili.io/28m3GHv.png" alt="Join The Boring Server!" style="height: 60px !important;width: 217px !important;" ></a>
3154

32-
## Preview
55+
### Option 1: Download and Install Manually
56+
<a href="https://github.com/TheBoredTeam/boring.notch/releases/latest/download/Flying_Rabbit.dmg" target="_self"><img width="200" src="https://github.com/user-attachments/assets/e3179be1-8416-4b8a-b417-743e1ecc67d6" alt="Download for macOS" /></a>
3357

34-
https://github.com/user-attachments/assets/19b87973-4b3a-4853-b532-7e82d1d6b040
58+
---
3559

36-
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!
60+
### Option 2: Install via Homebrew
3761

62+
You can also install the app using [Homebrew](https://brew.sh):
3863

39-
### Icon credits: [@maxtron95](https://github.com/maxtron95)
40-
### Website credits: [@himanshhhhuv](https://github.com/himanshhhhuv)
64+
```bash
65+
brew install --cask TheBoredTeam/boring-notch/boring-notch --no-quarantine
66+
```
67+
68+
## Usage
69+
70+
- Launch the app, and voilà—your notch is now the coolest part of your screen.
71+
- Hover over the notch to see it expand and reveal all its secrets.
72+
- Use the controls to manage your music like a rockstar.
73+
74+
## 📋 Roadmap
75+
- [x] Playback live activity 🎧
76+
- [x] Calendar integration 📆
77+
- [x] Mirror 📷
78+
- [x] Charging indicator and current percentage 🔋
79+
- [x] Customizable gesture control 👆🏻
80+
- [x] Shelf functionality with AirDrop 📚
81+
- [x] Notch sizing customization, finetuning on different display sizes 🖥️
82+
- [ ] Customizable Layout options 🛠️
83+
- [ ] Extension system 🧩
84+
- [ ] System HUD replacements (volume, brightness, backlight) 🎚️💡⌨️
85+
- [ ] Notifications (under consideration) 🔔
86+
<!-- - [ ] Clipboard history manager 📌 `Extension` -->
87+
<!-- - [ ] Download indicator of different browsers (Safari, Chromium browsers, Firefox) 🌍 `Extension`-->
88+
<!-- - [ ] Customizable function buttons 🎛️ -->
89+
<!-- - [ ] App switcher 🪄 -->
90+
91+
<!-- ## 🧩 Extensions
92+
> [!NOTE]
93+
> We’re hard at work on some awesome extensions! Stay tuned, and we’ll keep you updated as soon as they’re released. -->
4194

42-
## 🚀 Getting Started
95+
## Building from Source
4396

4497
### Prerequisites
4598

46-
- **A MacBook**: With a boring notch (Not Needed).
47-
- **macOS 14.2 or later**: If you’re not on the latest macOS, we might need to send a search party.
48-
- **Xcode 15.0 or later**: This is where the magic happens, so make sure it’s up-to-date.
99+
- **macOS 14 or later**: If you’re not on the latest macOS, we might need to send a search party.
100+
- **Xcode 16 or later**: This is where the magic happens, so make sure it’s up-to-date.
49101

50102
### Installation
51103

@@ -61,37 +113,8 @@ Welcome to **Boring.Notch**, the coolest way to make your MacBook's notch the st
61113
```
62114

63115
3. **Build and Run**:
64-
- Select your target device (MacBook—you do have one, right?).
65116
- Click the "Run" button or press `Cmd + R`. Watch the magic unfold!
66117

67-
## 🎸 Usage
68-
69-
- Launch the app, and voilà—your notch is now the coolest part of your screen.
70-
- Hover over the notch to see it expand and reveal all its secrets.
71-
- Use the controls to manage your music like a rockstar.
72-
73-
## 📋 Roadmap
74-
- [x] Proper notch sizing and animations 📐
75-
- [x] Delayed notch opening ⏲️
76-
- [x] Charging indicator and current percentage 🔋
77-
- [x] Playback live activity 🎧
78-
- [x] Calendar integration 📆
79-
- [x] Customizable gesture control 👆🏻
80-
- [x] Shelf functionality with AirDrop 📚
81-
- [ ] Extension system 🧩
82-
- [ ] Clipboard history manager 📌 `Extension`
83-
- [ ] System HUD replacements (volume, brightness, backlight) 🎚️💡⌨️ `Extension`
84-
- [ ] Download indicator of different browsers (Safari, Chromium browsers, Firefox) 🌍 `Extension`
85-
- [ ] Customizable function buttons 🎛️
86-
- [ ] Layout customization options 🛠️
87-
- [ ] Notch sizing customization, finetuning on different display sizes 🖥️
88-
- [ ] App switcher 🪄
89-
- [ ] Notifications (under consideration) 🔔
90-
91-
## 🧩 Extensions
92-
> [!NOTE]
93-
> We’re hard at work on some awesome extensions! Stay tuned, and we’ll keep you updated as soon as they’re released.
94-
95118
## 🤝 Contributing
96119

97120
We’re all about good vibes and awesome contributions! Here’s how you can join the fun:
@@ -122,13 +145,32 @@ We’re all about good vibes and awesome contributions! Here’s how you can joi
122145
```
123146
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!
124147

125-
## 📝 License
148+
## Join our Discord Server
126149

127-
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/.
150+
<a href="https://discord.gg/GvYcYpAKTu" target="_blank"><img src="https://iili.io/28m3GHv.png" alt="Join The Boring Server!" style="height: 60px !important;width: 217px !important;" ></a>
151+
152+
## Star History
153+
154+
<a href="https://www.star-history.com/#TheBoredTeam/boring.notch&Timeline">
155+
<picture>
156+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=TheBoredTeam/boring.notch&type=Timeline&theme=dark" />
157+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=TheBoredTeam/boring.notch&type=Timeline" />
158+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=TheBoredTeam/boring.notch&type=Timeline" />
159+
</picture>
160+
</a>
161+
162+
## Buy us a coffee!
163+
164+
<a href="https://www.buymeacoffee.com/jfxh67wvfxq" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-red.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
128165

129166
## 🎉 Acknowledgments
130167

131-
We would like to express our appreciation to the developers of [NotchDrop](https://github.com/Lakr233/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](https://github.com/Hugo-Persson) for integrating it into our project.
168+
We would like to express our appreciation to the developers of [NotchDrop](https://github.com/Lakr233/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](https://github.com/Hugo-Persson) for integrating it into our project.
169+
170+
### Icon credits: [@maxtron95](https://github.com/maxtron95)
171+
### Website credits: [@himanshhhhuv](https://github.com/himanshhhhuv)
132172

133173
- **SwiftUI**: For making us look like coding wizards.
134174
- **You**: For being awesome and checking out **boring.notch**!
175+
176+

SECURITY.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
The Bored Team and community take security bugs in Boring Notch seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
6+
7+
To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/TheBoredTeam/boring.notch/security/advisories/new) tab.
8+
9+
The Bored Team will send a response indicating the next steps in handling your report. After the initial reply to your report, we will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.
10+
11+
Report security bugs in third-party dependencies to the person or team maintaining the package or dependency.

boringNotch.xcodeproj/project.pbxproj

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@
8686
B10A848A2C7BCC940088BFFC /* AirDropView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B10A84892C7BCC940088BFFC /* AirDropView.swift */; };
8787
B10A848C2C7BCD150088BFFC /* AirDrop.swift in Sources */ = {isa = PBXBuildFile; fileRef = B10A848B2C7BCD150088BFFC /* AirDrop.swift */; };
8888
B10F84A32C6C9596009F3026 /* TestView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B10F84A22C6C9596009F3026 /* TestView.swift */; };
89-
B141C23D2CA5F51200AC8CC8 /* ActivationView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B141C23C2CA5F50F00AC8CC8 /* ActivationView.swift */; };
9089
B141C2412CA5F53F00AC8CC8 /* SparkleView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B141C2402CA5F53E00AC8CC8 /* SparkleView.swift */; };
9190
B1628B922CC260C0003D8DF3 /* SwiftUIIntrospect in Frameworks */ = {isa = PBXBuildFile; productRef = B1628B912CC260C0003D8DF3 /* SwiftUIIntrospect */; };
9291
B1628BA82CC40C4F003D8DF3 /* DragDropView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B1628BA72CC40C4F003D8DF3 /* DragDropView.swift */; };
@@ -215,7 +214,6 @@
215214
B10A84892C7BCC940088BFFC /* AirDropView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AirDropView.swift; sourceTree = "<group>"; };
216215
B10A848B2C7BCD150088BFFC /* AirDrop.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AirDrop.swift; sourceTree = "<group>"; };
217216
B10F84A22C6C9596009F3026 /* TestView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestView.swift; sourceTree = "<group>"; };
218-
B141C23C2CA5F50F00AC8CC8 /* ActivationView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ActivationView.swift; sourceTree = "<group>"; };
219217
B141C2402CA5F53E00AC8CC8 /* SparkleView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SparkleView.swift; sourceTree = "<group>"; };
220218
B1628BA72CC40C4F003D8DF3 /* DragDropView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DragDropView.swift; sourceTree = "<group>"; };
221219
B17266DE2C64DFA00031BA0D /* BundleInfos.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BundleInfos.swift; sourceTree = "<group>"; };
@@ -528,7 +526,6 @@
528526
11CFC65E2E097F2100748C80 /* OnboardingView.swift */,
529527
11CFC65A2E097E9D00748C80 /* WelcomeView.swift */,
530528
B141C2402CA5F53E00AC8CC8 /* SparkleView.swift */,
531-
B141C23C2CA5F50F00AC8CC8 /* ActivationView.swift */,
532529
);
533530
path = Onboarding;
534531
sourceTree = "<group>";
@@ -796,7 +793,6 @@
796793
1153BD982D9881F900979FB0 /* AppleScriptHelper.swift in Sources */,
797794
11CFC6612E097F6800748C80 /* PermissionsRequestView.swift in Sources */,
798795
14D570D22C5F6C6A0011E668 /* BoringExtrasMenu.swift in Sources */,
799-
B141C23D2CA5F51200AC8CC8 /* ActivationView.swift in Sources */,
800796
14288DDC2C6E015000B9F80C /* AudioPlayer.swift in Sources */,
801797
149E0B972C737D00006418B1 /* WebcamManager.swift in Sources */,
802798
14288E0C2C6F8EC000B9F80C /* AppIcons.swift in Sources */,
@@ -945,7 +941,7 @@
945941
CODE_SIGN_IDENTITY = "Apple Development";
946942
CODE_SIGN_STYLE = Automatic;
947943
COMBINE_HIDPI_IMAGES = YES;
948-
CURRENT_PROJECT_VERSION = "2.7-rc.2+1";
944+
CURRENT_PROJECT_VERSION = "2.7-rc.3+1";
949945
DEAD_CODE_STRIPPING = YES;
950946
DEVELOPMENT_ASSET_PATHS = "\"boringNotch/Preview Content\"";
951947
DEVELOPMENT_TEAM = "";
@@ -967,12 +963,13 @@
967963
INFOPLIST_KEY_NSCalendarsUsageDescription = "This app uses the calendar to display your calendar events";
968964
INFOPLIST_KEY_NSCameraUsageDescription = "This app uses the camera to display a live camera view";
969965
INFOPLIST_KEY_NSHumanReadableCopyright = "";
966+
INFOPLIST_KEY_NSRemindersUsageDescription = "This app uses Reminders to display your scheduled reminder in the calendar";
970967
LD_RUNPATH_SEARCH_PATHS = (
971968
"$(inherited)",
972969
"@executable_path/../Frameworks",
973970
);
974971
MACOSX_DEPLOYMENT_TARGET = 14.0;
975-
MARKETING_VERSION = "2.7-rc.2";
972+
MARKETING_VERSION = "2.7-rc.3";
976973
PRODUCT_BUNDLE_IDENTIFIER = theboringteam.boringnotch;
977974
PRODUCT_NAME = "$(TARGET_NAME)";
978975
PROVISIONING_PROFILE_SPECIFIER = "";
@@ -998,7 +995,7 @@
998995
CODE_SIGN_IDENTITY = "Apple Development";
999996
CODE_SIGN_STYLE = Automatic;
1000997
COMBINE_HIDPI_IMAGES = YES;
1001-
CURRENT_PROJECT_VERSION = "2.7-rc.2+1";
998+
CURRENT_PROJECT_VERSION = "2.7-rc.3+1";
1002999
DEAD_CODE_STRIPPING = YES;
10031000
DEVELOPMENT_ASSET_PATHS = "\"boringNotch/Preview Content\"";
10041001
DEVELOPMENT_TEAM = "";
@@ -1019,12 +1016,13 @@
10191016
INFOPLIST_KEY_NSCalendarsUsageDescription = "This app uses the calendar to display your calendar events";
10201017
INFOPLIST_KEY_NSCameraUsageDescription = "This app uses the camera to display a live camera view";
10211018
INFOPLIST_KEY_NSHumanReadableCopyright = "";
1019+
INFOPLIST_KEY_NSRemindersUsageDescription = "This app uses Reminders to display your scheduled reminder in the calendar";
10221020
LD_RUNPATH_SEARCH_PATHS = (
10231021
"$(inherited)",
10241022
"@executable_path/../Frameworks",
10251023
);
10261024
MACOSX_DEPLOYMENT_TARGET = 14.0;
1027-
MARKETING_VERSION = "2.7-rc.2";
1025+
MARKETING_VERSION = "2.7-rc.3";
10281026
PRODUCT_BUNDLE_IDENTIFIER = theboringteam.boringnotch;
10291027
PRODUCT_NAME = "$(TARGET_NAME)";
10301028
PROVISIONING_PROFILE_SPECIFIER = "";

0 commit comments

Comments
 (0)