[![maintained](https://img.shields.io/maintenance/yes/2024)]()

# 🦔 sanic

chaos music control inspired by [relaxx player][relaxx]

## ✨ Features

- mpd web gui
  - search music
  - organize playlists
  - control current playback queue
- no authentication required to control music playback
- add playlists from internet radios (`*.m3u`, `*.pls`)
- add music from other sources like youtube (`youtube-dl`)

## Installation

### NixOS (flakes)

Example flake setup (untested):

```nix
{
  description = "my host";
  inputs ={
    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-23.11";
    sanic.url = "git.berlin.ccc.de:cccb/sanic/latest";
  };
  outputs = { self, nixpkgs, sanic }:
  let
    system = "x86_64-linux";
    pkgs = import nixpkgs { inherit system; };
  in
  {
    nixosConfigurations."myhostname".nixpkgs.lib.nixosSystem {
      inherit system;
      modules = [
        sanic.nixosModules.sanic
        {
          sanic = {
            mpd = {
              host = "localhost";
              port = 6600;
            };
            ui = {
              hostname = "[::]";
              port = "443";
              tls = true;
            };
          };
        }
      ];
    };
  };
}
```

### Arch Linux (Manjaro, etc)

Install from the AUR:

```
yay -S sanic
```

### Debian (Ubuntu, Mint, etc)

_tba_

### Red Hat (Fedora, Rocky Linux, etc)

_tba_

### Windows / macOS

lol! 🤣

## 🛠️ Development

sanic is developed using [Nix][nix], but you can also just use the usual Golang tooling.

Run local [MPD][mpd] instance for testing with `make mpd`.

Update go depdendencies like this:

```shell
go get -u  # or `make update`
go mod tidy  # or `make tidy`
gomod2nix
```

### ❄️ w/ Nix

Enter development shell (also has [mpc][mpc] client installed for testing):

```shell
nix develop
```

Build nix flake:

```shell
nix build
```

### 🐧 w/o Nix

Use these Make targets for convenience:

- `run`: Run project
- `build`: Compile project
- `tidy`: Add missing and remove unused modules
- `verify`: Verify dependencies have expected content
- `format`: Format go code
- `lint`: Run linter (staticcheck)
- `test`: Run tests
- `cert`: Create https certificate for local testing

### 🐳 Container

You can run sanic in a container. Use these Make targets for convenience:

- `build-container`: Build container image
- `run-container`: Run container image

## 🗺️ Architecture

[![Architecture](https://git.berlin.ccc.de/cccb/sanic/raw/branch/main/architecture.drawio.svg)](https://app.diagrams.net/?mode=git.berlin.ccc.de#Hcccb%2Fsanic%2Fmain%2Farchitecture.drawio.svg)

---

Made with ❤️ and ![golang logo][golang].

[relaxx]: http://relaxx.dirk-hoeschen.de/
[nix]: https://nixos.org/manual/nix/stable/
[golang]: https://go.dev/images/favicon-gopher.svg
[mpd]: https://musicpd.org/
[mpc]: https://www.musicpd.org/clients/mpc/