SketchyBar README

The project's README from github.com/FelixKratz/SketchyBar. As one markdown file: README.md.

Install • Documentation • Setups • Plugins

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

More Setups

Features

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 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 and the default plugin scripts, 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. 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.

Should you encounter things not working as you expect them to, please do not hesitate to open an issue, 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.

If questions remain, feel free to consult the Q&A section.

Supporting

You can support this project is many ways:

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.

Some animation examples

https://user-images.githubusercontent.com/22680421/211198711-45318f04-e96f-4aa1-a0ba-c7f30f050902.mp4

SketchyBar (FelixKratz/SketchyBar)

Searching Database…

Что это такое?SketchyBar — это сильно настраиваемая замена строки состояния macOS, созданная для тех, кто любит настраивать её с помощью скриптов командной оболочки.
Настраивается это через графический интерфейс или через написание скриптов?Графического интерфейса настроек нет: панелью полностью управляет конфигурационный файл sketchybarrc и скрипты-плагины. Используется система скриптов, управляемая событиями, поэтому элементы можно добавлять, удалять или менять в любой момент во время работы.
Как запустить это на своём Mac?Следуйте инструкции по установке в официальной документации, чтобы установить программу, затем начните редактировать стандартный sketchybarrc и скрипты-плагины, которые находятся в ~/.config/sketchybar/.
Нужен ли yabai или другой тайлинговый оконный менеджер?Нет, SketchyBar работает самостоятельно. Но он вырос из строки состояния, которая раньше поставлялась с yabai, до того как эта функция была удалена, поэтому его часто используют вместе с настройками yabai.
Для кого это на самом деле?Это рассчитано на энтузиастов кастомизации macOS и пользователей тайлинговых оконных менеджеров, которым нравится править скрипты командной оболочки, чтобы получить полностью свою панель, а не стандартную.
Работает ли это на других ОС, кроме macOS?Нет, это только для macOS: оно заменяет встроенную строку состояния macOS.
Можно ли показывать в панели иконки приложений или свои графики?Да. SketchyBar может выводить в панель иконки запущенных приложений из строки меню macOS, рисовать произвольные графики и показывать всплывающие меню по запросу для элементов.
Что такое SbarLua?SbarLua — это вспомогательный API для написания конфигов SketchyBar на Lua вместо командной оболочки. Также есть проект sketchybar-app-font, который предоставляет глифы иконок приложений для панели.
Почему SketchyBar создали, а не использовали существующую панель?Проект создан как форк проекта 'spacebar' и полностью переосмыслен. Исходная идея восходит к строке состояния, которая раньше поставлялась с yabai, до того как эта функция была удалена.
Creator
FelixKratz
Size
16.1 MB
Stars
12.5K
Age
5y
Commits · 90 Days