itlxrd/Psychotoxical-psysonic
1
0
Fork 0
mirror of https://github.com/Psychotoxical/psysonic.git synced 2026-07-21 14:55:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): rewrite README and add Orbit banner (#478)

Browse Source 
Restructures the README with a calmer tone and clearer information
architecture:
- new tagline + intro paragraph (less marketing-speak, more honest)
- badge row split into release/community/distribution groups,
  with a new Ko-fi support badge
- merged "Server Compatibility" + "Why Psysonic?" into a single
  "What is Psysonic?" section
- "Core Features" → "Highlights", restructured into Playback & Queue,
  Audio Tools, Library Management, Lyrics & Discovery, a new
  Sharing & Social Listening block (Magic Strings + Orbit), and
  Personalization & Accessibility
- Orbit is now treated as a current feature (no longer "Upcoming"),
  with a banner image and a paragraph about real-world use
- Privacy and Community sections expanded with proper links to
  Discord, Telegram, Issues and Ko-fi
- License + Forks-and-Attribution rewritten in a friendlier tone
  while still preserving the same intent

Assets:
- public/orbit.png — new Orbit banner
- public/screenshot1.png — refreshed app screenshot
This commit is contained in:
Frank Stellmacher
2026-05-06 14:21:18 +02:00
committed by GitHub
parent 8692e50603
commit 81041c44c4
3 changed files with 85 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+85 -62
View File
@@ -1,18 +1,24 @@
<div align="center">
<img src="public/psysonic-inapp-logo.svg" alt="Psysonic Logo" width="320"/>
## The Ultimate Desktop Client for Self-Hosted Music Libraries
## A modern desktop client for self-hosted music libraries
**Fast. Beautiful. Native. Feature-packed.**
Built primarily for **Navidrome**. Also compatible with **Gonic**, **Airsonic**, **LMS** and other Subsonic-compatible servers with partial feature support.
**Fast. Native. Beautiful. Built for people who actually care about their music collection.**
Psysonic is built primarily for **Navidrome** and also works with **Gonic**, **Airsonic**, **LMS** and other Subsonic-compatible servers, depending on the features supported by your server.
<br>
<a href="https://github.com/Psychotoxical/psysonic/releases/latest"><img src="https://img.shields.io/github/v/release/Psychotoxical/psysonic?style=for-the-badge&label=Latest%20Release&color=8b5cf6" alt="Latest Release"></a> <a href="https://github.com/Psychotoxical/psysonic/stargazers"><img src="https://img.shields.io/github/stars/Psychotoxical/psysonic?style=for-the-badge&color=f59e0b" alt="GitHub Stars"></a> <a href="https://github.com/Psychotoxical/psysonic/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-GPLv3-22c55e?style=for-the-badge" alt="License GPLv3"></a> <a href="https://tauri.app/"><img src="https://img.shields.io/badge/Tauri-v2-0f172a?style=for-the-badge&logo=tauri" alt="Tauri v2"></a> <a href="https://discord.gg/AMnDRErm4u"><img src="https://img.shields.io/badge/Discord-Community-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Discord Community"></a> <a href="https://t.me/+GLBx1_xeH28xYTJi"><img src="https://img.shields.io/badge/Telegram-Community-26A5E4?style=for-the-badge&logo=telegram&logoColor=white" alt="Telegram Community"></a> <a href="https://aur.archlinux.org/packages/psysonic"><img src="https://img.shields.io/badge/AUR-psysonic-1793d1?style=for-the-badge&logo=arch-linux&logoColor=white" alt="AUR psysonic"></a> <a href="https://aur.archlinux.org/packages/psysonic-bin"><img src="https://img.shields.io/badge/AUR-psysonic--bin-1793d1?style=for-the-badge&logo=arch-linux&logoColor=white" alt="AUR psysonic-bin"></a> <a href="https://psysonic.cachix.org"><img src="https://img.shields.io/badge/Cachix-psysonic.cachix.org-5277C3?style=for-the-badge&logo=nixos&logoColor=white" alt="Cachix"></a>
<a href="https://github.com/Psychotoxical/psysonic/releases/latest"><img src="https://img.shields.io/github/v/release/Psychotoxical/psysonic?style=for-the-badge&label=Latest%20Release&color=8b5cf6" alt="Latest Release"></a> <a href="https://github.com/Psychotoxical/psysonic/stargazers"><img src="https://img.shields.io/github/stars/Psychotoxical/psysonic?style=for-the-badge&color=f59e0b" alt="GitHub Stars"></a> <a href="https://github.com/Psychotoxical/psysonic/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-GPLv3-22c55e?style=for-the-badge" alt="License GPLv3"></a> <a href="https://tauri.app/"><img src="https://img.shields.io/badge/Tauri-v2-0f172a?style=for-the-badge&logo=tauri" alt="Tauri v2"></a>
<a href="https://discord.gg/AMnDRErm4u"><img src="https://img.shields.io/badge/Discord-Community-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Discord Community"></a> <a href="https://t.me/+GLBx1_xeH28xYTJi"><img src="https://img.shields.io/badge/Telegram-Community-26A5E4?style=for-the-badge&logo=telegram&logoColor=white" alt="Telegram Community"></a> <a href="https://ko-fi.com/psychotoxic"><img src="https://img.shields.io/badge/Ko--fi-Support%20Psysonic-FF5E5B?style=for-the-badge&logo=ko-fi&logoColor=white" alt="Support Psysonic on Ko-fi"></a>
<a href="https://aur.archlinux.org/packages/psysonic"><img src="https://img.shields.io/badge/AUR-psysonic-1793d1?style=for-the-badge&logo=arch-linux&logoColor=white" alt="AUR psysonic"></a> <a href="https://aur.archlinux.org/packages/psysonic-bin"><img src="https://img.shields.io/badge/AUR-psysonic--bin-1793d1?style=for-the-badge&logo=arch-linux&logoColor=white" alt="AUR psysonic-bin"></a> <a href="https://psysonic.cachix.org"><img src="https://img.shields.io/badge/Cachix-psysonic.cachix.org-5277C3?style=for-the-badge&logo=nixos&logoColor=white" alt="Cachix"></a>
<br><br>
**No telemetry • Native performance • Massive feature set • Community driven**
**No telemetry • Native performance • Navidrome-first • Community driven**
</div>
@@ -23,95 +29,103 @@ Built primarily for **Navidrome**. Also compatible with **Gonic**, **Airsonic**,
---
> [!WARNING]
> Psysonic is under heavy active development. Bugs and rough edges are to be expected. We reserve the right to change, remove, or rework existing features at any time without prior notice.
> Psysonic is under active development. Bugs and rough edges can happen, and features may change as the project evolves.
## Server Compatibility
## What is Psysonic?
**Psysonic is optimized first and foremost for Navidrome.**
Psysonic is a desktop music client for self-hosted music libraries. It is designed for people who want the freedom of their own server without giving up the comfort, polish and speed of a modern music app.
Many advanced functions integrate directly with Navidrome APIs for the best possible experience. Other Subsonic-compatible servers generally work well, but some features may be limited depending on server capabilities.
It is built with **Rust**, **Tauri v2** and **React**, with a strong focus on responsiveness, customization, practical music-library workflows and a user interface that does not require a manual before you can press play.
## Why Psysonic?
Most Subsonic clients feel like web wrappers.
**Psysonic does not.**
It is a true desktop experience built with **Rust**, **Tauri v2**, and **React** for users who care about speed, aesthetics, customization, and serious music library management.
If you host your own music, this is what the premium experience should feel like.
Psysonic is **optimized first and foremost for Navidrome**. Other Subsonic-compatible servers can work well too, but advanced features may depend on server-side support.
---
# Core Features
# Highlights
## Playback Engine
## Playback & Queue
* Gapless playback
* Crossfade
* ReplayGain support
* Smart Loudness Normalization
* LUFS-based Smart Loudness Normalization
* [AudioMuse-AI](https://github.com/NeptuneHub/AudioMuse-AI) support
* Infinite Queue
* Smart Radio sessions
* High responsiveness with low memory usage
* Fast and responsive playback handling
* Low memory usage compared to heavy web-first clients
## Audio Tools
* 10-band Equalizer
* Presets
* Equalizer presets
* AutoEQ headphone correction
* Per-device optimization
* Loudness-aware playback options
## Library Power
## Library Management
* Lightning-fast search
* Albums / Artists / Tracks / Genres
* Ratings system
* Fast search across large libraries
* Albums, artists, tracks and genres
* Ratings support
* Multi-select bulk actions
* Drag & drop playlist management
* Huge library friendly
* Smart Playlists
* Built for large self-hosted collections
## Lyrics & Discovery
* Synced lyrics with seek support
* Auto-scroll sidebar lyrics
* Lyrics provider support: [YouLy+](https://github.com/ibratabian17/YouLyPlus), LRCLIB and NetEase
* Auto-scrolling sidebar lyrics
* Fullscreen lyric mode
* Last.fm scrobbling
* Similar artists / love tracks / stats
* Similar artists
* Loved tracks and listening stats
## Personalization
## Sharing & Social Listening
* Huge theme collection
* Catppuccin / Nord inspired styles
* Magic Strings sharing:
* share albums, artists and queues
* Navidrome user management helpers
* fast account sharing
* Orbit shared listening sessions:
* host-controlled synchronized playback
* session invites via link
* guest song suggestions
* real-time queue interaction
## Personalization & Accessibility
* Large theme collection
* Catppuccin and Nord inspired styles
* Glassmorphism effects
* Font customization
* Zoom controls
* Keybind remapping
* Theme Scheduler (day/night auto switch)
* Theme Scheduler for automatic day/night switching
* Colorblind-friendly theme options
* Keyboard-friendly navigation
## Power User Extras
* CLI controls
* USB / portable sync
* Backup & restore settings
* Backup and restore settings
* In-app auto updater
* LAN / remote auto switching
---
# Orbit (Upcoming)
<div align="left">
<img src="public/orbit.png" alt="Shared listening feature banner" width="520"/>
</div>
## Listen Together. In Sync. Soon.
Orbit brings synchronized shared listening sessions directly into Psysonic.
Currently in final development and testing. Orbit will introduce synchronized shared listening sessions directly inside Psysonic.
* Host-controlled playback
* Join via link
* Shared listening sessions
* Guest song suggestions
* Real-time queue interaction
**Rolling out in an upcoming release. Community feedback will help shape the final experience.**
Start a session, invite others with a link and listen together with host-controlled playback, shared queue interaction and guest song suggestions. It is built for real-world music sharing without turning your self-hosted setup into a social-media circus.
---
@@ -119,11 +133,11 @@ Currently in final development and testing. Orbit will introduce synchronized sh
| OS | Support |
| ------- | --------------------------------------------------------------- |
| Windows | Native Installer *(certificate pending)* |
| Windows | Native installer |
| macOS | Signed DMG |
| Linux | AppImage / DEB / RPM / AUR (`psysonic`, `psysonic-bin`) / NixOS |
Supports **8 languages** and growing.
Psysonic supports **8 languages** and growing.
---
@@ -135,15 +149,15 @@ Supports **8 languages** and growing.
curl -fsSL https://raw.githubusercontent.com/Psychotoxical/psysonic/main/scripts/install.sh | sudo bash
```
Linux builds are also available through GitHub Releases, AUR and Cachix/Nix.
## Windows
Download the latest installer from Releases.
> SmartScreen warnings may appear until the code-signing certificate is active.
Download the latest installer from the [GitHub Releases](https://github.com/Psychotoxical/psysonic/releases/latest).
## macOS
Download the signed DMG from Releases.
Download the signed DMG from the [GitHub Releases](https://github.com/Psychotoxical/psysonic/releases/latest).
---
@@ -164,41 +178,50 @@ npm run tauri:build
---
# Privacy First
# Privacy
Psysonic is built for self-hosted music collections. Your library is yours.
* No telemetry
* No spyware nonsense
* No analytics harvesting
* Your library stays yours
* No hidden tracking
---
# Community
# Community & Support
Join Discord, report bugs, suggest features, share themes, shape the future.
Join the community, report bugs, suggest features, share themes and help shape the future of Psysonic.
* [Discord](https://discord.gg/AMnDRErm4u)
* [Telegram](https://t.me/+GLBx1_xeH28xYTJi)
* [GitHub Issues](https://github.com/Psychotoxical/psysonic/issues)
* [Support Psysonic on Ko-fi](https://ko-fi.com/psychotoxic)
---
# License
GNU GPL v3.0
Psysonic is licensed under the **GNU GPL v3.0**.
---
## Forks and Attribution
Psysonic is GPLv3 software. You are free to fork, modify, and redistribute it under the terms of that license.
Psysonic is free and open-source software under the GPLv3. You are welcome to fork it, modify it and build upon it under the terms of the license.
If you distribute a modified or rebranded version, please clearly state that it is based on Psysonic and preserve attribution to the original project.
If you publish a modified or rebranded version, please make it clear that your project is based on Psysonic and preserve proper attribution to the original project.
Features such as Orbit were originally designed and implemented in Psysonic. Forks must not present original Psysonic work as their own independent creation.
That is not about preventing forks. Forks are part of open source. It is about being honest with users and contributors about where the work comes from.
Features, design work and implementation ideas developed in Psysonic should not be presented as unrelated original work in downstream projects.
---
<div align="center">
## Stop using boring music clients.
## Own your music. Enjoy the client too.
## Use Psysonic.
**Psysonic brings a modern desktop experience to self-hosted music libraries.**
</div>
public/orbit.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 70 KiB

public/screenshot1.png
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 2.6 MiB

After

Width:  |  Height:  |  Size: 2.4 MiB