Skip to content

nebyu08/kyoka

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🦀 kyoka

A terminal music player written in Rust.

Demo

Features:

  • Scans your system for audio files
  • TUI interface for browsing and playing music
  • Playback controls with keyboard navigation

Prerequisites

  • Rust (1.56 or later)
  • A directory containing audio files (MP3, FLAC, WAV, etc.)

Getting Started

Step 1: Clone the Repository

git clone https://github.com/nebyu08/kyoka.git
cd kyoka

Step 2: Build the Project

cargo build --release

This creates an optimized binary in target/release/kyoka.

Step 3: Run the Application

Option A: Scan entire home directory (default)

cargo run --release

Option B: Scan a specific music directory

If all your music is in a particular directory, use:

cargo run --release -- --dir ~/Music

Replace ~/Music with the path to your music folder.

Step 4: Use the Player

Navigate and control the music player using these keyboard shortcuts:

Key Action
Tab Switch between screens
↑/↓ Navigate songs
G Move track down
gg Move track up
Enter Play selected song
Space Pause/resume
q Quit

Tech Stack

  • ratatui - Terminal UI framework
  • crossterm - Terminal handling
  • rodio - Audio playback
  • tokio - Async runtime
  • walkdir - Filesystem traversal
  • rayon - Parallel processing

License

MIT

About

kyoka is an music player in the terminal and the name means "wild poetry" in japanease

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages