Mirrors/SketchyBar
2
0
Fork 0
mirror of https://github.com/FelixKratz/SketchyBar synced 2024-11-23 11:53:02 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
613 commits 3 branches 97 tags 17 MiB
C 95.2%
Objective-C 3.8%
Makefile 0.5%
Shell 0.5%
Find a file
Felix Kratz ddfea5392c ...
2022-06-04 21:02:08 +02:00
images adapt bar item image for v2 syntax 2021-12-24 13:47:06 +01:00
plugins remove optional flag and deprecated property from demo config 2022-04-20 23:47:28 +02:00
src ... 2022-06-04 21:02:08 +02:00
.gitignore added cmake system and fix compatibility quirks 2021-10-06 20:59:47 +02:00
DOCS.md Shorten README and refer to new documentation 2022-05-13 08:56:22 +02:00
LICENSE.md Create LICENSE.md 2021-10-06 16:42:41 +02:00
makefile started animation implementation 2022-05-16 15:00:39 +02:00
README.md push animation update (#148) 2022-05-28 14:02:48 +02:00
sketchybarrc add more comments to default sketchybarrc 2022-05-16 08:38:23 +02:00

README.md

Install • Documentation • Setups • Plugins

This bar project aims to create a highly flexible, customizable, fast and powerful status bar replacement for users that like playing around with shell scripts.

More Setups

Features

  • Performance friendly
  • Fully scriptable
  • Fully configurable
  • Supports drawing native macOS menu bar applications (Aliases)
  • Powerful event and scripting system
  • Animation System
  • Popup Menus
  • Mouse Support
  • Support for graphs
  • Per display and per space individualization

Getting Started

Refer to the installation guide in the documentation 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 file, which is located in ~/.config/sketchybar/sketchybarrc.

All commands and options are explained in detail in the relevant sections of the configuration documentation. 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 or start from scratch and customize everything to your liking.

You might also enjoy looking at the Tips & Tricks section for some further tips on your journey. If you are searching for functional items you might want to check the plugins section if someone has already created what you are looking for.

Documentation

For the full documentation of all commands and properties please refer to the website or if you prefer a single document, see the markdown version of the docs.

If questions remain, feel free to consult the 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 and setups
  • By starring the project on GitHub
  • By donating to a charity of your choice

Credits

This project was forked from spacebar and completely reimagined and rewritten.
The original idea is based on the status bar that was included in yabai before getting removed.