Skip to content

aviraldb/muted

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mtd (muted)

mtd (short for MUsic TErminal Daemon) is a Unix-based, terminal music player written in Rust.

The project exists primarily as a learning exercise to understand Rust through building a real, structured systems application involving audio playback, IPC, async execution, and terminal interfaces.

This is not a general-purpose music player and does not aim to compete with existing tools.


Scope

  • Terminal-based
  • Unix-only (Linux and macOS)
  • Local music playback
  • Minimal, structured design

Design Overview

mtd follows a daemon–client model:

  • A background daemon manages audio playback and application state
  • Clients (CLI / TUI) communicate with the daemon via IPC
  • Audio playback is handled through a high-level Rust audio stack

Detailed design documentation is available in the docs/ directory.


Technology

  • Rust
  • rodio (audio playback)
  • tokio (async runtime)
  • ratatui + crossterm (terminal UI)
  • Unix domain sockets (IPC)
  • serde (serialization)

Status

Early development.
APIs, structure, and behavior are subject to change.


Documentation

Project documentation is organized under the docs/ directory:

  • architecture.md — overall system design
  • audio.md — audio playback approach
  • ipc.md — inter-process communication
  • roadmap.md — planned milestones

License

GPLv3

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages