Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thebarbican19/BatteryBoi

The battery app your Mac's been dreaming about behind your back.
https://github.com/thebarbican19/BatteryBoi

battery-monitor macos menubar menubar-app

Last synced: 3 months ago
JSON representation

The battery app your Mac's been dreaming about behind your back.

Awesome Lists containing this project

README

        

![BatteryBoi Promo image](https://pub-3d59231d7ecc43e7af32a82026f9e071.r2.dev/BatteryBoi%20Poster.jpg)

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
![GitHub Sponsors](https://img.shields.io/github/sponsors/thebarbican19)
[![Github All Releases](https://img.shields.io/github/downloads/thebarbican19/BatteryBoi/total.svg)]()
![GitHub contributors](https://img.shields.io/github/contributors/thebarbican19/BatteryBoi)
[![Swift Version](https://img.shields.io/badge/Swift-5.x-orange.svg)]()
[![MacOS Version](https://img.shields.io/badge/Supported%20Version-v11.0,%20v12.0,%20v13.0,%20v14.0+-orange)]()
[![Twitter](https://img.shields.io/badge/Follow%20BatteryBoiApp-black)](https://twitter.com/batteryboiapp)

# BatteryBoi - A Battery Indicator to Rule Them All!
**BatteryBoi** is a **replacement Battery Indicator for the MacOS Menu Bar**.

## Why
The battery icon really needed an indicator for how much time is left in terms of minutes and hours. So as a fun evening project, I ([Mojito Joe](https://twitter.com/mistermeenr)) built it.



However, because of popular demand, the scope of this project has expanded significantly to be a full-fledged, open-source, completely free battery app giving you beautiful notifications and insights into your battery, and even your connected Bluetooth devices




## News! News! News! - Version 3.0 & the iOS App
After crossing 20k downloads, I am happy to launch not only some huge updates coming to Version 3.0, but also the release of the BatteryBoi iOS and iPadOS apps. Plus much more.

**See the full post about it all [here](https://github.com/thebarbican19/BatteryBoi/discussions/62)**



## How (to Install)

#### Manual Download
1. You can install the app by downloading the [latest released .DMG file](https://github.com/thebarbican19/BatteryBoi/releases/). This contains an executable version of the app - **you do not need to Xcode to run this.**
2. Open/mount the DMG file and drag BatteryBoi into the Applications Folder. And that's it!
3. You can hide the default battery icon by going to **System Preferences** > **Control Center** > **Battery** > **Show in Menu Bar**



#### Homebrew
You can install BatteryBoi via Homebrew thanks to the contribution from [Marcus Kannicht](https://github.com/kannicht). `$ brew install batteryboi`




### Works On...
**BatteryBoi** runs on **both Intel & Silicon (M1 & M2)** for the following MacOS versions
- 11.0 (Big Sur)
- 12.0 (Monterey)
- 13.0 (Ventura)
- 14.0 (Sonoma)
- 15.0 [(Big Chungus)](https://twitter.com/mistermeenr/status/1643378900313964544?s=20)




## Localization
**BatteryBoi** has been Localized into the following languages, either by way of auto-translation or by direct translation by the community.

#### Verified
- ๐Ÿ‡ฌ๐Ÿ‡ง [English](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/en.lproj/LocalizableMain.strings)
- ๐Ÿ‡ฏ๐Ÿ‡ต [Japanese](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/ja.lproj/LocalizableMain.strings) (Provided by [@fus1ondev](https://github.com/fus1ondev))
- ๐Ÿ‡ท๐Ÿ‡บ [Russian](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/ru.lproj/LocalizableMain.strings) (Provided by [Alexey Petraky @ko-oler](https://github.com/ko-oler))
- ๐Ÿ‡ณ๐Ÿ‡ฑ [Dutch](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/nl.lproj/LocalizableMain.strings) (Provided by [@joostiphone](https://github.com/joostiphone))
- ๐Ÿ‡น๐Ÿ‡ท [Turkish](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/tr.lproj/LocalizableMain.strings) (Provided by [Soner Kalonya @kalonya](https://github.com/kalonya))
- ๐Ÿ‡จ๐Ÿ‡ณ [Chinese (Simplified)](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/tr.lproj/LocalizableMain.strings) (Provided by [Desmoed Richtofen @Shane1119](https://github.com/Shane1119))
- ๐Ÿ‡น๐Ÿ‡ผ [Chinese (Traditional)](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/tr.lproj/LocalizableMain.strings) (Provided by [Desmoed Richtofen @Shane1119](https://github.com/Shane1119))
- ๐Ÿ‡ธ๐Ÿ‡ฐ [Slovenian](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/tr.lproj/LocalizableMain.strings) (Provided by [@drodmantras](https://github.com/drodmantras))
- ๐Ÿ‡ธ๐Ÿ‡ฐ [Slovak](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/tr.lproj/LocalizableMain.strings) (Provided by [@Svec-Tomas](https://github.com/Svec-Tomas))
- ๐Ÿ‡ป๐Ÿ‡ณ [Vietnamese](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/vi.lproj/LocalizableMain.strings) (Provided by [Hieu Huynh @hieuhuynh93](https://github.com/hieuhuynh93))
- ๐Ÿ‡ช๐Ÿ‡ธ [Spanish](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/es.lproj/LocalizableMain.strings) (Provided by [@David C](https://github.com/davidcafor))
- ๐Ÿ‡ฉ๐Ÿ‡ช [German](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/de.lproj/LocalizableMain.strings) (Provided by [Hendrik Erz @nathanlesage](https://github.com/nathanlesage))
- ๐Ÿ‡ฐ๐Ÿ‡ท [Korean](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/ko.lproj/LocalizableMain.strings) (Provided by [YiGeon @YiGeon](https://github.com/YiGeon))
- ๐Ÿ‡ซ๐Ÿ‡ท [French](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/fr.lproj/LocalizableMain.strings) (Provided by [Ben Wayne](https://github.com/))
- ๐Ÿ‡ฎ๐Ÿ‡น [Italian](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/it.lproj/LocalizableMain.strings) (Provided by [Francesco @katullo11](https://github.com/katullo11))

#### Unverified/Auto-Translated
- ๐Ÿ‡ต๐Ÿ‡น [Portuguese (Traditional)](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/pt-PT.lproj/LocalizableMain.strings)
- ๐Ÿ‡ง๐Ÿ‡ท [Portuguese (Brazil)](https://github.com/thebarbican19/BatteryBoi/tree/main/BatteryBoi/Other/Localization/pt-BR.lproj/LocalizableMain.strings)


**If you would like to help by verifying your native language, or if it is not yet on the list, add it!**

You can do this on our [Crowdin Translation Page](https://crowdin.com/project/batteryboi?already_accepted=16003147)





## Roadmap
With continued support, I will be adding...

- [X] **๐Ÿ”‹ Battery Replacement**
- [x] **๐Ÿš€ Login at Launch**
- [x] **๐Ÿ‘ด๐Ÿป Support for macOS Monterey & Big Sur (v11)**
- [ ] **๐ŸŸก System Colour Alerts & Charging Icon**
- [ ] **๐Ÿชซ Low Power Mode Toggle** (Suggested by [@Crear12](https://github.com/Crear12))
- [x] **๐Ÿ‡ฒ๐Ÿ‡ฝ Multiple Language Support** (Helo Translate for your local language here https://github.com/thebarbican19/BatteryBoi/issues/12)
- [x] **โฌ‡๏ธ Sparkle Integration**
- [x] **๐Ÿšจ Improved Alerts**
- [x] **๐Ÿ๏ธ A Dynamic Island-Style Modal with Sexy Indicator**
- [ ] **โ˜€๏ธ Light Mode**
- [x] **๐Ÿ”‰ Sound Effects**
- [ ] **๐ŸŽจ Customisation View** Funding Goal: **$500**
- [ ] **๐Ÿ”‰ Sound Effects (Toggle)**
- [ ] **โš™๏ธDisplay (Toggle)**
- [ ] **๐Ÿ‘๏ธHide/Show Menu Bar Toggle**
- [ ] **โ˜€๏ธLight/Dark Mode Toggle**

- [ ] **๐Ÿ“ˆ More Stats**
- [x] **โ†—๏ธ Move and Snap to Position**
- [x] **โš™๏ธ App Preferences**
- [ ] **๐ŸŽง Bluetooth Device Support**
- [ ] **Custom Notifications**
- [x] **Quick View**
- [ ] **Add to Menu Bar**

- [ ] **โŒจ๏ธ Custom Keyboard Shortcuts**
- [ ] **โŒจ๏ธ Custom IF/THEN Triggers** (at 10%, lower the brightness to 0.3)
- [ ] **๐Ÿ“ฑ iOS/iPad App (Bidirectional Syncing of Battery Information)**
- [ ] **๐Ÿงณ SMJobBless Helper Command Line**


Ideas are welcome.




## Q&A
**Q.** Is the app GDPR compliment?

**A.** BatteryBoi does not collect, store, process, or transfer any personal information as defined by Article 4, Section 1 of the GDPR



**Q.** Does this app steal my data?

**A.** The app **only logs installs** with [Enalog](https://github.com/thebarbican19/EnalogSwift).

โ€‚โ€‚โ€‚The information captured in this logging event is...

โ€‚โ€‚โ€‚ - **Device Architecture (Silicon or Intel)**

โ€‚โ€‚โ€‚ - **MacOS Version Number**

โ€‚โ€‚โ€‚ - **System Locale (ISO Country Code)**

โ€‚โ€‚โ€‚ - **Theme (Dark/Light Mode)**.



**Q.** What about Personal Data?

**A.** No personal data or anything that can be remotely attributed to your person is collected, stored, processed, or transferred.



**Q.** Did you make any other sweet sweet apps I can try?

**A.** Yeah, [SprintDock](https://sprintdock.app) is my masterpeice. Check it out!



**Q.** The estimated time does not show up. Why?

**A.** Estimated time until battery depletion is calculated by the System. Sometimes this information just isn't available. When it isn't, it will fall back on the Battery Percentage.



**Q.** Can I revert back to the old MacOS Battery Indicator?

**A.** Yes! Go to **System Preferences** > **Control Center** > **Battery** > **Show in Menu Bar** and toggle it on.



**Q.** Is there support for 3rd Party Devices?

**A.** Devices that are connected (via Bluetooth) now show up with their battery level (if available) in BatteryBoi.



**Q.** Some Bluetooth devices don't show the Battery Level. Why?

**A.** BatteryBoi uses **System Information** to get this information, if it's not in here the device simply may not offer this information or it isn't supported.




## BatteryBoi In the Media
Here's a list of places BatteryBoi has been featured across the web and across the world.
- [๐Ÿ‡ฏ๐Ÿ‡ต Apple CH](https://applech2.com/archives/20230831-batteryboi-for-macbook-battery.html)
- [๐Ÿ‡ฉ๐Ÿ‡ช iFun](https://www.ifun.de/batteryboi-zeigt-die-restliche-akku-laufzeit-in-der-menueleiste-215907/)