mirror of
https://gitlab.com/vyla-entertainment/documentation.git
synced 2026-11-20 17:45:44 -05:00
rewrite
This commit is contained in:
@@ -1,53 +1,36 @@
|
||||
# Vyla Home (Desktop)
|
||||
|
||||
<p class="page-description">The native desktop control center and player runtime for Windows, macOS, and Linux built on Tauri v2 and an embedded Node.js sidecar.</p>
|
||||
<p class="page-description">Fast, lightweight desktop streaming player for Windows, macOS, and Linux.</p>
|
||||
|
||||
<img class="vyla-banner" src="/src/assets/images/desktop/site_preview.webp" alt="Vyla Home desktop application preview" loading="lazy" decoding="async" fetchpriority="low" />
|
||||
|
||||
## Overview
|
||||
|
||||
**Vyla Home** is the desktop client for the Vyla ecosystem. Built with **Tauri v2** and an embedded Node.js sidecar process, Vyla Home uses native system WebViews (WebView2 on Windows, WebKit on macOS/Linux) for fast startups and hardware-accelerated video decoding with minimal memory usage.
|
||||
|
||||
---
|
||||
|
||||
## Downloads
|
||||
|
||||
Binary packages are available on [GitLab Releases](https://gitlab.com/vyla-entertainment/home/-/releases):
|
||||
Download the latest release for your platform from [GitLab Releases](https://gitlab.com/vyla-entertainment/home/-/releases):
|
||||
|
||||
- **Windows**: [Download Setup Installer / Portable (.exe)](https://gitlab.com/vyla-entertainment/home/-/releases) (x86_64)
|
||||
- **macOS**: [Download Disk Image (.dmg)](https://gitlab.com/vyla-entertainment/home/-/releases) (Universal: Apple Silicon & Intel)
|
||||
- **Linux**: Build from source using the steps below.
|
||||
- **Windows**: [Download Setup Installer (.exe)](https://gitlab.com/vyla-entertainment/home/-/releases)
|
||||
- **macOS**: [Download Disk Image (.dmg)](https://gitlab.com/vyla-entertainment/home/-/releases) (Universal for Apple Silicon & Intel)
|
||||
- **Linux**: Build from source using the commands below
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
## Installation
|
||||
|
||||
- **Tauri Main Process (Rust)**: Manages window state, system tray icons, native menus, and hosts the WebView.
|
||||
- **Stdio IPC**: Bi-directional JSON-RPC stream passing messages between Rust and the Node.js sidecar over `stdin` and `stdout`.
|
||||
- **Node.js Sidecar**: Runs `ServiceManager` for local/remote failover, verifies update signatures via `UpdateClient`, manages Discord Rich Presence, and caches local media metadata.
|
||||
### Windows
|
||||
1. Download the installer or portable `.exe` from GitLab Releases.
|
||||
2. Run the downloaded file to launch Vyla Home.
|
||||
3. If Windows Defender SmartScreen shows a prompt, click **More info** and select **Run anyway**.
|
||||
|
||||
### Storage Locations
|
||||
- **Windows**: `%APPDATA%\vyla-home\vyla-home-files\`
|
||||
- **macOS**: `~/Library/Application Support/vyla-home/vyla-home-files/`
|
||||
- **Linux**: `~/.local/share/vyla-home/vyla-home-files/`
|
||||
*Note: If you receive a WebView2 initialization error, download and install the free Microsoft Edge WebView2 Evergreen Runtime from Microsoft.*
|
||||
|
||||
### Sidecar Logs
|
||||
- **Windows**: `%APPDATA%\vyla-home\vyla-home-files\logs\node-debug.log`
|
||||
- **macOS/Linux**: `<AppDataDir>/logs/node-debug.log`
|
||||
### macOS
|
||||
1. Download the `.dmg` disk image.
|
||||
2. Double-click the `.dmg` file to open it.
|
||||
3. Drag the **Vyla Home** icon into your **Applications** folder.
|
||||
4. Launch Vyla Home from Launchpad or Applications.
|
||||
|
||||
---
|
||||
|
||||
## Windows Troubleshooting
|
||||
|
||||
If you encounter a `WebView2 runtime initialization error`:
|
||||
1. Install the Microsoft Edge WebView2 Evergreen Runtime from Microsoft.
|
||||
2. For portable installs, confirm `WebView2Loader.dll` is present in the `bin/` directory adjacent to the executable.
|
||||
|
||||
---
|
||||
|
||||
## Linux Build Guide
|
||||
|
||||
### 1. Install System Dependencies
|
||||
### Linux
|
||||
To build and install on Linux:
|
||||
|
||||
:::code-group
|
||||
<!-- tab: Fedora / RHEL -->
|
||||
@@ -74,34 +57,11 @@ sudo pacman -Syu --needed \
|
||||
```
|
||||
:::
|
||||
|
||||
### 2. Install Rust Toolchain
|
||||
```bash
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||
source "$HOME/.cargo/env"
|
||||
```
|
||||
|
||||
### 3. Clone and Build
|
||||
Clone the repository and build:
|
||||
```bash
|
||||
git clone https://gitlab.com/vyla-entertainment/home.git vyla-home
|
||||
cd vyla-home
|
||||
npm install
|
||||
npm run build:payload
|
||||
npm run dev
|
||||
npm run build
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Developer Workflows
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
npm run build:payload
|
||||
npm run dev -- -- --env VYLA_TEST_UI=1
|
||||
npm run release:full
|
||||
```
|
||||
|
||||
If a hung process locks the binary during Windows development:
|
||||
```powershell
|
||||
Stop-Process -Name "vyla-home", "node", "cargo" -Force -ErrorAction SilentlyContinue
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user