Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kantord/twm-status-builder
See only the most relevant information in your status bar
https://github.com/kantord/twm-status-builder
Last synced: about 2 months ago
JSON representation
See only the most relevant information in your status bar
- Host: GitHub
- URL: https://github.com/kantord/twm-status-builder
- Owner: kantord
- License: agpl-3.0
- Created: 2020-09-11T10:22:44.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-03T06:49:17.000Z (3 months ago)
- Last Synced: 2024-07-28T23:28:27.126Z (about 2 months ago)
- Language: Shell
- Size: 1.2 MB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- Awesome-Polybar - Status one liner
README
# twm-status-builder
`twm-status-builder` is a script that helps you compile succint information as text to be displayed
in the status bar of your (tiling) window manager. Should work with any status bar that is able to
display text from a shell script. Might also be used in your terminal.
## Usage
```
./twm-status-builder.sh [modules]
```
You have to supply a comma-separated list of modules to display. **The first module to have
a non-empty output will be displayed**. Example:
```
./twm-status-builder.sh pomodoro,calendar/upcoming,calendar/summary
```
See the documentation for each module to see the required configuration.
List of currently available modules: [calendar/summary](#summary-of-your-day), [calendar/upcoming](#summary-of-ongoing-and-upcoming-events), [pomodoro](#pomodoro), [weather](#weather), [task/count](#count), [task/strawberries](#strawberries), [task/emojis](#emojis), [battery/headphones](#headphones), [battery/laptop](#laptop-battery), [battery/controller](#controller-battery)
### Usage with polybar
Example:
```
[module/status_one_liner]
type = custom/script
exec = twm-status-builder.sh pomodoro,calendar/upcoming,calendar/summary
interval = 0.5
```
### Cycling through multiple modules
If you have modules that could produce important information at the same time, you can cycle through
them. Use this feature sparingly, as it can be distracting. To cycle between modules, prepend each
module with a `>` character. Example:
```
./twm-status-builder.sh pomodoro,>calendar/upcoming,>calendar/summary
```
## Modules
### Calendar
The calendar modules rely on `khal` for data. In order to use the calendar modules, you need
to first [install khal](https://github.com/pimutils/khal). If you follow the instructions there,
you'll be able to connect to CalDAV servers, such as Google Calendar.
#### Summary of your day
**module name**: `calendar/summary`
Provides a visual summary of your day using emoji. Each emoji represents a half-hour block,
for for example a one-hour meeting will be represented by `๐
๐
`. Any half hour block with a
meeting will be represented with `๐
`, even if the meeting starts in the middle of the half
hour block.
Put the following configuration into your `.twm-status-builder-rc`:
```
let FIRST_HOUR=7
let LAST_HOUR=23
let START="2*FIRST_HOUR"
let END="2*LAST_HOUR"
let WORK_START="2*10"
let WORK_END="2*18"
let LUNCH_BREAK_START="2*13"
let LUNCH_BREAK_END="LUNCH_BREAK_START + 2"
```
Keep in mind that `calendar/summary` is based on half-hour blocks. You have to specify times in
half-hour blocks, not hours. Therefore `let WORK_START="2*10"` means work starts at 10am.
**Legend**:
* `๐` - Current time
* `โฐ` - Wake up time
* `๐ค` - Sleep time
* `๐ฉ` - Free time
* `๐ฆ` - Work time
* `๐
` - Meetings and calendar events
* `๐ด` - Lunch break
**output example**:
`โฐ๐ฉ๐ฉ๐ฉ๐ฉ๐ฉ๐ฉ๐
๐ฆ๐ฆ๐ฆ๐๐ด๐ด๐ฆ๐
๐
๐
๐
๐
๐
๐ฆ๐ฆ๐ฉ๐ฉ๐ฉ๐ฉ๐ฉ๐ฉ๐ฉ๐ฉ๐ฉ๐ค`
#### Summary of ongoing and upcoming events
**module name**: `calendar/upcoming`
Provides a summary of ongoing and up
**output example**:
`๐
In 51m: Dev standup`
### Pomodoro
**module name**: `pomodoro`
If you use the Pomodoro technique, you might want to hide your other information
and instead see your Pomodoro status. The `pomodoro` module lets you do that using
[i3-gnome-pomodoro](https://github.com/kantord/i3-gnome-pomodoro).
In order to use this module, please set up
[i3-gnome-pomodoro](https://github.com/kantord/i3-gnome-pomodoro) first.
**output example**:
`๐
Pomodoro 23:47`
### Weather
**module_name**: `weather:{city}`
This module shows weather information about a given city, for example `weather:London` or `weather:Berlin`.
Cities with spaces in their name can be spelled like so: `weather:New_York`.
**output example**:
`New York: โ๏ธ +18ยฐC`
### Taskwarrior
#### Count
**module_name**: `task/count`
This module shows the count of (over) due tasks in taskwarrior.
**output example**:
`11 tasks due`
**module_name**: `task/count_icon`
Same as `task/count`, but with an icon. Needs [nerd fonts](https://www.nerdfonts.com/).
**output example**:
`๏ซ11`
#### Strawberries
**module_name**: `task/strawberries`
This module shows the count of (over) due tasks in taskwarrior, represented as `๐` characters.
**output example**:
`๐๐๐๐๐๐๐๐๐๐๐`
#### Emojis
**module_name**: `task/emojis`
This module shows the count of (over) due tasks in taskwarrior, each task represented
by an emoji that corresponds to its project. For this to work, you need to
set your project names to emoji.
**output example**:
`๐ข๐งน๐ช๐`
#### Headphones
**module_name**: `battery/headphones`
This module shows the battery level of your bluetooth headphones as long as they are
connected and as long as this feature is supported in `upower` for your headphones.
**output example**:
`๐ง 70%`
#### Laptop battery
**module_name**: `battery/laptop`
This module shows the battery level of your laptop as long as there is a
battery installed.
**output example**:
`๐ป 70%`
#### Controller battery
**module_name**: `battery/controllers`
This module shows the battery level of your bluetooth controllers as long as they are
connected and as long as this feature is supported in `upower` for your controllers.
**output example**:
`๐ฎ 70%`