Rbtclk
A light-weight timer application that can run in terminal emulators :rabbit:
Requirement
- Ruby 2.0 or later.
Installation
$ (sudo) gem install 'rbtclk'
Usage
Basic usage
$ rbtclk
## ###### ###### #### ## ###
### ## ## ## ## ## ## ### ##
## ##### ## ##### ## ## ## #### ##
## ## ## ## ## ## ## #####
## ## ## ## ## ###### ## ##
## ## ## ## ## ## ## ## ## ## ## ##
## #### ## #### #### ## #### ####
Mode
This application supports some modes; clock, countup and countdown.
Example
$ rbtclk --mode clock
$ rbtclk -m clock
## ###### ###### #### ## ###
### ## ## ## ## ## ## ### ##
## ##### ## ##### ## ## ## #### ##
## ## ## ## ## ## ## #####
## ## ## ## ## ###### ## ##
## ## ## ## ## ## ## ## ## ## ## ##
## #### ## #### #### ## #### ####
$ rbtclk --mode countup
$ rbtclk -m countup
#### #### #### #### ## ####
## ## ## ## ## ## ## ## ## ## ### ## ##
## ## ## ## ## ## ## ## ## ## ## ##
## ## ## ## ## ## ## ## ## ###
## ## ## ## ## ## ## ## ## ##
## ## ## ## ## ## ## ## ## ## ## ## ##
#### #### ## #### #### ## ## ####
$ rbtclk --mode countdown --time 90
$ rbtclk -m countdown --time 90
#### #### #### ## #### ####
## ## ## ## ## ## ## ### ## ## ## ## ##
## ## ## ## ## ## ## ## ## ## ## ##
## ## ## ## ## ## ## ### ## ##
## ## ## ## ## ## ## ## ## ##
## ## ## ## ## ## ## ## ## ## ## ## ##
#### #### ## #### ## ## #### ####
Change font
This application depends on artii library (https://github.com/miketierney/artii).
You can use any fonts that are supported by artii.
Example
$ rbtclk --font clb8x8 # default
## ###### ###### #### ## ###
### ## ## ## ## ## ## ### ##
## ##### ## ##### ## ## ## #### ##
## ## ## ## ## ## ## #####
## ## ## ## ## ###### ## ##
## ## ## ## ## ## ## ## ## ## ## ##
## #### ## #### #### ## #### ####
$ rbtclk --font univers
88 8888888888 8888888888 ad8888ba, ,a8888a, ad8888ba,
,d88 88 88 8P' "Y8 ,8P"' `"Y8, 8P' "Y8
888888 88 ____ 88 ____ d8 ,8P Y8, d8
88 88a8PPPP8b, 888 88a8PPPP8b, 88,dd888bb, 888 88 88 88,dd888bb,
88 PP" `8b 888 PP" `8b 88P' `8b 888 88 88 88P' `8b
88 d8 d8 88 d8 `8b d8' 88 d8
88 Y8a a8P 888 Y8a a8P 88a a8P 888 `8ba, ,ad8' 88a a8P
88 "Y88888P" 888 "Y88888P" "Y88888P" 888 "Y8888P" "Y88888P"
$ rbtclk --font smkeyboard
____ ____ ____ ____ ____ ____ ____ ____
||1 |||5 |||: |||5 |||6 |||: |||4 |||6 ||
||__|||__|||__|||__|||__|||__|||__|||__||
|/__\|/__\|/__\|/__\|/__\|/__\|/__\|/__\|
Specify format
You can specify format of time by Time#strftime style.
Default format is "%X".
Example
$ rbtclk --format "* %H:%M *"
# ## ### #### ## #
# ### ## ## ## ## ### #
## # ## ## ## ## ## ## #### ## # ##
### ## ##### ## ## ## ## ###
# ## ## ## ## ## ###### #
# # ## ## ## ## ## ## ## # #
# # ## #### ## #### #### # #
Enable color
Rbtclk can show clock with ANSI colors.
Black(default), red, green, yellow, blue, magenta, cyan and white are available.
Example
$ rbtclk -c magenta
$ rbtclk --color magenta
Configuration by .rbtclk file
The default bhavior can be changed by ~/.rbtclk file.
Sample config file is in RBTCLK_ROOT/config/default.rb.
Rbtclk.configure do |c|
# clock, countup and countdown are available.
c.mode = "clock"
# Font setting depends on Artii library.
# https://github.com/miketierney/artii/tree/master/lib/figlet/fonts
# You can use a lot of font types.
c.font = "clb8x8"
# You can use Ruby's Date#strftime style.
# It is compatible with strftime(3) of standard C library.
c.format = "%X"
# black, red, green, yellow, blue, magenta, cyan and white are available.
c.color = "black"
# You can specify limit time as seconds in countdown timer.
c.time = "180"
end
Progress Report
- [x] Clock
- [x] Countup Timer
- [x] Countdown Timer
- [x] Configuration by ~/.rbtclk
- [ ] Sound
- [ ] Refactoring
Code Status
Contributing
- Fork it ( https://github.com/mozamimy/rbtclk/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request