Adds README and screenshot

This commit is contained in:
2025-02-23 11:14:02 -08:00
parent 5c3f2dbdd2
commit b2b70f3eb1
2 changed files with 34 additions and 0 deletions

34
README.md Normal file
View File

@@ -0,0 +1,34 @@
# QueueCube
QueueCube is a web frontend for [mpv](https://github.com/mpv-player/mpv).
It allows you to remotely manage mpv's playqueue as well as the ability to search YouTube via a locally running [Invidious](https://github.com/iv-org/invidious) instance.
![queuecube user interface](screenshots/queuecube.png)
## Running
The easiest way to run QueueCube is by using Docker. An MPV instance is created in the Docker container, so all you have to do is make it so the MPV instance can access your host's soundcard. On Linux, this is accomplished by mapping the PulseAudio socket to the container:
```
volumes:
- ~/.config/pulse/cookie:/root/.config/pulse/cookie
- /var/run/user/1000/pulse:/var/run/pulse
```
### Building the Docker image
```
docker build -t queuecube:latest .
```
If not using docker-compose, create an instance of the container by using `docker create` using the volume mapping specified above for mapping the PulseAudio socket:
```
docker create -p 8080:3000 -v /run/user/1000/pulse:/var/run/pulse -v ~/.config/pulse/cookie:/root/.config/pulse/cookie --name queuecube queuecube:latest
```
On some systems, you may need to add `--security-opt seccomp=unconfined` to allow containerized processes to write to your host's PulseAudio socket.
Once running, you should be able to access the UI via http://localhost:8080.

BIN
screenshots/queuecube.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 196 KiB