Skip to content

Commit

Permalink
feat: rename app to What's Playing
Browse files Browse the repository at this point in the history
  • Loading branch information
gloaysa committed Mar 15, 2024
1 parent fe1dbf5 commit dc7d032
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 31 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docker-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@ jobs:
id: meta
uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
with:
images: ghcr.io/gloaysa/plexart
images: ghcr.io/gloaysa/whatsplaying

- name: Build and push Docker image
uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
with:
context: .
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
labels: ${{ steps.meta.outputs.labels }}
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@

<img align="right" width="33%" src="./logo.png">
<h1>PlexArt Display</h1>
<h1>What's Playing</h1>




Welcome to PlexArt , a web application that brings your music to life. This project is all about showcasing your currently playing album art in a visually appealing way, turning your browser into a vibrant music hub.
Welcome to **What's Playing**, a web application that brings your music cover art from Plex to live. This project is all about showcasing your currently playing album art in a visually appealing way, turning your browser into a vibrant music hub.

PlexArt is more than just a pretty face. It offers basic music controls like play, pause, volume adjustment, and track navigation. But these controls are designed to be unobtrusive, appearing only when you need them, so the album art always takes center stage.
**What's Playing** is more than just a pretty face. It offers basic music controls like play, pause, volume adjustment, and track navigation. But these controls are designed to be unobtrusive, appearing only when you need them, so the album art always takes center stage.

One of the key features of PlexArt is the ability to browse through your Plex devices. Imagine a slide show where each slide is a different device, and you can flip through them with a simple swipe.
One of the key features of **What's Playing** is the ability to browse through your Plex devices. Imagine a slide show where each slide is a different device, and you can flip through them with a simple swipe.

But that's not all. PlexArt also has an 'Album Library' mode. Picture another slide show, this time with all the albums in your library. The slides change automatically, and the albums are chosen at random, so you never know what's coming next. It's like your own personal music lottery!
But that's not all. **What's Playing** also has an 'Album Library' mode. Picture another slide show, this time with all the albums in your library. The slides change automatically, and the albums are chosen at random, so you never know what's coming next. It's like your own personal music lottery!

The end goal of PlexArt is to be a dedicated music display in your living room or media room. It's a way to add a touch of style and interactivity to your music listening experience.
The end goal of **What's Playing** is to be a dedicated music display in your living room or media room. It's a way to add a touch of style and interactivity to your music listening experience.

## Features

PlexArt is packed with features designed to enhance your music listening experience:
**What's Playing** is packed with features designed to enhance your music listening experience:

- **Album Art Display**: The main feature of PlexArt is the ability to display the album art of the currently playing track.
- **Album Art Display**: The main feature of **What's Playing** is the ability to display the album art of the currently playing track.
The album art takes up the entire screen, providing a visually appealing backdrop to your music.
- **Basic Music Controls**: PlexArt provides basic music controls including play, pause, volume adjustment, and track navigation.
- **Basic Music Controls**: **What's Playing** provides basic music controls including play, pause, volume adjustment, and track navigation.
These controls are designed to be unobtrusive, appearing only when you interact with the screen.
- **Lyrics Display**: If available, PlexArt can show the lyrics of the currently playing song.
- **Lyrics Display**: If available, **What's Playing** can show the lyrics of the currently playing song.
- **Device Carousel**: Browse through all your Plex devices with a simple swipe.
Each device is displayed as a slide in a carousel, making it easy to switch between devices.
- **Album Library Mode**: In Album Library mode, all the albums in your library are displayed in a carousel.
The carousel auto-plays, changing slides every few seconds. The albums are chosen at random, providing a unique and engaging experience every time.
- **Works with your Sonos devices**: If you start a playlist or album on a Sonos device, PlexArt will automatically switch to that device and display the album art.
- **Works with your Sonos devices**: If you start a playlist or album on a Sonos device, **What's Playing** will automatically switch to that device and display the album art.

## Configurations

PlexArt can be customized to suit your needs by setting configurations.
**What's Playing** can be customized to suit your needs by setting configurations.
The first time you run the application, you will be prompted to enter your Plex token and other configurations.

- `PLEX_TOKEN`: MANDATORY. This is your Plex token. It's used to authenticate with your Plex server.
Expand All @@ -51,16 +51,16 @@ Once you have set the configuration, if you ever want to change it again, naviga
## Screenshots

Player:
![PlexArt](./example_player.png)
![What's Playing](./example_player.png)

Album Library:
![PlexArt](./example_album.png)
![What's Playing](./example_album.png)

Displaying lyrics:
![PlexArt](./example_lyrics.png)
![What's Playing](./example_lyrics.png)

Displaying controls (mouse hovering over the album art or touching the screen):
![PlexArt](./example_controls.png)
![What's Playing](./example_controls.png)

## Running with Docker Compose

Expand All @@ -72,10 +72,10 @@ First, you need to create a `docker-compose.yml` file in your project directory
```yaml
version: '3.8'
services:
plexart:
container_name: plexart
whatsplaying:
container_name: whatsplaying
restart: unless-stopped
image: ghcr.io/gloaysa/plexart:main
image: ghcr.io/gloaysa/whatsplaying:main
ports:
- '5000:5000'
```
Expand Down
6 changes: 3 additions & 3 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
version: '3.8'
services:
plexart:
container_name: plexart
whatsplaying:
container_name: whatsplaying
restart: unless-stopped
build: .
ports:
- '5000:5000'
- '5000:5000'
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "plexart",
"name": "whatsplaying",
"version": "0.1.0",
"private": true,
"dependencies": {
Expand Down
2 changes: 1 addition & 1 deletion public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
work correctly both with client-side routing and a non-root public URL.
Learn how to configure a non-root public URL by running `npm run build`.
-->
<title>Plexart</title>
<title>What's Playing</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
Expand Down
4 changes: 2 additions & 2 deletions public/manifest.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "Plexart",
"short_name": "Plexart",
"name": "What's Playing",
"short_name": "What's Playing",
"theme_color": "#000000",
"background_color": "#000000",
"display": "fullscreen",
Expand Down
2 changes: 1 addition & 1 deletion src/views/Configuration.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ export const Configuration: FunctionComponent = () => {
<form onSubmit={handleSubmit}>
<CardContent>
<Typography variant="body1" sx={{ paddingBottom: "15px" }}>
PlexArt Display can be customized to suit your needs by setting
What's Playing can be customized to suit your needs by setting
some configurations, like what Plex libraries you would like to
hide from your Album showcase (you maybe have a library of type
music for audiobooks or Christmas music to not have it merged with
Expand Down

0 comments on commit dc7d032

Please sign in to comment.