# chelydra

![logo](https://hg.sr.ht/~ser/chelydra/raw/assets/chelydra.svg?rev=tip)

chelydra is a [Snapcast](https://github.com/snapcast/snapcast) client GUI interface

[Project Home](https://hg.sr.ht/~ser/chelydra)
★ [![Build status](https://builds.sr.ht/~ser/chelydra/.build.yml.svg)](https://builds.sr.ht/~ser/chelydra/.build.yml?)
★ [Releases](https://downloads.ser1.net/software/chelydra/)
★ ![Latest release](https://downloads.ser1.net/software/chelydra/badges/latest_release.svg)

chelydra is a GUI interface for light configuration, starting, and stopping a
Snapcast client. Its purpose is to make running a client on a mobile device
easier; consequently, it's designed for mobile form factor. chelydra is not,
itself, a Snapcast client -- you must also have snapclient installed.

## Installation

You can grab a binary from [the releases page](https://downloads.ser1.net/software/chelydra/); binaries are provided for
Linux amd64 and arm64 (arm64 should run on the FLX1s). RPM, debs, and Arch packages
are also provided.

Or, you can `go install` it with

```bash
go install ser1.net/chelydra@latest
```

The binary will be found as `$(go env GOPATH)/bin/chelydra`. Alternatively, you
can check this repository out and compile it with:

```bash
$ hg clone https://hg.sr.ht/~ser/chelydra
$ cd chelydra
$ go build .
```

The resulting binary will be `chelydra` in the source directory.

If you have [nFPM](https://nfpm.goreleaser.com/) installed, you can build
the release packages with `nfpm pkg -p <distr>` where `<distro>` is one
of:

- archlinux
- rpm
- deb
- apk

There is a `chelydra.desktop` for your desktop launcher; you will have to change
the `Exec` path to wherever you put the executable. There is also a
`chelydra.svg` suitable as a desktop icon; your desktop will look for it as either
`/usr/share/icons/chelydra.svg` or `~/.local/share/icons/chelydra.svg`.
