Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mayakarabula/tid-fork
fork of https://git.sr.ht/~ma3ke/tid
https://github.com/mayakarabula/tid-fork
Last synced: 1 day ago
JSON representation
fork of https://git.sr.ht/~ma3ke/tid
- Host: GitHub
- URL: https://github.com/mayakarabula/tid-fork
- Owner: mayakarabula
- License: mit
- Created: 2023-12-10T17:31:16.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2023-12-18T12:30:46.000Z (11 months ago)
- Last Synced: 2024-10-24T18:34:26.445Z (21 days ago)
- Language: Rust
- Size: 269 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# _tid_ — a small system information bar
This little program is in a pretty good state, right now.
It is intended for my personal use, and it is polished enough that it is useful to others as well.
I am enjoying it a lot and it fits my needs.
(See also, accompanying [labbook entry](https://dwangschematiek.nl/labbook/tid/).)
The uf2 font parsing depends on [`fleck`](https://git.sr.ht/~ma3ke/fleck), which is based on the original uf2 parsing code from this project.
## installation
### from source
```
git clone https://git.sr.ht/~ma3ke/tid
cd tid
cargo install --path .
sudo mkdir /etc/tid
sudo cp -r fonts /etc/tid/fonts
sudo cp tid.config /etc/tid
```
(I may put these operations into a makefile or shell script at some point, but it's quite trivial.)
### AUR
The [`tid`](https://aur.archlinux.org/packages/tid) package is available on the AUR!
(Feel free to package _tid_ for other package managers :)
## what it does
- Displays the date and time.
- Can display the battery percentage.
- Displays the memory usage as a percentage.
- Displays the cpu usage as a percentage.
- Displays the cpu usage history as a graph.
- Can show the current playback state of `mpd`.
## usage & configuration
_tid_ can be configured through a `/etc/tid/tid.config` file and command line arguments.
### config file
The config file must (as of now) be located at `/etc/tid/tid.config`.
An [example file](https://git.sr.ht/~ma3ke/tid/tree/main/item/tid.config) is provided in the repository.
Any of the following keywords are recognized, followed by some form of whitespace and an appropriate argument.
Each setting is on a separate line.
The arguments are interpreted in the same manner as the command line arguments.
- `elements`
- `font_name`
- `font_path`
- `foreground`
- `background`
- `mpd_addr`
Whitespace may precede or trail the lines.
Any part of a line beyond `#` is a comment and is ignored.
### command line arguments
- **Want to change the font?**
Fonts can be specified through command line arguments. Use, for example, `--font-name geneva12.uf2` or `--font-path /etc/tid/fonts/geneva12.uf2`.
Currently, the supported font formats are [uf2](https://wiki.xxiivv.com/site/ufx_format.html) and [psf2](https://en.wikipedia.org/wiki/PC_Screen_Font).
For instance, [here](https://hachyderm.io/@ma3ke/111376077963594124) you can see _tid_ running with the beautiful `sun12x22.psfu` font.
Note that uf2 fonts require a `.uf2` extension to be accepted, while `psf2` can be recognized through its magic number.
- **Want to change the color?**
You can set the foreground and background color by providing a `0x{r}{g}{b}{a}` formatted hex string as parameters after the `--fg` and `--bg` flags, respectively.
For example,
```
tid --fg 0xcc33aaff --bg 0xffffff00
```
will set the foreground to a dark magenta and the background to white transparent, like [this](https://hachyderm.io/@ma3ke/111377402365783978).
By default, the background is black and transparent (if supported), and the foreground white.
- **Want to change the order and selection of elements?**
You can :)
The elements can be specified through the command line arguments, or through the config file.
The format for the elements specification string is a space delimited list of any of the following items:
- _padding(``)_
- _space_
- _date_
- _time_
- _label(``)_
- _battery_
- _mem_
- _cpu_
- _cpugraph(``)_
- _playbackstate_
For an example, check the line in the [`tid.config`](https://git.sr.ht/~ma3ke/tid/tree/main/item/tid.config) file.
### full usage information
```
Usage:
tid [OPTIONS]
Options:
--elements Define the elements to be displayed.
This is a space-delimited list of any of the following
items:
- padding() - space
- date - time
- label() - battery
- mem - cpu
- cpugraph() - playbackstate
--font-name -n Set the font name from the default directory.
(default: 'cream12.uf2' in '/etc/tid/fonts')
--font-path -p Set the font path.
--fg Specify the foreground color as an rgba hex string.
(default: 0xffffffff)
--bg Specify the background color as an rgba hex string.
(default: 0x00000000)
--position Set the requested position to spawn the window.
Must be set as 'x,y' without a space, where x and y are
unsigned integers. (default: '0,0')
--mpd-address Specify the address for the mpd connection.
(default: 127.0.0.1:6600)
--version -v Display function.
--help -h Display help.
```
To set the scale factor manually, the `TID_SCALE_FACTOR` environment variable is available.
For example,
```
TID_SCALE_FACTOR=3 tid
```
would make each logical pixel that is rendered 3×3 display pixels in
size.
## contributing
_**NOTE:** If you would like to submit changes, but feel intimidated by doing it by email, that is no problem at all!
Another fine way is to fork the repository elsewhere, push your changes to there, and send me the link to the commit you want me to consider.
Or, just get in touch with a DM or email :)_
Patches can be submitted to `~ma3ke/[email protected]`.
The archives can be found at [lists.sr.ht/~ma3ke/public-inbox](https://lists.sr.ht/~ma3ke/public-inbox).
When submitting a patch via email, please set the subject prefix to `PATCH tid`, by running the following command.
```
git config format.subjectPrefix "PATCH tid"
```
(If you don't know how this stuff works, but want to learn about this, [git-send-email.io](https://git-send-email.io/) is a fantastic hands-on resource.)
## thanks
Thanks to [Maya](https://mayaks.eu/) and [Bauke](https://hachyderm.io/@orkapoes) for testing and suggesting changes to allow _tid_ to run on MacOS.
---
Made with <3 [ma3ke](https://dwangschematiek.nl)