diff --git a/docsite/docs/configuration/clients/_env_configs/_tuneshine.md b/docsite/docs/configuration/clients/_env_configs/_tuneshine.md new file mode 100644 index 00000000..0876948e --- /dev/null +++ b/docsite/docs/configuration/clients/_env_configs/_tuneshine.md @@ -0,0 +1,6 @@ +| Environmental Variable | Type | Default | Description | +| ---------------------- | ------- | ------------------ | ------------------------------------------------- | +| _**`TUNE_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `TUNE_NAME` | string | Value of `TUNE_ID` | A vanity name EX `My Cool Component` | +| `TUNE_ENABLE` | boolean | true | Should this component be used? | +| _**`TUNE_HOST`**_ | string | | IP or http(s)://hostname for the Tuneshine device | \ No newline at end of file diff --git a/docsite/docs/configuration/clients/clients.mdx b/docsite/docs/configuration/clients/clients.mdx index cff6a4bc..61723f67 100644 --- a/docsite/docs/configuration/clients/clients.mdx +++ b/docsite/docs/configuration/clients/clients.mdx @@ -22,6 +22,7 @@ A **Client** is an application that stores the historical information about what | [Maloja](/configuration/clients/maloja) | ❌ | | [Rocksky](/configuration/clients/rocksky) | ✅ | | [Teal.fm](/configuration/clients/tealfm) | ✅ | +| [Tuneshine](/configuration/clients/tuneshine) | ✅ | ## Features diff --git a/docsite/docs/configuration/clients/tuneshine.mdx b/docsite/docs/configuration/clients/tuneshine.mdx new file mode 100644 index 00000000..e36c0f5a --- /dev/null +++ b/docsite/docs/configuration/clients/tuneshine.mdx @@ -0,0 +1,61 @@ +--- +title: Tuneshine +toc_min_heading_level: 2 +toc_max_heading_level: 5 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; +import JsonConfig from '!!raw-loader!@site/../config/tuneshine.json.example'; +import ENVConfig from "@site/docs/configuration/clients/_env_configs/_tuneshine.md" + +[**Tuneshine**](https://www.tuneshine.rocks/) is a wifi-connected hardware device with an aesthetic, low-count LED display for showcasing the album art of the music you are currently listening to. + +You can use Multi-Scrobbler to push [**Now Playing**](/configuration/clients#now-playing) activity from any of your [Sources](/configuration/sources) (that include album art) to Tuneshine. + +:::important[Artwork is Required] + +Tuneshine **requires** that artwork is sent with Now Playing data. Therefore, if your Source does not provide artwork (no album art is shown in MS dashboard) then MS will not send Now Playing to Tuneshine. + +Consider using [Transforms](/configuration/transforms) from [Rocksky](/configuration/transforms/rocksky/#use-metadata-for-discord-album-art), [Spotify](/configuration/transforms/spotify), or Musicbrainz + [Cover Art Archive](/configuration/transforms/coverartarchive/#add-album-art-for-discord) to fill in missing artwork. + +::: + + + +MS sends resized, formatted image data directly to Tuneshine. + +To do this it **downloads** the art image from the URL reported by your Sources, converts it in-memory, and sends that to Tuneshine. Consequently, the image URLs must be reachable by MS: they cannot be protected by authentication or otherwise unreachable on the network from wherever MS is hosted. + + + +## Setup + +Your Tuneshine will need to be [connected to wifi](https://links.tuneshine.rocks/help#wifi) in order for Multi-Scrobbler to talk to it. + +Find the IP address or [advirtised hostname](https://links.tuneshine.rocks/help#api) for your Tuneshine, then use that as a URL in your MS config either as `host` or `TUNE_HOST` (see configuration below.) + + + + If you are using the IP address for your Tuneshine then then URL used for `host` should be like + + ``` + http://192.168.YOUR.IP + ``` + + If you are using the advirtised hostname on your local network then `host` should be like + + ``` + http://tuneshine-4064.local + ``` + + If you are reaching your Tuneshine in some other form (like behind a reverse proxy) then just treat it as a normal web server when forming your URL. + + + +## Configuration + + + + \ No newline at end of file diff --git a/docsite/docs/index.mdx b/docsite/docs/index.mdx index abab3f2a..dd801e57 100644 --- a/docsite/docs/index.mdx +++ b/docsite/docs/index.mdx @@ -55,6 +55,7 @@ A dockerized app that monitors your music listening activity from *everywhere* a * [Maloja](/configuration/clients/maloja) * [Rocksky](/configuration/clients/rocksky) * [teal.fm](/configuration/clients/tealfm) + * [Tuneshine](/configuration/clients/tuneshine) (Now Playing) * Enhance/correct scrobble data with [search patterns](/configuration/transforms), [built-in corrections](/configuration/transforms), or the [Musicbrainz](/configuration/transforms/musicbrainz) or [Spotify](/configuration/transforms/spotify) catalogs * Monitor status of Sources and Clients using [webhooks (Gotify, Ntfy, Apprise)](/configuration#webhook-configurations) or [healthcheck endpoint](/configuration#health-endpoint) * Supports [Now Playing](/configuration/clients#now-playing) for scrobble Clients