Skip to content

Latest commit

 

History

History
97 lines (71 loc) · 2.95 KB

README.md

File metadata and controls

97 lines (71 loc) · 2.95 KB
Raw

Rockbox Zig 🎵 ⚡

GPL-2.0 licensed ci Docker Pulls

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
  • 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 \
    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

✨ Features

  • Zig Build System
  • Rockbox API FFI for Rust
  • gRPC API
  • GraphQL API
  • HTTP API
  • Web Client (React)
  • 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
  • TuneIn Radio
  • MPD Server
  • MPRIS
  • Upnp Player
  • 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.