Skip to content
Playdex

Windows wrapper

The Wrapper is a small Windows tray app. You launch games through it, and it reports play time to your Playdex API. Use it for games the poller can’t see: GOG, Epic, emulators, anything with an .exe.

  1. Download the latest playdex-wrapper-windows-vX.Y.Z.zip from GitHub Releases. Unzip it somewhere your user can write to, e.g. %LOCALAPPDATA%\Programs\Playdex. Auto-update needs write access to that folder.

  2. Get an API key. Each user needs a capture key (plx_…). The Web app doesn’t have a button to create one yet, so call the API while signed in:

    Terminal window
    # 1. Sign in. Copy "accessToken" from the response.
    curl -s https://playdex.example.com/api/login -H 'Content-Type: application/json' \
      -d '{"email":"you@example.com","password":"…"}'
    

    # 2. Create (or fetch) your capture key.
    curl -s -X POST https://playdex.example.com/api/api/key -H "Authorization: Bearer $ACCESS_TOKEN"

    After that, the key shows read-only in Web → Settings.

  3. Open Settings from the tray icon and fill in:

    • API base URL: https://playdex.example.com/api.
      ⚠️ The default points at the author’s instance; change it.
    • API key: your plx_… key
    • Default play platform: loaded from your server
    • SteamGridDB API key (optional): artwork for Steam shortcuts
    • Ludusavi executable (optional): daily save backups

  4. Add a game. Pick its .exe. The Wrapper creates a launcher, and can add it to Steam as a non-Steam shortcut (close Steam first).

While the game runs, the Wrapper pings the API every 30 seconds. The session ends 3 minutes after the last ping.