2 releases
0.9.2 | Sep 9, 2023 |
---|---|
0.9.1 | Sep 9, 2023 |
#2870 in Command line utilities
2MB
988 lines
verses
Verses is a TUI tool to view synchronized Spotify lyrics.
Installation
AUR (for Arch users)
Verses is available on AUR under verses-bin
yay -S verses-bin
With cargo:
cargo install verses
From source:
git clone https://github.com/Maxuss/verses
cd verses
cargo install --path .
Prerequesities
To track spotify stats you will have to create your own Spotify developer app here.
Run verses
for the first time and it will prompt you for your
Client ID. You can get it in the Settings section of your app dashboard. Do not confuse it with client secret!
After that, you can run verses.
Controls
q
- quita
- toggle auto-scrollingj
|down key
- scroll downk
|up key
- scroll upr
- reset scroll position
Config
Config file is located at $HOME/.config/verses/config.toml
Each TOML section can be included in a separate file, just specify it using the include
field.
For example:
# config.toml
[theme]
include = "themes/catppuccin.toml"
# themes/catppuccin.toml
[borders]
# configuration there...
[lyrics]
# ...
[progress_bar]
# ...
Config has certain special value types:
general.display.*_format
These are formatting strings using the Handlebars syntax, specifically the Rust implementation.
Available variables are listend in the example config. There is also an utility function join
that allows to join a list of strings separated by a comma.
Colors
Colors can either be represented the Ratatui stringified way or as a hex RGB value, prefixed with #
Border styles
These are enum variants. You can see all variants here
Windows support
Windows was not tested at all, and while it should run well, I do not guarantee flawless performance
Dependencies
~19–35MB
~543K SLoC