kristopherjohnson / menubarcountdown Goto Github PK

Menubar countdown timer for macOS

License: MIT License

Swift 87.46% Rich Text Format 3.03% AppleScript 9.51%

macos swift statusbar timer-expiration menubar-countdown

menubarcountdown's Introduction

Menubar Countdown

Menubar Countdown is a simple countdown timer displayed in the macOS menu bar. It can be used as a pomodoro timer, to remind yourself to get back to work after a break, or whenever you want to quickly set a time limit on some activity.

To set the timer, click the menu bar icon and select the Start... menu item. A dialog will appear allowing you to specify the countdown time in hours, minutes, and seconds. The dialog also allows you to specify which of the following forms of notification you want when the timer gets down to 00:00:00:

Blink the icon in the menu bar.
Play the system alert sound.
Display an alert window.
Display a notification in Notification Center.
Make a spoken announcement. You can specify the text to be spoken.

The countdown timer can be controlled using AppleScript, JavaScript, or Swift. See the examples in the Scripts directory for details.

Releases are available from:

The Mac App Store
https://github.com/kristopherjohnson/MenubarCountdown/releases
Homebrew (e.g. brew install --cask menubar-countdown)

The current 2.1 version of Menubar Countdown requires macOS Mojave 10.14.4 or newer. It is compatible with macOS Catalina 10.15.

For macOS versions 10.6 through 10.14.3, use version 1.3.

For macOS 10.5, use version 1.2, available from http://s3.amazonaws.com/capablehands/downloads/MenubarCountdown-1.2.zip

To build in XCode

Product > Clean Build Folder
Change "Team" under "Signing & Capabilities"

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Release Notes

v2.2 (in progress)

Support Command+drag icon from menu bar to terminate
Add tolerance to once-per-second timer to improve energy usage

v2.1 (2019/11/10)

Add scriptable interface for AppleScript and OSA languages.
Add service-provider interface for control via the Services menu in other applications.
High-resolution menubar icon for Retina displays.

v2.0 (2019/10/28)

Updated for macOS 10.14.4 and newer.
Distributed through the Mac App Store.
Supports dark mode.
When timer is not active, menubar displays small hourglass icon rather than 00:00:00, to conserve menubar space.
Added option to repeat alert sound after timer expiration, until it is acknowledged.
Added option to blink 00:00:00 in the menu bar after timer expiration, until it is acknowledged.
Added option to show a notification alert in Notification Center.
Added Pause and Resume menu items.
Translated code to Swift.

v1.3 (2019/10/21)

Works on macOS 10.15 Catalina.
Minimum macOS version supported is now 10.6. (10.5 is no longer supported).
32-bit processors are no longer supported.
Growl is no longer supported.

v1.2 (2009/06/22)

New application icon
Command-X, Command-C, Command-V, and Command-A now work in the text fields in the settings dialog
Command-R is now a shortcut key for the Restart Countdown... button in the alert window
Add option to hide seconds in menu bar
Show start-timer dialog when application launches
Add Growl notifications. The Announcement text specified in the Start dialog will be displayed in the Growl notification window.

v1.1 (2009/04/20)

timer-expired alert window floats above other applications' windows
added application icon
added Doxygen comments to source code

v1.0 (2009/04/09)

initial release

menubarcountdown's People

Contributors

Stargazers

Watchers

menubarcountdown's Issues

Need monospaced font for Big Sur

In the Big Sur beta, when the timer is active and seconds are displayed, the width of the item changes each second depending on the width of the digits.

The app does try to specify a monospace-digits font, and this worked in pre-Big Sur versions of macOS, so apparently something has changed at the OS level.

32-bit app compatibility with macOS High Sierra 10.13.4 and later

When you start the app in macOS Mojave, you get this warning.

URLSchema support

Thank you for the such small and useful app!

It will be great to add ability to start and stop the timer using URLSchema, it will add ability for users to create automation script for running the timer, for example using Raycast or Alfred

Resources:

https://www.hackingwithswift.com/example-code/system/how-to-make-your-app-open-with-a-custom-url-scheme
example of urlschema in app https://culturedcode.com/things/support/articles/2803573/

Support Command-Drag Icon Removal

System menu bar items can be removed from the menu bar by holding the Command key and dragging the icon off the menu bar.

Menubar Countdown should support this too. Removing the icon should terminate the app.

Improve notifications setup

Enabling notifications for Menubar Countdown on Big Sur can be confusing. See https://twitter.com/jleedev/status/1375080727021293568

Not much we can do to change Apple's permissions requirements and UI, but maybe there is a better way to help the user through initial setup.

Start previously set time from menu

Hello, thank you for your software. I would like to propose a new feature: allow start the countdown from the menu on single click (without revealing the settings form) with the countdown time previously set. I often use the same time to count down, so it would be quicker to start it without opening the form.

Or I can try to add the feature and make a PR, if you agree.

Volume

Does anyone know if there is any way to control the volume of the spoken announcement?
My meeting attendees sometimes get a shock when the timer ends and the loud voice sounds.
Thanks !

Countdown from a future date and time

There are a few benefits to let users set a future date and time:

if Mac sleeps then wakes up the countdown clock isn't affected
they know exactly when a future appointment is
they can use days, hours, minutes from now to calculate this future date and time in UI
the standard calendar widget from macOS can be used for this

Countdown not showing in second monitor menu bar

When I have a second monitor attached, the countdown is shown only in the primary one and only when it is active (i.e., the active window is in the first monitor). If the active monitor is the secondary, the countdown is not shown on either monitor.
I would expect the countdown to show on both, or even better, to always show on the active monitor.

Need to update distribution certificate

The non-App Store release of Menubar Countdown is signed with a distribution certificate which will expire soon. A new distribution with a new certificate is needed.

(This does not affect the App Store release of Menubar Countdown.)

Broken link

I couldn't head to http://capablehands.net/menubarcountdown. Thanks.

Support longer countdown

Thanks for your great works. Do you plan to support longer countdown, like months or days?

Set notification text

It would be nice to be able to set the notification text (in Applescript)

Icon Update?

This is not super important, but I think the icon could be updated to fit in better in current OS versions. And I am not sure that the menubar has to be part of the icon. I get that it hints to the name. It looks a little weird in the notification like that though.

Update time correctly after sleep

I just realized that the time does not get updated after sleeping. This especially a problem if you have set a timer for a longer period.

"Start" hotkey

Hi,

I've tried lots of timers for mac os, but guess MenubarCountdown is the best one (for me).
I wish there we 2 options:

hotkey to quickly start a timer via keyboard
display just icon in menu bar instead of actual remaining time

thank you

persisting status after stopping

Thanks for this great tool! I am using it as part of an Alfred workflow and I have a quick question: is there a way to check if a timer is running? I am currently using a combination of 'non-paused' and some time remaining, but when a running timer is stopped (not paused) before completion through the menubar, an Apple script call will still return some time remaining and a non-paused status. A stop timer Apple script command will not reset the time left. Thanks again!

Hide hours if less than 1

I have just discovered this app and it does exactly what I wanted. I would like to propose a feature request to preserve some space in the menubar. Do you think it makes sense to hide the hours from the count down item in the menu bar when the hour becomes less than one?

Either way thank you for your work and the useful app!

Feature request: predefined durations

Thanks for this app! I'd love to see predefined durations that I could choose from in the menu without having to manually select one in the "start" window (e.g. 5:00, 10:00, 15:00, 20:00, etc.). Could be defined by the user or simply in 5-minute increments up to an hour or so.