Files
punktfunk-plugin-heroic/LICENSE-MIT
T
enricobuehler 5fb6946aa1
CI / build (push) Failing after 15s
CI / publish (push) Skipped
feat: the Heroic library source
The host's in-tree Heroic scanner, lifted out into its own installable plugin
(design/library-scanner-plugins.md M5/WP5.2). One source covers all three of
Heroic's backends — legendary (Epic), gog, nile (Amazon) — because that is how
Heroic presents them and how the built-in scanner did.

The package is a config schema, a detect, a scan and a watchDirs. The store
claim, sync engine, __config surface, console registration and the
detect/scan/parity/uninstall CLI verbs all come from
@punktfunk/plugin-kit/library.

Claiming the `heroic` store keeps the entry ids the built-in scanner produced
(`heroic:<runner>:<appName>`), so GameStream app ids, Moonlight pins, cached art
and the operator's enabled/disabled state all survive the migration.

Ported behaviours worth naming, each covered by a test:

  * a title counts as installed only if Heroic says so AND its install directory
    still exists. The second check is the workaround for Heroic's GOG
    is_installed bug (#2691), without which uninstalled games linger.
  * only http(s) art is emitted. A sideloaded title can carry a local file://
    path, which — unlike a path this plugin resolved itself — is not one the host
    should proxy, and the client cannot fetch either. It degrades to the title
    card, as in-host.
  * both detect signals ride along: the install dir and the HEROIC_APP_NAME env
    marker. Heroic hands off to legendary/gogdl/nile, so the host never sees the
    game's own process any other way, and the env marker is what works under
    Proton (verified on-glass 2026-07-27). They are a union, so a Heroic version
    that stops setting it degrades rather than breaking.

The launch VALUE and the `heroic` launch kind are unchanged — the host still owns
turning `<runner>:<appName>` into a heroic://launch command, so this plugin never
constructs a command line.

Verified locally against the kit: tsc clean, biome clean, 5 tests, bundle builds,
CLI runs (detect -> absent, scan -> 0 games).

As with lutris: no lockfile and CI cannot be green until
@punktfunk/plugin-kit@0.3.0 is published. The parity gate has NOT been run — that
needs a box with Heroic installed.
2026-08-05 19:17:02 +02:00

22 lines
1.0 KiB
Plaintext

MIT License
Copyright (c) 2026 unom
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.