2021-12-20 18:30:45 +00:00
< p align = "center" >
< img src = "images/Sbar.svg" / >
< / p >
2021-12-20 18:37:25 +00:00
2022-05-14 18:19:55 +00:00
< p align = "center" >
< a href = "https://felixkratz.github.io/SketchyBar/setup" > Install< / a >
< span > • < / span >
< a href = "https://felixkratz.github.io/SketchyBar/config/bar" > Documentation< / a >
< span > • < / span >
< a href = "https://github.com/FelixKratz/SketchyBar/discussions/47" > Setups< / a >
< span > • < / span >
< a href = "https://github.com/FelixKratz/SketchyBar/discussions/12" > Plugins< / a >
< / p >
2021-12-20 23:07:38 +00:00
< p align = "center" >
< a href = "https://opensource.org/licenses/" > < img src = "https://img.shields.io/badge/License-GPL%20v3-blue.svg" > < / a >
2021-12-22 18:35:22 +00:00
< a href = "https://github.com/FelixKratz/SketchyBar/releases" > < img src = "https://img.shields.io/github/v/release/FelixKratz/SketchyBar.svg?style=flat&color=orange" / > < / a >
2021-12-22 18:32:09 +00:00
< a href = "https://github.com/FelixKratz/SketchyBar/releases" > < img src = "https://img.shields.io/github/commits-since/FelixKratz/SketchyBar/latest.svg?color=orange" > < / a >
2021-12-20 23:09:05 +00:00
< a href = "https://en.wikipedia.org/wiki/Free_and_open-source_software" > < img src = "https://img.shields.io/badge/FOSS-100%25-green.svg?style=flat" > < / a >
2021-12-20 23:07:38 +00:00
< / p >
2021-12-20 18:38:52 +00:00
2021-12-20 23:07:38 +00:00
< p align = "center" >
2022-06-17 07:55:52 +00:00
This bar project aims to create a highly flexible, customizable, fast and powerful status bar replacement for people that like playing with
2021-12-20 18:36:07 +00:00
shell scripts.
2021-12-20 23:07:38 +00:00
< / p >
2021-12-20 18:36:07 +00:00
2021-12-22 18:32:09 +00:00
< p align = "center" >
2022-05-14 18:19:55 +00:00
< a href = "https://github.com/FelixKratz/SketchyBar/discussions/47" > More Setups< / a >
2021-12-22 18:32:09 +00:00
< / p >
2021-08-24 09:26:07 +00:00
2022-06-15 23:27:39 +00:00
2021-12-20 23:07:38 +00:00
## Features
2022-06-17 07:55:52 +00:00
* Optimized to be *Fast* and *Efficient*
* Completely *Scriptable*
* Fully *Configurable*
* Entirely *Animatable*
* Support for drawing native macOS menu bar applications (aliases)
2022-05-28 12:02:48 +00:00
* Powerful event and scripting system
2021-12-20 23:07:38 +00:00
* Popup Menus
2022-01-24 22:00:25 +00:00
* Mouse Support
* Support for graphs
* Per display and per space individualization
2021-12-20 23:07:38 +00:00
2022-05-14 18:39:24 +00:00
## Getting Started
Refer to the installation guide in the [documentation ](https://felixkratz.github.io/SketchyBar/setup ) to get the program set up.
2022-05-16 09:56:06 +00:00
Once this is sorted you can start to become familiar with the syntax of sketchybar by going through the default [*sketchybarrc* ](https://github.com/FelixKratz/SketchyBar/blob/master/sketchybarrc ) file,
2022-07-01 15:52:11 +00:00
which is located in `~/.config/sketchybar/sketchybarrc` and looks like this:
2022-05-16 09:56:06 +00:00
All commands and options are explained in detail in the relevant sections
2022-05-14 18:39:24 +00:00
of the configuration [documentation ](https://felixkratz.github.io/SketchyBar/config/bar ). You can try the commands directly from
the commandline to see which affect they have and how they alter the bar. Once you have become familiar with the syntax you can
2022-05-16 09:56:06 +00:00
look for a config to start from [here ](https://github.com/FelixKratz/SketchyBar/discussions/47 ) or start from scratch and customize
everything to your liking.
You might also enjoy looking at the [Tips & Tricks ](https://felixkratz.github.io/SketchyBar/config/tricks ) section
2022-05-14 18:39:24 +00:00
for some further tips on your journey. If you are searching for functional items you might want to check the
[plugins ](https://github.com/FelixKratz/SketchyBar/discussions/12 ) section if someone has already created what you are looking for.
2021-08-14 20:58:01 +00:00
2022-06-26 19:32:33 +00:00
Should you encounter things not working as you expect them to, please *do not* hesitate to open an [issue ](https://github.com/FelixKratz/SketchyBar/issues ), as
this is either a bug or a documentation problem and relevant in any case.
2022-05-14 18:39:24 +00:00
## Documentation
2022-06-17 07:55:52 +00:00
For the full documentation of all commands and properties please refer to the [website ](https://felixkratz.github.io/SketchyBar/config/bar ).
2021-10-10 16:10:36 +00:00
2022-05-16 10:20:36 +00:00
If questions remain, feel free to consult the [Q&A ](https://github.com/FelixKratz/SketchyBar/discussions/categories/q-a ) section.
2022-05-14 18:39:24 +00:00
## Supporting
2022-05-14 18:19:55 +00:00
*You* can support this project is many ways:
2022-07-01 08:24:41 +00:00
- By *creating* issues and pull-requests if you encounter problems
- By *sharing* your [plugins ](https://github.com/FelixKratz/SketchyBar/discussions/12 ) and [setups ](https://github.com/FelixKratz/SketchyBar/discussions/47 )
- By *starring* the project on GitHub
- If this project has value to you, consider quantifying it and *donating* to a charity of your choice. If you want to let me know about your donation, you
can contact me via [email ](mailto:felix.kratz@tu-dortmund.de?Subject=Donation ).
2022-05-14 18:19:55 +00:00
2021-08-18 21:22:01 +00:00
## Credits
2021-10-15 13:11:04 +00:00
This project was forked from *[spacebar](https://github.com/cmacrae/spacebar)* and completely reimagined and rewritten. < br >
The original idea is based on the status bar that was included in *[yabai](https://github.com/koekeishiya/yabai)* before getting removed.
2022-06-15 23:27:39 +00:00
## Demonstration of the animation system
https://user-images.githubusercontent.com/22680421/173958567-c475eaa2-cd56-45c1-86fc-839d697eaad6.mp4
