Skip to content

Rockbox as a Music Player Daemon. This project brings modern enhancements to the classic Rockbox firmware, using Zig and Rust for improved performance and maintainability ⚡ 🦀

License

Notifications You must be signed in to change notification settings

tsirysndr/rockbox-zig

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rockbox Zig 🎵 ⚡

GPL-2.0 licensed ci Docker Pulls GitHub Downloads (all assets, all releases) discord storybook

Rockbox UI

A modern take on the Rockbox open-source firmware with enhancements in Zig and Rust. This project offers:

  • gRPC & GraphQL APIs for seamless interaction and control
  • Chromecast support for streaming to your TV
  • MPD server for compatibility with existing clients
  • MPRIS support for desktop integration
  • TypeScript support for building powerful extensions

Take advantage of modern tooling while preserving the core functionality of Rockbox.

Note

🐲 It is a work in progress and is not yet ready for use. 🏗️🚧

Preview

🚀 Quickstart

To quickly get started, you can run the following docker command:

docker run \
    --device /dev/snd \
    --privileged \
    -p 6061:6061 \
    -p 6062:6062 \
    -p 6063:6063 \
    -p 6600:6600 \
    -v $HOME/Music:/root/Music \
    tsiry/rockbox:latest

Run the following commands to build the project:

sudo apt-get install libusb-dev libsdl1.2-dev libfreetype6-dev libunwind-dev zip protobuf-compiler
mkdir -p build && cd build
../tools/configure --target=sdlapp --type=N --lcdwidth=320 --lcdheight=240 --prefix=$HOME/.local
make zig

🚚 Installation

with curl (Ubuntu/Debian):

curl -fsSL https://raw.githubusercontent.com/tsirysndr/rockbox-zig/HEAD/install.sh | bash

MacOS, currently not supported, but you can run in a docker container.

📦 Downloads

✨ Features

  • Zig Build System
  • Rockbox API FFI for Rust
  • gRPC API
  • GraphQL API
  • HTTP API
  • Web Client (React)
  • Fast search engine, built with Tantivy
  • Desktop Client (Electron/Gtk)
  • Terminal Client (TUI)
  • Android Library
  • Mobile version (React Native)
  • Stream from Youtube (audio only)
  • Stream from Spotify
  • Stream from Tidal
  • Stream to Chromecast
  • Stream to Kodi
  • TuneIn Radio
  • MPD Server
  • MPRIS
  • UPnP/DLNA
  • Airplay
  • TypeScript (Deno) API (for writing plugins)
  • Wasm extensions

🧑‍🔬 Architecture

architecture

📚 GraphQL API

Open http://localhost:6062/graphiql in your browser.

📚 HTTP API

Open http://localhost:6063 in your browser.

📚 gRPC API

https://buf.build/tsiry/rockboxapis/docs/main:rockbox.v1alpha1

Try Rockbox gRPC API using Buf Studio.

About

Rockbox as a Music Player Daemon. This project brings modern enhancements to the classic Rockbox firmware, using Zig and Rust for improved performance and maintainability ⚡ 🦀

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Languages

  • C 84.6%
  • C++ 6.8%
  • Assembly 1.9%
  • Rust 1.9%
  • TeX 1.4%
  • TypeScript 0.9%
  • Other 2.5%