Skip to content

Getting Started

Jump to bottom
hffgzktbcc-blip edited this page Nov 10, 2026 · 1 revision

Getting Started

Preview the companion

With Git and Node.js 18 or newer, run the local site and mock storage library.

git clone https://github.com/hffgzktbcc-blip/deckstream.git
cd deckstream
npm start

Open http://127.0.0.1:8765. The developer server exercises the app and API with mock library data. For a real launch, configure storage, deploy the site, and install the Deck service below. Local developer server

1. Serve your library and files

Put each game in its own folder under your games directory. Run the library API and WebDAV service. The README's reference layout uses port 8780 for metadata and 8781 for WebDAV. Use your own credentials and keep these services on trusted endpoints. Setup commands · Storage API contract

  • Library API exposes game IDs, file lists and file links. The Vercel site needs to reach this endpoint. A private LAN hostname by itself is insufficient.
  • WebDAV serves the same folder tree to rclone on the Deck. The Deck needs to reach the WebDAV address, which can be separate from the library endpoint.
  • The reference setup uses the same storage key for the library API bearer token and the WebDAV password.

2. Deploy the phone companion

Import the source into Vercel. Set DECKSTREAM_SECRET for the shared queue password, STORAGE_API_URL for the library endpoint, and UPSTASH_REDIS_REST_URL plus UPSTASH_REDIS_REST_TOKEN for persistent queue state. The in-memory store is useful for local development. Separate Vercel function instances do not share its contents. Open Settings in the deployed app and enter the storage key and queue password. Deployment variables · Queue storage implementation

3. Install on the Deck

In Desktop Mode, open Konsole and use the installation command in the deployed site's Settings. Check the source of the command and use the HTTPS origin of your deployment. The installer asks for the queue password and storage details and installs the deckstream user service. After setup, check the service and run the doctor. Install instructions · Installer source

systemctl --user status deckstream
python3 ~/.config/deckstream/doctor.py
journalctl --user -u deckstream -f

For Gaming Mode, Decky Loader is optional. The README documents installing decky/DeckStream.zip from your deployed site. Use matching site, daemon, and plugin files from the same revision when diagnosing a deployment. The v1.0.0 tag predates the own-storage change. Published assets

DeckStream Wiki

Source repository

Clone this wiki locally