syohex / champagne

Countdown timer for bubbly events

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Champagne

CI workflow status DCO Check

Animated countdown timer for welcoming all important life events. Also see the countdown package on MELPA.

preview.mp4

It will call functions at the timer start and timer end, allowing you to integrate with other “games” such as snow.el.

Install Champagne

(use-package champagne) ; vanilla

;; using elpaca's with explicit recipe
(use-package champagne
  :elpaca (champagne :host github :repo "positron-solutions/champagne"))

;; straight with explicit recipe
(use-package champagne
  :straight (champagne :type git :host github :repo "positron-solutions/champagne"))

;; or use melpa, manual load-path & require, you brave yak shaver

Use Champagne

;; For a basic countdown, starting right now:
(champagne 5)
;;
;; Count down to some point in the future:
(champagne nil "Sun Jan 23 00:00:00 2023")
;;
;; Count down and call a function at the beginning of the countdown
(champagne nil nil #'parrot-start-animation)
;;
;; Count down and call a function at the end of the countdown
(champagne nil nil nil #'snow)
;;
;; Count down with all behaviors
(champagne 60 "Sun Jan 23 00:00:00 2023" #'parrot-start-animation #'snow)

Contributing

CONTRIBUTING contains instructions on using this repository’s functionality. A DCO and GPL3 license are included with this project.

Do consider buying me a glass of champagne if you find this timer amusing. Github Sponsors is configured.

About

Countdown timer for bubbly events

License:GNU General Public License v3.0


Languages

Language:Emacs Lisp 100.0%