Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 2.42 KB

README.md

File metadata and controls

63 lines (47 loc) · 2.42 KB
Raw

Styx 2 Desktop Client

The new native desktop client for yet another mediaserver stack.

Features & Architecture

  • Entire UI written in Kotlin using Compose Multiplatform
    With most of the code located in a common and a common-compose library
  • Material 3 Design
    Loosely following official guidelines
  • No constant connection required
    • All data is synced on startup or with a manual refresh1
    • All images are cached locally1
    • Watch progress and favourites are always local-first and synced to the server when a connection is possible

Desktop specific

  • Bundled mpv player (on windows) and a somewhat custom config
  • Player controlled through json-ipc and reading stdout
    So you can also use your own install with your own config if desired

Screenshots

Click here

Search

Show detail view

Settings

How do I use this?

Short answer You don't.
Long answer

There is no public instance for this.
You will have to build every part of the ecosystem yourself and run it on your own server.

How to run/build

Building is as simple as running one of these, assuming you have set your buildconfig correctly and whatnot.

# Windows
./gradlew clean packageReleaseMsi packageReleaseUberJarForCurrentOS

# Linux
./gradlew clean packageReleaseDeb packageReleaseRpm packageReleaseUberJarForCurrentOS

To my knowledge, compose-mp does not currently support cross compiling for desktop yet so you are going to have to run this on their respective OS.
You can also do so with github workflows. See the workflows directory in this repo.

Running is just ./gradlew run

Footnotes

  1. I realize this may be infeasible when working with a huge library but this is not a concern for me and I'm building this just for me. With my current library of ~10TB I'm sitting at around 30MB of cached images and ~7MB of other data on the clientside.
    ↩ ↩2