TrevorSatori / kronos

Terminal Music Player Written In Rust
GNU General Public License v3.0
53 stars 8 forks source link
music-player rust terminal terminal-based

Cargo Tests

Kronos - A Customizable Terminal Music Player For Offline Listening

Music Controls

Table of contents

  1. About
  2. Specification
  3. Install
    1. Arch
    2. Binary
    3. Build From Source
  4. Customization
  5. Contribute

About

Kronos is a modern take on terminal music players. Written entirely in the Rust programming language to ensure minimal resource usage and memory safety. Meant for consuming local audio files without the need for internet.

Specification

Supports the following formats

Format --- | aac | flac | mp3 | mp4 | m4a | ogg | wav |

Installation

Works on Linux, untested on Mac

Arch

paru -S satori-kronos-git

Binary

  1. Download Release https://github.com/TrevorSatori/Kronos/releases/tag/v0.69

    Build From Source

  2. Enter the following in Terminal, or download zip from the code dropdown at top of the page. git clone --depth=1 https://github.com/TrevorSatori/Kronos.git

  3. Change into directory cd Kronos/

  4. compile and run cargo run --release

Customization

If the color scheme above isn't for you, it can be changed! Kronos default config path is

~/.config/kronos/config.toml

Below are all the color options for each parameter in the toml file.

black | blue | green | red | yellow | magenta | cyan | gray | dark gray | light red | light green | light yellow | light blue | light magenta | light cyan | white | rgb 0 - 255 |

Customized

The above makes use of both premade color options as well as rgb values and can be recreated with the following inside a config.toml.

[theme]
foreground = "200, 100, 250"
background = "black"
highlight_foreground = "white"
highlight_background = "255, 165, 0" 

[layout]
progress_bar = 20

Contribute

Currently this repo is being built by one full time college student. If you want to help besides leaving a star(Wink wink nudge nudge), make sure to open issues about all problems so they can be resolved immediately. For further ways to contribute visit the CONTRIBUTE PAGE

Calling All Ricers

Actively looking for custom themes to integrate into Kronos, if you enjoy ricing leave a comment on the discussions page.