mirror of
https://github.com/FelixKratz/SketchyBar
synced 2024-11-10 13:54:16 +00:00
98 lines
5.2 KiB
Markdown
98 lines
5.2 KiB
Markdown
<p align="center">
|
|
<img src="images/Sbar.svg" />
|
|
</p>
|
|
|
|
<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?sort=top">Setups</a>
|
|
<span> • </span>
|
|
<a href="https://github.com/FelixKratz/SketchyBar/discussions/12?sort=top">Plugins</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://opensource.org/licenses/"><img src="https://img.shields.io/badge/License-GPL%20v3-blue.svg"></a>
|
|
<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>
|
|
<a href="https://github.com/FelixKratz/SketchyBar/releases"><img src="https://img.shields.io/github/commits-since/FelixKratz/SketchyBar/latest.svg?color=orange"></a>
|
|
<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>
|
|
</p>
|
|
|
|
<p align="center">
|
|
This bar project aims to create a highly flexible, customizable, fast and powerful status bar replacement for people that like playing with
|
|
shell scripts.
|
|
</p>
|
|
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/FelixKratz/SketchyBar/discussions/47?sort=top">More Setups</a>
|
|
</p>
|
|
|
|
|
|
|
|
## Features
|
|
* Full *configurability* at any time
|
|
* Dynamic *animation* system
|
|
* Powerful *scripting* and *event* system
|
|
* Optimized to be *fast* and *efficient*
|
|
* Interactive *mouse* support
|
|
* Support for displaying macOS menu bar apps (*aliases*)
|
|
* Can draw arbitrary *graphs*
|
|
* On-demand *popup* menus
|
|
|
|
The main design principle of this project is that *all* elements of the bar can
|
|
be added, removed and freely changed at any point in time. Thus, the
|
|
configuration of the bar is not *static*, rather it is possible to adapt the
|
|
appearance of the bar completely dynamically with the help of a powerful
|
|
event-driven scripting system at any point in time using the highly
|
|
configurable basic building blocks SketchyBar offers.
|
|
|
|
## Getting Started
|
|
Refer to the installation guide in the [documentation](https://felixkratz.github.io/SketchyBar/setup) to get the program set up.
|
|
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 and the default [*plugin scripts*](https://github.com/FelixKratz/SketchyBar/blob/master/plugins),
|
|
which are located in `~/.config/sketchybar/` and look like this:
|
|
|
|
|
|
|
|
All commands and options are explained in detail in the relevant sections
|
|
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
|
|
look for a config to start from [here](https://github.com/FelixKratz/SketchyBar/discussions/47?sort=top) 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
|
|
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?sort=top) section if someone has already created what you are looking for.
|
|
|
|
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.
|
|
|
|
## Documentation
|
|
For the full documentation of all commands and properties please refer to the [website](https://felixkratz.github.io/SketchyBar/config/bar).
|
|
|
|
If questions remain, feel free to consult the [Q&A](https://github.com/FelixKratz/SketchyBar/discussions/categories/q-a) section.
|
|
|
|
## Supporting
|
|
*You* can support this project is many ways:
|
|
- 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).
|
|
|
|
## Credits
|
|
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.
|
|
|
|
|
|
## Related Projects
|
|
- [SbarLua](https://github.com/FelixKratz/SbarLua): A Lua API for SketchyBar
|
|
- [sketchybar-app-font](https://github.com/kvndrsslr/sketchybar-app-font): A symbol font for SketchyBar
|
|
- [SketchyBarHelper](https://github.com/FelixKratz/SketchyBarHelper): A header for C/C++ to directly communicate with SketchyBar
|
|
|
|
## Some animation examples
|
|
|
|
https://user-images.githubusercontent.com/22680421/211198711-45318f04-e96f-4aa1-a0ba-c7f30f050902.mp4
|
|
|
|
|