christofsteel/syng
christofsteel/syng
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity Actions

Simplified summaries and descriptions

Browse source
This commit is contained in:
Christoph Stahl 2024-10-06 04:00:23 +02:00
parent e3265b0817
commit 9395980ecb
2 changed files with 12 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -10,16 +10,13 @@
[![Website](https://img.shields.io/website?url=https%3A%2F%2Fsyng.rocks%2F&label=syng.rocks)](https://syng.rocks) [![Website](https://img.shields.io/website?url=https%3A%2F%2Fsyng.rocks%2F&label=syng.rocks)](https://syng.rocks)
[![Gitlab Pipeline Status](https://img.shields.io/gitlab/pipeline-status/christofsteel%2Fsyng2?gitlab_url=https%3A%2F%2Fgit.k-fortytwo.de%2F&branch=main&logo=python&label=mypy%2Bruff)](https://git.k-fortytwo.de/christofsteel/syng2) [![Gitlab Pipeline Status](https://img.shields.io/gitlab/pipeline-status/christofsteel%2Fsyng2?gitlab_url=https%3A%2F%2Fgit.k-fortytwo.de%2F&branch=main&logo=python&label=mypy%2Bruff)](https://git.k-fortytwo.de/christofsteel/syng2)
Easily host karaoke events.
**Syng** is an all-in-one karaoke software, consisting of a *backend server*, a *web frontend* and a *playback client*. **Syng** is an all-in-one karaoke software, consisting of a *backend server*, a *web frontend* and a *playback client*.
Karaoke performers can search a library using the web frontend, and add songs to the queue. Karaoke performers can search a library using the web frontend, and add songs to the queue.
The playback client retrieves songs from the backend server and plays them in order. The playback client retrieves songs from the backend server and plays them in order.
Currently, songs can be accessed using the following sources: You can play songs from **YouTube**, an **S3** storage or simply share local **files**.
- **YouTube.** The backend server queries YouTube for the song and forwards the URL to the playback client. The playback client then downloads the video from YouTube for playback.
- **S3.** The backend server holds a list of all file paths accessible through the s3 storage, and forwards the chosen path to the playback client. The playback client then downloads the needed files from the s3 for playback.
- **Files.** Same as S3, but all files reside locally on the playback client.
The playback client uses [mpv](https://mpv.io/) for playback and can therefore play a variety of file formats, such as `mp3+cdg`, `webm`, `mp4`, ... The playback client uses [mpv](https://mpv.io/) for playback and can therefore play a variety of file formats, such as `mp3+cdg`, `webm`, `mp4`, ...
@ -48,15 +45,9 @@ This installs both the playback client (`syng client`) and a configuration GUI (
Windows support is experimental, but you can download the current version from [Releases](https://github.com/christofsteel/syng/releases). No installation necessary, you can just run the `exe`. Windows support is experimental, but you can download the current version from [Releases](https://github.com/christofsteel/syng/releases). No installation necessary, you can just run the `exe`.
## Running
The simplest way to run Syng is through the configuration GUI. Executing `syng` without parameters will open the GUI, from which you can start configure and start the playback client. You can start the playback client without the GUI using `syng client`.
Web clients should connect to the server using a room code, that can be configured in the client.
## Configuration ## Configuration
You can either configure Syng using the GUI or via a text editor by editing `~/.config/syng/config.yaml`. There are the following settings: You can host karaoke events using the default configuration. But if you need more advanced configuration, you can either configure Syng using the GUI or via a text editor by editing `~/.config/syng/config.yaml`. There are the following settings:
* `server`: URL of the server to connect to. * `server`: URL of the server to connect to.
* `room`: The room code for your karaoke event. Can be chosen arbitrarily, but must be unique. Unused rooms will be deleted after some time. _Note:_ Everyone, that has access to the room code can join the karaoke event. * `room`: The room code for your karaoke event. Can be chosen arbitrarily, but must be unique. Unused rooms will be deleted after some time. _Note:_ Everyone, that has access to the room code can join the karaoke event.
@ -65,6 +56,8 @@ You can either configure Syng using the GUI or via a text editor by editing `~/.
* `last_song`: `none` or a time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). When a song is added to the queue, and its ending time exceeds this value, it is rejected. * `last_song`: `none` or a time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). When a song is added to the queue, and its ending time exceeds this value, it is rejected.
* `preview_duration`: Before every song, there is a short slide for the next performer. This sets how long it is shown in seconds. * `preview_duration`: Before every song, there is a short slide for the next performer. This sets how long it is shown in seconds.
* `key`: If the server, you want to connect to is in _private_ or _restricted_ mode, this will authenticate the client. Private server reject unauthenticated playback clients, restricted servers limit the searching to be _client only_. * `key`: If the server, you want to connect to is in _private_ or _restricted_ mode, this will authenticate the client. Private server reject unauthenticated playback clients, restricted servers limit the searching to be _client only_.
* `mpv_options`: additional options forwarded to `mpv`.
* `show_advanced`: show advanced options in the configuration GUI.
In addition to the general config, has its own configuration under the `sources` key of the configuration. In addition to the general config, has its own configuration under the `sources` key of the configuration.
@ -98,7 +91,6 @@ Configuration is done under `sources` → `files` with the following settings:
* `enabled`: `true` or `false`. * `enabled`: `true` or `false`.
* `extensions`: List of extensions to be searched. For karaoke songs, that separate audio and video (e.g. CDG files), you can use `mp3+cdg` to signify, that the audio part is a `mp3` file and the video is a `cdg` file. For karaoke songs, that do not separate this (e.g. mp4 files), you can simply use `mp4`. * `extensions`: List of extensions to be searched. For karaoke songs, that separate audio and video (e.g. CDG files), you can use `mp3+cdg` to signify, that the audio part is a `mp3` file and the video is a `cdg` file. For karaoke songs, that do not separate this (e.g. mp4 files), you can simply use `mp4`.
* `dir`: Directory, where the karaoke files are stored. * `dir`: Directory, where the karaoke files are stored.
* `index_file`: Cache file, that contains the filenames of the karaoke files in the s3.
### Default configuration ### Default configuration
@ -111,13 +103,14 @@ config:
secret: <Random secret> secret: <Random secret>
server: https://syng.rocks server: https://syng.rocks
waiting_room_policy: none waiting_room_policy: none
mpv_options: ''
show_advanced: False
sources: sources:
files: files:
dir: . dir: .
enabled: false enabled: false
extensions: extensions:
- mp3+cdg - mp3+cdg
index_file: ~/.cache/syng/files-index
s3: s3:
access_key: '' access_key: ''
bucket: '' bucket: ''

23
resources/flatpak/rocks.syng.Syng.metainfo.xml
View file

@ -3,7 +3,7 @@
<id>rocks.syng.Syng</id> <id>rocks.syng.Syng</id>
<name>Syng</name> <name>Syng</name>
<summary>All-in-one karaoke software</summary> <summary>Easily host karaoke events</summary>
<developer id="rocks.syng"> <developer id="rocks.syng">
<name>Christoph Stahl</name> <name>Christoph Stahl</name>
@ -57,27 +57,14 @@
<description> <description>
<p> <p>
Syng is an all-in-one karaoke software, consisting of a <em>backend server</em>, a <em>web frontend</em> and a <em>playback client</em>. Karaoke performers can search a library using the web frontend, and add songs to the queue. The playback client retrieves songs from the backend server and plays them in order. Syng is an easy-to-use karaoke software. Just start the client and let users connect via their web browser.
You can set up your own <em>Syng server</em> or simply use a publicly available one.
</p> </p>
<p> <p>
To host a karaoke event, you only need to use this playback client, as you can use a publicly available instance (See project page). Songs can be played from <em>YouTube</em>, an <em>S3</em> Storage or <em>your local machine</em>.
</p> </p>
<p> <p>
Currently, songs can be accessed using the following sources: You can play a variety of file formats, such as <code>mp3+cdg</code>, <code>webm</code>, <code>mp4</code>, ...
</p>
<ul>
<li>
<em>YouTube</em>. The backend server queries YouTube for the song and forwards the URL to the playback client. The playback client then downloads the video from YouTube for playback.
</li>
<li>
<em>S3</em>. The backend server holds a list of all file paths accessible through the s3 storage, and forwards the chosen path to the playback client. The playback client then downloads the needed files from the s3 for playback.
</li>
<li>
<em>Files</em>. Same as S3, but all files reside locally on the playback client.
</li>
</ul>
<p>
The playback client uses <code>mpv</code> for playback and can therefore play a variety of file formats, such as <code>mp3+cdg</code>, <code>webm</code>, <code>mp4</code>, ...
</p> </p>
</description> </description>