diff --git a/Source/CountDown.spoon/init.lua b/Source/CountDown.spoon/init.lua index eb42ee2d..b251a8f7 100644 --- a/Source/CountDown.spoon/init.lua +++ b/Source/CountDown.spoon/init.lua @@ -25,22 +25,22 @@ obj.license = "MIT - https://opensource.org/licenses/MIT" -- User-configurable variables ---- Countdown.defaultLenMinutes +--- CountDown.defaultLenMinutes --- Variable --- Default timer in minutes. obj.defaultLenMinutes = 25 ---- Countdown.useLastTimerAsDefault +--- CountDown.useLastTimerAsDefault --- Variable --- if true, make defaultLenMinutes the last time length used obj.useLastTimerAsDefault = true ---- Countdown.nofity +--- CountDown.nofity --- Variable --- set to nil to turn off notification when time's up or provide a hs.notify notification obj.notify = true ---- Countdown.defaultKeyBindings +--- CountDown.defaultKeyBindings --- Variable --- default key bindings obj.defaultKeyBindings = { @@ -50,100 +50,100 @@ obj.defaultKeyBindings = { cancel = {{"cmd", "ctrl", "alt"}, "C"}, } ---- Countdown.messageDuration +--- CountDown.messageDuration --- Variable -- Duration of notification messages obj.messageDuration = 2 ---- Countdown.messageAttributes +--- CountDown.messageAttributes --- Variable -- Properties of progress message obj.messageAttributes = {atScreenEdge = 0, textSize = 40} -- bar: progress bar at the bottom of the screen ---- Countdown.barCanvasHeight +--- CountDown.barCanvasHeight --- Variable --- indicator bar at the bottom of the screen obj.barCanvasHeight = 5 ---- Countdown.barTransparency +--- CountDown.barTransparency --- Variable --- Transparency for progress bar obj.barTransparency = 0.8 ---- Countdown.barFillColorPassed +--- CountDown.barFillColorPassed --- Variable --- Color for time passed in progress bar obj.barFillColorPassed = hs.drawing.color.osx_green ---- Countdown.barFillColorToPass +--- CountDown.barFillColorToPass --- Variable --- Color for time to pass in progress bar obj.barFillColorToPass = hs.drawing.color.osx_red -- alert: what happens when the timer is up? ---- Countdown.alertLen +--- CountDown.alertLen --- Variable --- time to show the end-of-time alert. 0 implies do not show obj.alertLen = 5 ---- Countdown.alertSound +--- CountDown.alertSound --- Variable --- Sounds to play when time is up. No sound if nil obj.alertSound = "Sonar" ---- Countdown.alertAttributes +--- CountDown.alertAttributes --- Variable --- how to display timer is up notification obj.alertAttributes = {atScreenEdge = 1} -- warning related configuration ---- Countdown.warningShow +--- CountDown.warningShow --- Variable --- Do we show progress warnings. A progress warning happens --- at logarithmic intervals: 1, 2, 4, 8, 16... minutes --- before timer expiration obj.warningShow = true ---- Countdown.warningFormat +--- CountDown.warningFormat --- Variable --- Format to display the warning. --- It takes two integers: hours and minutes obj.warningFormat = "Time left %02d:%02d" ---- Countdown.warningshowDuration +--- CountDown.warningshowDuration --- Variable --- for how many seconds to show the warning obj.warningshowDuration = 3 -- menu bar related ---- Countdown.menuBarAlwaysShow +--- CountDown.menuBarAlwaysShow --- Variable --- If true, always show the menu bar icon. --- if false, only show when timer active --- (shows pause, cancel toggle) obj.menuBarAlwaysShow=false ---- Countdown.menuBarIconIdle +--- CountDown.menuBarIconIdle --- Variable --- icon to show in menu bar when idle obj.menuBarIconIdle = "⏰" ---- Countdown.menuBarIconActive +--- CountDown.menuBarIconActive --- Variable --- icon to show in menu bar when active obj.menuBarIconActive = "☣️" ---- Countdown.menuBarIconPlay +--- CountDown.menuBarIconPlay --- Variable --- icon for resume playing in menu bar submenu obj.menuBarIconPlay = "▶️️" ---- Countdown.menuBarIconPause +--- CountDown.menuBarIconPause --- Variable --- icon for pause playing in menu bar submenu obj.menuBarIconPause = "⏸️" ---- Countdown.menuBarIconStop +--- CountDown.menuBarIconStop --- Variable --- icon for cancelling timer in menu bar submenu obj.menuBarIconStop = "🛑"