Skip to content

olekolek1000/wayvr-dashboard

Repository files navigation

WayVR Dashboard logo

WayVR Dashboard is a work-in-progress overlay application (WayVR/wlx-overlay-s plugin via IPC) for launching various applications and games directly into a VR desktop environment. It will also offer numerous quality-of-life features to bring Linux VR gaming on par with SteamVR's dashboard. Stay tuned!

Roadmap

* - working on it

Done Variant Description Requires
IPC wlx-overlay-s (wayvr) <-> WayVR dashboard interop
Applications tab .desktop Application fetch support
Applications tab .desktop Icon matcher
Applications tab Applications viewer
Applications tab Search box, sort by categories
Applications tab Spawn application inside wlx-overlay-s (WayVR) IPC
Applications tab Display manager (select WayVR display) IPC
WayVR WayVR running applications manager IPC
Games tab List all installed Steam games
Games tab Search box, sort by vr/non-vr games
Games tab Launch desktop games inside WayVR
Games tab Fetch cover image of games
Games tab Games viewer
* Games tab Launch/stop Steam games
Utils Re-center button IPC
Utils Show device battery levels IPC
* Utils Microphone/speaker volume control
Utils Launch index_camera_passthrough
* Settings Settings window, session metrics IPC
Home screen

DISCLAIMER

This project is still under heavy development and lacks various features that will be implemented in the future. Here is our Matrix and Discord.

Build instructions

Firstly, read disclaimer above.

Make sure to have NodeJS/npm, C/C++ compiler and rust installed and everything in between if you get any build issues.

Rust installation instructions

NodeJS installation instructions (only if you have an ancient distro)

1. Clone this repository build WayVR dashboard:

git clone --depth=1 https://github.com/olekolek1000/wayvr-dashboard.git
cd wayvr-dashboard
npm install
npm run tauri build

Built executable will be available at ./src-tauri/target/release/wayvr_dashboard.

2. Configure wlx-overlay-s

git clone --depth=1 https://github.com/galister/wlx-overlay-s.git
cd wlx-overlay-s
cargo build

3. Add this dashboard to the wayvr.yaml file in wlx-overlay-s:

Modify ./src/res/wayvr.yaml file in the wlx-overlay-s repo (you can copy it to the ~/.config/wlxoverlay/wayvr.yaml path if you want to):

dashboard:
  exec: "/home/YOUR_USER/PATH_TO_REPO/wayvr-dashboard/src-tauri/target/release/wayvr_dashboard"
  args: ""
  env: ["GDK_BACKEND=wayland"]

⚠️ Modify exec path accordingly to your executable path!

3. Start wlx-overlay-s:

cd wlx-overlay-s
cargo run

You are all set! You will see a blue "Dash" button in your watch. You can also assign a controller button to toggle it automatically.

Have fun!

About

A desktop environment and launcher for VR (wlx-overlay-s addon)

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published