Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 2.09 KB

README.md

File metadata and controls

43 lines (31 loc) · 2.09 KB
Raw

Amethyst

A home audio solution. Kind of. More like, a home audio solution for the future; currently a WIP.

license GitHub release SPM Build Status codebeat badge

Overview

Amethyst is a bundled deployment for wireless, synchronized audio playback to multiple clients. The project is built on top of Crystal, and is a collection of content, metadata, and control servers orchestrated by a CLI (or status bar applicaiton) and consumed by player client applications. Amethyst is targeted at single home deployments serving a few clients with single instances of each server. IE, it is not set up for multi-node deployments, load balancing, authenticated content, etc.

Usage

  • Run the CLI or Bar application on a Mac to serve audio.
  • Run the client applications to play the audio.

Build and Run the Bar app

Use the Xcode workspace. The status bar app is a convenient way to configure, manage, and monitor Amethyst's functions. This is the intended entry point for general consumers of this solution.

Build and Run CLI

Of course, a CLI is provided for scriptability.

Using the Swift compiler...

git clone https://github.com/randymarsh77/amethyst.git
cd amethyst
./scripts/build.sh
./bin/amethyst

Or, build and run from the Xcode workspace.

Caveats

  • The only player implemented is iOS, and it's swift 3 requiring iOS 10+ :(

Future

  • Improve the things that exists; these are far from "feature complete".
  • Build Linux and web clients (Likely the Linux clients will be headless CLI, and a web client for GUI)
  • Port iOS builds back to iOS 9, somehow. :/