wordcraft/packaging/linux/flatpak/ai.storyteller.wordcraft.yml

# Flatpak manifest for WordCraft, ready for a Flathub submission.
#
# Flatpak builds run offline, so the crate sources must be vendored first. From the repo root:
#
#   curl -fsSLO https://raw.githubusercontent.com/flatpak/flatpak-builder-tools/master/cargo/flatpak-cargo-generator.py
#   python3 flatpak-cargo-generator.py Cargo.lock -o packaging/linux/flatpak/cargo-sources.json
#   flatpak-builder --user --install --force-clean build-flatpak packaging/linux/flatpak/ai.storyteller.wordcraft.yml
#   flatpak run ai.storyteller.wordcraft
#
# For Flathub, replace the `dir` source with a `git` source pinned to a release tag and commit.
# The release's .flatpak bundles come from ai.storyteller.wordcraft.bundle.yml instead (see there);
# keep runtime, runtime-version, sdk and finish-args identical in both (packaging-lint checks this).
id: ai.storyteller.wordcraft
runtime: org.freedesktop.Platform
runtime-version: '25.08'
sdk: org.freedesktop.Sdk
sdk-extensions:
  - org.freedesktop.Sdk.Extension.rust-stable
command: wordcraft
finish-args:
  - --filesystem=xdg-data/ArtCraft/versions:ro
  # Display: Wayland first; X11 only when no Wayland compositor is running.
  - --socket=wayland
  - --socket=fallback-x11
  # X11 shared memory (MIT-SHM). Without it the X11 fallback is slow or fails.
  - --share=ipc
  # GPU access for the wgpu renderer (Vulkan, or GL as a fallback).
  - --device=dri
  # Printing: lpstat/lp (the cups-client module) reach the host's CUPS through its socket and
  # find driverless network printers through Avahi (`lpstat -e`). Without these the Print
  # dialog lists no printers.
  - --socket=cups
  - --system-talk-name=org.freedesktop.Avahi
  # The user's CUPS settings, read-only: their default printer and saved options (lpoptions)
  # and a print server named in their client.conf, which lp reaches over the network.
  - --filesystem=~/.cups:ro
  # Open/Save dialogs go through the file-chooser portal (rfd's xdg-portal backend) and
  # drag-and-drop through the document portal, so picked files work anywhere without broad
  # filesystem access. Documents and Pictures are granted so files passed by path (the command
  # line, Open Recent, "Save" next to the original) work in the usual places.
  - --filesystem=xdg-documents
  - --filesystem=xdg-pictures
  # Network: update checks reach GitHub. Shared host network namespace, so the optional
  # --control server's 127.0.0.1 listener is reachable from the host as well.
  - --share=network
  # Deliberately not granted: home/host filesystem access.
build-options:
  append-path: /usr/lib/sdk/rust-stable/bin
modules:
  # CUPS client tools for craft-print: the runtime has libcups but not lpstat/lp/lpoptions.
  # Linked statically against this release's libcups, so a runtime update can't break them;
  # the socket path matches the host's, which --socket=cups mounts.
  - name: cups-client
    buildsystem: simple
    build-commands:
      - ./configure --prefix=/app --sysconfdir=/etc --localstatedir=/var --with-rundir=/run/cups
        --with-domainsocket=/run/cups/cups.sock --disable-shared --with-components=libcups
        --with-dnssd=avahi --with-tls=gnutls --disable-pam --disable-dbus
      - make -C cups libs
      - make -C systemv lp lpoptions lpstat
      - install -Dm755 -t /app/libexec/cups systemv/lp systemv/lpoptions systemv/lpstat
      - for tool in lp lpoptions lpstat; do install -Dm755 cups-socket.sh "/app/bin/$tool"; done
      - install -Dm644 -t /app/share/licenses/cups LICENSE NOTICE
    sources:
      - type: archive
        url: https://github.com/OpenPrinting/cups/releases/download/v2.4.20/cups-2.4.20-source.tar.gz
        sha256: ab4d9cd7f3e58060091d2b24972223d6401675f11c49b65abf4f6ef31dea22ff
      # Runs each tool. Flatpak mounts the host's CUPS socket at /var/run/cups/cups.sock, choosing
      # it as flatpak-run-cups.c does from the host's CUPS_SERVER, else the first line spelled
      # exactly `ServerName /path` in ~/.cups/client.conf, else the default; it mounts nothing
      # when that socket is missing. CUPS reads the keyword in any case and takes the last
      # ServerName. When CUPS' socket from client.conf is the one Flatpak chose, it is pointed at
      # the mount; when it isn't, the tool fails rather than reach a different server. A
      # CUPS_SERVER is left alone: one set by `flatpak run --env` may not be what was mounted.
      - type: script
        dest-filename: cups-socket.sh
        commands:
          - 'conf="$HOME/.cups/client.conf"'
          - 'if [ -z "${CUPS_SERVER:-}" ] && [ -r "$conf" ]; then'
          - '  server=$(sed -n ''s/^[[:space:]]*[Ss][Ee][Rr][Vv][Ee][Rr][Nn][Aa][Mm][Ee][[:space:]]\{1,\}\([^[:space:]]*\).*/\1/p'' "$conf" | tail -n 1)'
          - '  case "$server" in'
          - '    /*)'
          - '      mounted=$(sed -n ''s/^[[:space:]]*ServerName \(.*\)$/\1/p'' "$conf" | sed ''s/^[[:space:]]*//'' | grep -m 1 ''^/[^:]*$'')'
          - '      if [ "$mounted" = "$server" ]; then'
          - '        export CUPS_SERVER=/var/run/cups/cups.sock'
          - '      else'
          - '        echo "${0##*/}: ~/.cups/client.conf names the CUPS socket $server, but Flatpak gave this app ${mounted:-a different one}; give each socket one ServerName line, spelled ServerName" >&2'
          - '        exit 1'
          - '      fi'
          - '      ;;'
          - '  esac'
          - 'fi'
          - 'exec "/app/libexec/cups/${0##*/}" "$@"'
  - name: wordcraft
    buildsystem: simple
    build-options:
      env:
        CARGO_HOME: /run/build/wordcraft/cargo
        CARGO_NET_OFFLINE: 'true'
        # The interface translations (the craft-i18n source below), embedded by build.rs.
        CRAFT_I18N_DIR: /run/build/wordcraft/craft-i18n
        CRAFT_I18N_REQUIRED: '1'
    build-commands:
      - cargo --offline build --release --locked -p wordcraft -p wordcraft-cli
      - install -Dm755 target/release/wordcraft /app/bin/wordcraft
      - install -Dm644 NOTICE /app/share/doc/wordcraft/NOTICE
      - install -Dm755 target/release/wordcraft-cli /app/bin/wordcraft-cli
      - install -Dm644 packaging/linux/ai.storyteller.wordcraft.desktop /app/share/applications/ai.storyteller.wordcraft.desktop
      - install -Dm644 packaging/linux/ai.storyteller.wordcraft.mime.xml /app/share/mime/packages/ai.storyteller.wordcraft.xml
      - mkdir -p /app/share/icons && cp -R assets/app-icon/hicolor /app/share/icons/
      - >-
        version=$(awk '/^\[/{p=($0=="[workspace.package]");next} p&&$1=="version"{gsub(/[" ]/,"",$3);print $3;exit}' Cargo.toml);
        install -d /app/share/metainfo;
        sed -e "s/@VERSION@/$version/" -e "s/@DATE@/$(date -u +%Y-%m-%d)/"
        packaging/linux/ai.storyteller.wordcraft.metainfo.xml.in > /app/share/metainfo/ai.storyteller.wordcraft.metainfo.xml
    sources:
      - type: dir
        path: ../../..
        skip:
          - target
          - dist
          - corpus
          - build-flatpak
          - .flatpak-builder
      # The interface translations and Language data at the commit in craft-i18n.rev (a test keeps
      # the two equal).
      - type: git
        url: https://github.com/storytold/craft-i18n
        commit: 1e515422afdda2f317af430c1f9d68a5f83935b4
        dest: craft-i18n
      - cargo-sources.json