🦀 Native Workshop browser, catalog backend and three build variants

.codacy.yml

@@ -5,4 +5,9 @@ exclude_paths:
   - "pnpm-lock.yaml"
   - "rimsort-original/**"
   - "tests/**"
-  - "**/qwebchannel.js"
+  - "**/qwebchannel.js"
+  # SARIF formatting reads reported files as UTF-8; binary artwork is not source.
+  - "**/*.png"
+  - "**/*.ico"
+  - "**/*.icns"
+  - ".codacy/**"

.github/workflows/build.yml

@@ -12,6 +12,12 @@ permissions:
 jobs:
   build-linux:
     runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        workshop: [NoWorkshop, SteamWorkshop, NativeWorkshop]
+    env:
+      UV_NO_SYNC: '1'
     steps:
       - uses: actions/checkout@v7
 
@@ -43,10 +49,10 @@ jobs:
           chmod +x /usr/local/bin/appimagetool
 
       - name: Install Dependencies
-        run: uv sync --locked --dev --extra steam
+        run: uv sync --locked --dev ${{ matrix.workshop == 'NoWorkshop' && '--no-install-package pxsteamdl' || '--extra steam' }}
 
       - name: Build with Nuitka
-        run: just build-release-bundled
+        run: just build-release-bundled --workshop ${{ matrix.workshop }}
 
       - name: Verify glibc floor
         run: |
@@ -58,35 +64,51 @@ jobs:
           test "$(printf '%s\nGLIBC_2.35\n' "$max" | sort -V | tail -1)" = "GLIBC_2.35"
 
       - name: Package tar.gz
-        run: tar -czf PxModRim-Linux.tar.gz -C dist entrypoint.dist/
+        run: tar -czf PxModRim-Linux-${{ matrix.workshop }}.tar.gz -C dist entrypoint.dist/
+
+      - name: Rename Linux packages
+        run: |
+          set -euo pipefail
+          mv dist/PxModRim-x86_64.AppImage dist/PxModRim-Linux-x86_64-${{ matrix.workshop }}.AppImage
+          for f in dist/*.deb; do
+            [ -f "$f" ] || continue
+            mv "$f" "${f%.deb}-${{ matrix.workshop }}.deb"
+          done
+          for f in dist/*.rpm; do
+            [ -f "$f" ] || continue
+            mv "$f" "${f%.rpm}-${{ matrix.workshop }}.rpm"
+          done
 
       - name: Upload artifact (tar.gz)
         uses: actions/upload-artifact@v7
         with:
-          name: PxModRim-Linux
-          path: PxModRim-Linux.tar.gz
+          name: PxModRim-Linux-${{ matrix.workshop }}
+          path: PxModRim-Linux-${{ matrix.workshop }}.tar.gz
 
       - name: Upload artifact (AppImage)
         uses: actions/upload-artifact@v7
         with:
-          name: PxModRim-Linux-AppImage
-          path: dist/PxModRim-x86_64.AppImage
+          name: PxModRim-Linux-AppImage-${{ matrix.workshop }}
+          path: dist/PxModRim-Linux-x86_64-${{ matrix.workshop }}.AppImage
 
       - name: Upload artifact (deb)
         uses: actions/upload-artifact@v7
         with:
-          name: PxModRim-Linux-Deb
-          path: dist/*.deb
+          name: PxModRim-Linux-Deb-${{ matrix.workshop }}
+          path: dist/*-${{ matrix.workshop }}.deb
 
       - name: Upload artifact (rpm)
         uses: actions/upload-artifact@v7
         with:
-          name: PxModRim-Linux-RPM
-          path: dist/*.rpm
-
+          name: PxModRim-Linux-RPM-${{ matrix.workshop }}
+          path: dist/*-${{ matrix.workshop }}.rpm
   build-flatpak:
     needs: [build-linux]
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        workshop: [NoWorkshop, SteamWorkshop, NativeWorkshop]
     container:
       image: ghcr.io/flathub-infra/flatpak-github-actions:freedesktop-24.08
       options: --privileged
@@ -96,25 +118,30 @@ jobs:
       - name: Download Linux dist
         uses: actions/download-artifact@v8
         with:
-          name: PxModRim-Linux
+          name: PxModRim-Linux-${{ matrix.workshop }}
           path: dist-archive
 
       - name: Extract Linux dist
         run: |
           mkdir -p dist
-          tar -xzf dist-archive/PxModRim-Linux.tar.gz -C dist
+          tar -xzf dist-archive/PxModRim-Linux-${{ matrix.workshop }}.tar.gz -C dist
 
       - name: Build Flatpak bundle
         uses: flatpak/flatpak-github-actions/flatpak-builder@v6
         with:
           manifest-path: packaging/flatpak/com.github.PyXiion.PxModRim.yaml
-          bundle: com.github.PyXiion.PxModRim.flatpak
+          bundle: PxModRim-Linux-${{ matrix.workshop }}.flatpak
           build-bundle: true
           upload-artifact: true
-          artifact-name: PxModRim-Flatpak
-
+          artifact-name: PxModRim-Flatpak-${{ matrix.workshop }}
   build-windows:
     runs-on: windows-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        workshop: [NoWorkshop, SteamWorkshop, NativeWorkshop]
+    env:
+      UV_NO_SYNC: '1'
     steps:
       - uses: actions/checkout@v7
 
@@ -139,7 +166,7 @@ jobs:
           tool: just@1.40.0
 
       - name: Install Dependencies
-        run: uv sync --locked --dev --extra steam
+        run: uv sync --locked --dev ${{ matrix.workshop == 'NoWorkshop' && '--no-install-package pxsteamdl' || '--extra steam' }}
       - name: Install NSIS
         shell: pwsh
         run: |
@@ -154,23 +181,31 @@ jobs:
           & $makensis /VERSION
 
       - name: Build with Nuitka
-        run: just build-release-bundled
+        run: just build-release-bundled --workshop ${{ matrix.workshop }}
+
+      - name: Rename Windows installer
+        shell: bash
+        run: mv dist/PxModRim-Setup.exe dist/PxModRim-Windows-${{ matrix.workshop }}-Setup.exe
 
       - name: Upload artifact (dist)
         uses: actions/upload-artifact@v7
         with:
-          name: PxModRim-Windows
+          name: PxModRim-Windows-${{ matrix.workshop }}
           path: dist/entrypoint.dist/*
 
       - name: Upload artifact (installer)
         uses: actions/upload-artifact@v7
         with:
-          name: PxModRim-Windows-Installer
-          path: dist/PxModRim-Setup.exe
-
+          name: PxModRim-Windows-Installer-${{ matrix.workshop }}
+          path: dist/PxModRim-Windows-${{ matrix.workshop }}-Setup.exe
   build-macos:
     runs-on: macos-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        workshop: [NoWorkshop, SteamWorkshop, NativeWorkshop]
     env:
+      UV_NO_SYNC: '1'
       MACOS_SIGNING_CONFIGURED: >-
         ${{ secrets.MACOS_CERT != '' &&
             secrets.MACOS_CERT_PASSWORD != '' &&
@@ -202,10 +237,10 @@ jobs:
           tool: just@1.40.0
 
       - name: Install Dependencies
-        run: uv sync --locked --dev --extra steam
+        run: uv sync --locked --dev ${{ matrix.workshop == 'NoWorkshop' && '--no-install-package pxsteamdl' || '--extra steam' }}
 
       - name: Build with Nuitka
-        run: just build-release-bundled
+        run: just build-release-bundled --workshop ${{ matrix.workshop }}
 
       - name: Sign and notarize macOS app
         if: env.MACOS_SIGNING_CONFIGURED == 'true'
@@ -258,82 +293,52 @@ jobs:
           security delete-keychain "$keychain_path"
           rm -f "$certificate" "$notary_zip"
 
+      - name: Rename macOS packages
+        run: |
+          set -euo pipefail
+          mv dist/PxModRim-macOS.zip dist/PxModRim-macOS-${{ matrix.workshop }}.zip
+          mv dist/PxModRim-macOS.dmg dist/PxModRim-macOS-${{ matrix.workshop }}.dmg
+
       - name: Upload artifact (dmg)
         uses: actions/upload-artifact@v7
         with:
-          name: PxModRim-macOS-DMG
-          path: dist/PxModRim-macOS.dmg
+          name: PxModRim-macOS-DMG-${{ matrix.workshop }}
+          path: dist/PxModRim-macOS-${{ matrix.workshop }}.dmg
 
       - name: Upload artifact (zip)
         uses: actions/upload-artifact@v7
         with:
-          name: PxModRim-macOS-ZIP
-          path: dist/PxModRim-macOS.zip
-
+          name: PxModRim-macOS-ZIP-${{ matrix.workshop }}
+          path: dist/PxModRim-macOS-${{ matrix.workshop }}.zip
   release:
     needs: [build-linux, build-flatpak, build-windows, build-macos]
     runs-on: ubuntu-latest
     if: startsWith(github.ref, 'refs/tags/')
     steps:
-      - uses: actions/download-artifact@v8
-        with:
-          name: PxModRim-Linux
-          path: linux-targz
-
-      - uses: actions/download-artifact@v8
-        with:
-          name: PxModRim-Linux-AppImage
-          path: linux-appimage
-
-      - uses: actions/download-artifact@v8
-        with:
-          name: PxModRim-Linux-Deb
-          path: linux-deb
-
-      - uses: actions/download-artifact@v8
-        with:
-          name: PxModRim-Linux-RPM
-          path: linux-rpm
-
-      - uses: actions/download-artifact@v8
-        with:
-          name: PxModRim-Flatpak
-          path: flatpak
-
-      - uses: actions/download-artifact@v8
-        with:
-          name: PxModRim-Windows
-          path: windows
-
-      - uses: actions/download-artifact@v8
-        with:
-          name: PxModRim-Windows-Installer
-          path: windows-installer
-
-      - uses: actions/download-artifact@v8
-        with:
-          name: PxModRim-macOS-DMG
-          path: macos-dmg
-
-      - uses: actions/download-artifact@v8
+      - name: Download all artifacts
+        uses: actions/download-artifact@v8
         with:
-          name: PxModRim-macOS-ZIP
-          path: macos-zip
+          pattern: PxModRim-*
+          path: artifacts
+          merge-multiple: false
 
       - name: Package Windows release
-        run: 7z a PxModRim-Windows.zip ./windows/*
+        run: |
+          for variant in NoWorkshop SteamWorkshop NativeWorkshop; do
+            7z a "PxModRim-Windows-${variant}.zip" "./artifacts/PxModRim-Windows-${variant}/*"
+          done
 
       - name: Create Release
         uses: softprops/action-gh-release@v3
         with:
           files: |
-            linux-targz/PxModRim-Linux.tar.gz
-            linux-appimage/PxModRim-x86_64.AppImage
-            linux-deb/*.deb
-            linux-rpm/*.rpm
-            flatpak/com.github.PyXiion.PxModRim.flatpak
-            PxModRim-Windows.zip
-            windows-installer/PxModRim-Setup.exe
-            macos-dmg/PxModRim-macOS.dmg
-            macos-zip/PxModRim-macOS.zip
+            artifacts/PxModRim-Linux-*/*.tar.gz
+            artifacts/PxModRim-Linux-AppImage-*/*.AppImage
+            artifacts/PxModRim-Linux-Deb-*/*.deb
+            artifacts/PxModRim-Linux-RPM-*/*.rpm
+            artifacts/PxModRim-Flatpak-*/*.flatpak
+            PxModRim-Windows-*.zip
+            artifacts/PxModRim-Windows-Installer-*/*-Setup.exe
+            artifacts/PxModRim-macOS-DMG-*/*.dmg
+            artifacts/PxModRim-macOS-ZIP-*/*.zip
           generate_release_notes: true

.github/workflows/ci.yml

@@ -58,3 +58,22 @@ jobs:
             export QT_QPA_PLATFORM=offscreen
           fi
           just test
+
+  workshop-backend:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: cf-workers
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-node@v7
+        with:
+          node-version: "22"
+          cache: npm
+          cache-dependency-path: cf-workers/package-lock.json
+      - name: Install Worker dependencies
+        run: npm ci
+      - name: Check TypeScript
+        run: npm run check
+      - name: Exercise bundled Worker with D1
+        run: npm test

AGENTS.md

@@ -28,10 +28,21 @@ src/pxmodrim/
 ## Download plugins
 Downloads are plugins; the UI only talks to `core/downloads/manager.py` (`DownloadManager`, always present, plugin name `downloads`).
 - Sources subclass `core.downloads.Downloader` (`core/downloads/steam.py` = `steam_downloader`, the only one today) and register with the manager in `setup()`. Third-party imports stay inside the source's own module; `_app.py` imports it lazily and skips it if disabled or missing.
-- UI plugins: `downloads_ui` (Downloads tab, source-agnostic, shown when any downloader exists), `steamworkshop` (Steam WebView, needs `steam_downloader`).
-- Disable at runtime: `PX_DISABLED_PLUGINS=steam_downloader,steamworkshop,downloads_ui` (comma-separated).
+- Catalog: `workshop_catalog` consumes the read-only catalog API with constructor-injected configuration/client factory; it resolves transitive download plans and delegates files to `DownloadManager`, without activating mods. `AppConfig.workshop_catalog_url` defaults to `https://api.modrim.pyxiion.dev`; an empty string disables catalog network requests. Defaulted config fields load from older files without a schema migration.
+- UI plugins: `downloads_ui` (Downloads tab, source-agnostic, shown when any downloader exists), `steamworkshop` (Steam WebView, needs `steam_downloader`), `workshop_ui` (native QML Workshop browser, needs `workshop_catalog` and `downloads`).
+- Disable at runtime: `PX_DISABLED_PLUGINS=steam_downloader,steamworkshop,downloads_ui,workshop_catalog,workshop_ui` (comma-separated). Disabling the catalog also omits its UI.
+- Installed catalog state uses discovered mods' `published_file_id` (About/PublishedFileId.txt or numeric folder); only downloader-managed local copies have known sync times. Steam-client Workshop copies are installed, but cannot be marked outdated without a known sync timestamp. Downloading places mods in Local mods and never subscribes or activates them.
+- Catalog requests batch installed metadata by 100 IDs and resolution by 50 mod roots / 10 collection roots; large Update all selections retain dependency-first order and deduplicate shared dependencies across requests.
 - New source: subclass `Downloader`, register in `_app.py`, add its name to the `downloaders` list; UI needs no change.
 
+## Plugin API
+Core and the shell (`ui/window`, `ui/panels`) never name a concrete plugin; only `_app.py` (composition root) does.
+- Settings: `PluginConfig(ctx.config_service, name, Struct, legacy={old_config_json_key: field})` in `setup()` → `plugins/<name>.json`; subscribe to `.changed`.
+- Settings UI: a UI plugin calls `app_ctx.add_settings_section(factory)` (one Settings tab each); subclass `ui.settings_section.PluginConfigSection` with `title` + `source` (QML whose root has `required property QtObject section`, reading `section.initial` and calling `section.set(key, value)`). Edits apply on Save only.
+- Views: `RailView` subclasses on `app_ctx.add_rail_view`; `open_route(path)` handles `modrim://<view_id>/…`; `lists_downloads = True` marks the download queue.
+- `steam_downloader_ui` holds the Steam download settings section.
+- Build variants: `packaging/build.py --workshop {NoWorkshop,SteamWorkshop,NativeWorkshop}` bakes `workshop-variant.txt` into the package, which `_app.py` turns into disabled plugins, and `_variant_exclusions` leaves the matching modules out of the Nuitka build. `NoWorkshop` omits PxSteamDL, the Downloads tab and both browsers (CI syncs it with `--no-install-package pxsteamdl`); `SteamWorkshop` omits the native browser; `NativeWorkshop` omits the web browser and WebEngine. CI builds all three on every OS. Build jobs set `UV_NO_SYNC=1` so `uv run` preserves the explicitly synced variant environment; both Workshop variants sync with `--extra steam`.
+
 ## Key conventions
 - `from __future__ import annotations` in every `.py` file
 - No comments unless explaining _why_. _What_ comments allowed for long blocks.
@@ -58,7 +69,7 @@ Output `inject.js` is gitignored; always build before running.
 
 ## Layer dependency checker
 `just check-deps` (`scripts/check-deps.py`) enforces strict import rules via pydeps.
-Defines 24 groups with explicit ALLOWED dependency matrices.
+Defines groups with explicit ALLOWED dependency matrices, including `core.workshop`.
 If a new import violates boundaries, update `scripts/check-deps.py`'s `ALLOWED` dict.
 
 ## CI matrix