battery

README

battery - Draw battery unicode art written by Go

battery unicode art on your tmux sessions or the terminal.

Status

(2019-11-03)
Supported to display patched fonts.
Very Thanks TsutomuNakamura!!

Let's run battery -i after installed patched fonts. See more details.

(2018-05-01)
Supported to show elapsed time.
Very Thanks delphinus!!

Let's run battery -e

(2016-10-24)
linux supported.
Thanks mattn!!

(2016-10-21)
windows supported.

(2016-10-20)
Now, this command can use mac user only.
However, I hope to support windows and linux, bsd in future.
So, plz help me (´；ω；｀)

Installation

go get -u github.com/Code-Hex/battery/cmd/battery

Usage

For tmux user, please write #(battery -t) in your .tmux.conf
Please refer to this

Support patched fonts

You can display the status of battery with patched fonts. Installing the font, Inconsolata Nerd Font Complete.otf for example, you can do it like below.

• For mac

cd ~/Library/Fonts/
wget https://raw.githubusercontent.com/ryanoasis/nerd-fonts/master/patched-fonts/Inconsolata/complete/Inconsolata%20Nerd%20Font%20Complete.otf

• For Linux

cd ~/.local/share/fonts
wget https://raw.githubusercontent.com/ryanoasis/nerd-fonts/master/patched-fonts/Inconsolata/complete/Inconsolata%20Nerd%20Font%20Complete.otf

• For Windows

* Open your browser then fill this url
  https://raw.githubusercontent.com/ryanoasis/nerd-fonts/master/patched-fonts/Inconsolata/complete/Inconsolata%20Nerd%20Font%20Complete.otf
* Double click the file that you downloaded and the window will be opened
* Click the install button

Your environment might require to reboot the OS. If so, reboot your OS. Then open your terminal and set your preferences to use it.

Then for tmux user, please write #(battery -t -i) in your .tmux.conf.

Contributor 🎊

• mattn
• yasu47b
• b4b4r07
• delphinus
• TsutomuNakamura

Author

codehex

Documentation

Index

• func Info() (percent int, elapsed int, present bool, err error)
• type Bar
  • func New(total int) *Bar
  • func (bar *Bar) Run()
  • func (bar *Bar) Set(percent, elapsed int) *Bar
  • func (bar *Bar) SetPostfix(char rune) *Bar
  • func (bar *Bar) SetPrefix(char rune) *Bar
  • func (bar *Bar) SetWidth(width int) *Bar

Functions

func Info

func Info() (percent int, elapsed int, present bool, err error)

Types

type Bar

type Bar struct {
	ShowPercent bool
	ShowCounter bool
	Showthunder bool
	ShowElapsed bool
	ShowIcon    bool
	EnableColor bool
	EnableTmux  bool
	// contains filtered or unexported fields
}

func New

func New(total int) *Bar

func (*Bar) Run

func (bar *Bar) Run()

func (*Bar) Set

func (bar *Bar) Set(percent, elapsed int) *Bar

func (*Bar) SetPostfix

func (bar *Bar) SetPostfix(char rune) *Bar

func (*Bar) SetPrefix

func (bar *Bar) SetPrefix(char rune) *Bar

func (*Bar) SetWidth

func (bar *Bar) SetWidth(width int) *Bar