Skip to content

Latest commit

 

History

History
106 lines (69 loc) · 3.01 KB

README.md

File metadata and controls

106 lines (69 loc) · 3.01 KB
Raw

BarTime

Version License: MIT

A visual progress bar style countdown timer to your Touch Bar via BetterTouchTool.

Prerequisites

  • node >=8.0.0
  • BetterTouchTool > 2.430

Install

BetterTouchTool

BetterTouchTool is a paid app available for purchase on its website, or through a Setapp subscription.

Enable external scripting through Preferences -> Scripting BTT.

Download BarTime's BTT presets and install them.

BarTime Server

Clone or download the project. In the directory, run

# npm
npm install
# OR yarn
yarn install

Then start the server.

make serve

Daemon & Login Item

You may want to run BarTime as a daemon. In that case, you could use

make demon

There are a few ways to launch the above script at login.

Usage and Configuration

To hook up the BTT widget and the server, copy the main widget's UUID.

Then go to

http://localhost:4975/bartime/config/set?uuid=YOUR_UUID

Things should be ready to go!

Using the time picker widget to set a timer:

Using the bar widget to start a timer of default length (15m).

For the bar widget, the following actions are available.

  • Tap
    • start default timer, if idle
    • pause/resume, if a timer is set
  • Long press
    • stop current timer

Acknowledgements

BarTime took inspirations from the following projects.

  • Timebar: Turn your menubar into a subtle timer.
    • Unfortunately it's been many years since Timebar was last maintained/available. I still miss the app dearly. This is the reason I wrote BarTime.
  • ng-vu/tomato: Tomato is a command for running pomodoro in background. It's designed mainly to stay in MacBook touchbar.
  • mathiasvr/tiny-timer: 🕑 Small countdown timer and stopwatch module.

This README was generated with ❤️ by readme-md-generator