Introduce a Tauri based desktop version (#940)

This introduces a Tauri based desktop version of LiveSplit One. For now very few changes have been done. It's mostly global hotkeys that work now. It's unclear if Tauri is the long term solution for LiveSplit One, but it gets us global hotkeys and auto splitting with very little effort, so we'll use it until something better comes along.
LiveSplit · Jul 15, 2024 · ccb4bbd · ccb4bbd
1 parent f681701
commit ccb4bbd
Show file tree

Hide file tree

Showing 26 changed files with 5,549 additions and 174 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -4,115 +4,189 @@ on:
   pull_request:
   push:
     branches:
-      - 'master'
+      - "master"
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        label:
+          - Web
+          - Tauri on Windows
+          - Tauri on Linux
+          - Tauri on macOS ARM
+
+        include:
+          - label: Web
+            platform: web
+            dist_path: dist
+            os: ubuntu-latest
+            target: x86_64-unknown-linux-musl
+            binaryen: x86_64-linux
+            cargo_bin: /home/runner/.cargo/bin
+
+          - label: Tauri on Windows
+            platform: tauri
+            dist_path: src-tauri/target/dist
+            os: windows-latest
+            target: x86_64-pc-windows-msvc
+            binaryen: x86_64-windows
+            cargo_bin: C:/Users/runneradmin/.cargo/bin
+
+          - label: Tauri on Linux
+            platform: tauri
+            dist_path: src-tauri/target/dist
+            os: ubuntu-latest
+            target: x86_64-unknown-linux-musl
+            binaryen: x86_64-linux
+            cargo_bin: /home/runner/.cargo/bin
+
+          - label: Tauri on macOS ARM
+            platform: tauri
+            dist_path: src-tauri/target/dist
+            os: macos-latest
+            target: aarch64-apple-darwin
+            binaryen: arm64-macos
+            cargo_bin: /Users/runner/.cargo/bin
 
     steps:
-    - name: Checkout commit
-      uses: actions/checkout@v4
-      with:
-        submodules: recursive
-        # This forces the entire history to be cloned, which is necessary for
-        # the changelog generation to work correctly.
-        fetch-depth: 0
-
-    - name: Install Node
-      uses: actions/setup-node@v4
-      with:
-        node-version: 'lts/*'
-
-    - name: Install Rust
-      uses: hecrj/setup-rust-action@v2
-      with:
-        rust-version: nightly
-        components: rust-src
-        targets: wasm32-unknown-unknown
-
-    - name: Download binaryen
-      if: github.repository == 'LiveSplit/LiveSplitOne' && github.ref == 'refs/heads/master'
-      uses: robinraju/[email protected]
-      with:
-        repository: "WebAssembly/binaryen"
-        latest: true
-        fileName: "binaryen-*-x86_64-linux.tar.gz"
-        out-file-path: "/home/runner/.cargo/bin"
-
-    - name: Install binaryen
-      if: github.repository == 'LiveSplit/LiveSplitOne' && github.ref == 'refs/heads/master'
-      run: |
-        cd ~/.cargo/bin
-        tar -xzf binaryen-*-x86_64-linux.tar.gz
-        mv binaryen*/bin/wasm* .
-
-    - name: Choose wasm-bindgen-cli version
-      run: echo "version=$(cd livesplit-core && cargo tree -i wasm-bindgen --features wasm-web --target wasm32-unknown-unknown --depth 0 | sed 's/.* v//g')" >> $GITHUB_OUTPUT
-      id: wasm-bindgen
-
-    - name: Download wasm-bindgen-cli
-      uses: robinraju/[email protected]
-      with:
-        repository: "rustwasm/wasm-bindgen"
-        tag: ${{ steps.wasm-bindgen.outputs.version }}
-        fileName: "wasm-bindgen-${{ steps.wasm-bindgen.outputs.version }}-x86_64-unknown-linux-musl.tar.gz"
-        out-file-path: "/home/runner/.cargo/bin"
-
-    - name: Install wasm-bindgen-cli
-      run: |
-        cd ~/.cargo/bin
-        tar -xzf wasm-bindgen-${{ steps.wasm-bindgen.outputs.version }}-x86_64-unknown-linux-musl.tar.gz
-        mv wasm-bindgen-${{ steps.wasm-bindgen.outputs.version }}-x86_64-unknown-linux-musl/wasm* .
-
-    - name: Install npm packages
-      run: npm ci -f
-      env:
-        DETECT_CHROMEDRIVER_VERSION: true
-
-    - name: Build Core
-      run: npm run build:core:deploy
-
-    - name: Run eslint
-      run: npm run lint
-
-    - name: Build Frontend
-      run: npm run publish
-
-    - name: Cache screenshots
-      uses: actions/cache@v4
-      with:
-        path: test/screenshots
-        key: ${{ runner.os }}-screenshots-${{ hashFiles('test/rendering-test.js') }}
-        restore-keys: ${{ runner.os }}-screenshots-
-
-    - name: Run tests
-      run: |
-        echo "::add-matcher::.github/workflows/test-failures.json"
-        npm run test
-
-    - name: Upload screenshots
-      if: success() || failure()
-      uses: actions/upload-artifact@v4
-      with:
-        name: Screenshots
-        path: test/screenshots
-
-    - name: Optimize
-      if: github.repository == 'LiveSplit/LiveSplitOne' && github.ref == 'refs/heads/master'
-      run: |
-        WASM_FILE=$(ls dist/*.wasm)
-        wasm-opt --all-features -O4 "$WASM_FILE" -o "$WASM_FILE"
-
-    - name: Add CNAME file
-      if: github.repository == 'LiveSplit/LiveSplitOne' && github.ref == 'refs/heads/master'
-      run: cp ./.github/workflows/CNAME ./dist/CNAME
-
-    - name: Deploy
-      if: github.repository == 'LiveSplit/LiveSplitOne' && github.ref == 'refs/heads/master'
-      uses: peaceiris/actions-gh-pages@v4
-      with:
-        deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-        publish_branch: gh-pages
-        publish_dir: ./dist
-        force_orphan: true
+      - name: Checkout commit
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          # This forces the entire history to be cloned, which is necessary for
+          # the changelog generation to work correctly.
+          fetch-depth: 0
+
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+
+      - name: Install Rust
+        uses: hecrj/setup-rust-action@v2
+        with:
+          rust-version: nightly
+          components: rust-src
+          targets: wasm32-unknown-unknown
+
+      - name: Download binaryen
+        if: github.repository == 'LiveSplit/LiveSplitOne' && github.ref == 'refs/heads/master'
+        uses: robinraju/[email protected]
+        with:
+          repository: "WebAssembly/binaryen"
+          latest: true
+          fileName: "binaryen-*-${{ matrix.binaryen }}.tar.gz"
+          out-file-path: ${{ matrix.cargo_bin }}
+
+      - name: Install binaryen
+        if: github.repository == 'LiveSplit/LiveSplitOne' && github.ref == 'refs/heads/master'
+        run: |
+          cd ~/.cargo/bin
+          tar -xzf binaryen-*-${{ matrix.binaryen }}.tar.gz
+          mv binaryen*/bin/wasm* .
+
+      - name: Choose wasm-bindgen-cli version
+        shell: bash
+        run: echo "version=$(cd livesplit-core && cargo tree -i wasm-bindgen --features wasm-web --target wasm32-unknown-unknown --depth 0 | sed 's/.* v//g')" >> $GITHUB_OUTPUT
+        id: wasm-bindgen
+
+      - name: Download wasm-bindgen-cli
+        uses: robinraju/[email protected]
+        with:
+          repository: "rustwasm/wasm-bindgen"
+          tag: ${{ steps.wasm-bindgen.outputs.version }}
+          fileName: "wasm-bindgen-${{ steps.wasm-bindgen.outputs.version }}-${{ matrix.target }}.tar.gz"
+          out-file-path: ${{ matrix.cargo_bin }}
+
+      - name: Install wasm-bindgen-cli
+        shell: bash
+        run: |
+          cd ${{ matrix.cargo_bin }}
+          tar -xzf wasm-bindgen-${{ steps.wasm-bindgen.outputs.version }}-${{ matrix.target }}.tar.gz
+          mv wasm-bindgen-${{ steps.wasm-bindgen.outputs.version }}-${{ matrix.target }}/wasm* .
+
+      - name: Install npm packages
+        run: npm ci -f
+        env:
+          DETECT_CHROMEDRIVER_VERSION: true
+
+      - name: Install native dependencies (Tauri)
+        if: matrix.platform == 'tauri' && matrix.os == 'ubuntu-latest'
+        run: |
+          sudo apt update
+          sudo apt install libwebkit2gtk-4.0-dev \
+            build-essential \
+            curl \
+            wget \
+            file \
+            libssl-dev \
+            libgtk-3-dev \
+            libayatana-appindicator3-dev \
+            librsvg2-dev
+
+      - name: Build Core
+        run: npm run build:core:deploy
+
+      - name: Run eslint (Web)
+        if: matrix.platform == 'web'
+        run: npm run lint
+
+      - name: Build Frontend (Web)
+        if: matrix.platform == 'web'
+        run: npm run publish
+
+      - name: Build Frontend (Tauri)
+        if: matrix.platform == 'tauri'
+        run: npm run tauri:build-html
+
+      - name: Generate Icons (Tauri)
+        if: matrix.platform == 'tauri'
+        run: npm run tauri:icons
+
+      - name: Cache screenshots (Web)
+        if: matrix.platform == 'web'
+        uses: actions/cache@v4
+        with:
+          path: test/screenshots
+          key: ${{ runner.os }}-screenshots-${{ hashFiles('test/rendering-test.js') }}
+          restore-keys: ${{ runner.os }}-screenshots-
+
+      - name: Run tests (Web)
+        if: matrix.platform == 'web'
+        run: |
+          echo "::add-matcher::.github/workflows/test-failures.json"
+          npm run test
+
+      - name: Upload screenshots (Web)
+        if: matrix.platform == 'web' && (success() || failure())
+        uses: actions/upload-artifact@v4
+        with:
+          name: Screenshots
+          path: test/screenshots
+
+      - name: Optimize
+        if: github.repository == 'LiveSplit/LiveSplitOne' && github.ref == 'refs/heads/master'
+        shell: bash
+        run: |
+          WASM_FILE=$(ls ${{ matrix.dist_path }}/*.wasm)
+          wasm-opt --all-features -O4 "$WASM_FILE" -o "$WASM_FILE"
+
+      - name: Build (Tauri)
+        if: matrix.platform == 'tauri'
+        run: npm run tauri:publish
+
+      - name: Add CNAME file (Web)
+        if: matrix.platform == 'web' && github.repository == 'LiveSplit/LiveSplitOne' && github.ref == 'refs/heads/master'
+        run: cp ./.github/workflows/CNAME ./${{ matrix.dist_path }}/CNAME
+
+      - name: Deploy (Web)
+        if: matrix.platform == 'web' && github.repository == 'LiveSplit/LiveSplitOne' && github.ref == 'refs/heads/master'
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_branch: gh-pages
+          publish_dir: ./${{ matrix.dist_path }}
+          force_orphan: true
diff --git a/livesplit-core b/livesplit-core
+11 −8		capi/src/command_sink.rs
+10 −7		capi/src/web_command_sink.rs
+4 −4		crates/livesplit-auto-splitting/Cargo.toml
+2 −3		crates/livesplit-auto-splitting/README.md
+2 −3		crates/livesplit-auto-splitting/src/lib.rs
+19 −166		crates/livesplit-auto-splitting/src/runtime/api/wasi.rs
+4 −7		crates/livesplit-auto-splitting/src/runtime/mod.rs
+1 −1		crates/livesplit-auto-splitting/src/timer.rs
+4 −5		src/auto_splitting/mod.rs
+1 −1		src/component/graph.rs
+27 −17		src/event.rs
+218 −52		src/networking/server_protocol.rs
+0 −8		src/platform/no_std/time.rs
+0 −27		src/platform/normal/mod.rs
+0 −8		src/platform/wasm/unknown/time.rs
+0 −8		src/platform/wasm/web/time.rs
+1 −13		src/timing/time_stamp.rs
+12 −10		src/timing/timer/active_attempt.rs
+11 −8		src/timing/timer/mod.rs
+16 −0		src/timing/timer/tests/mod.rs
+4 −4		tests/rendering.rs
+1 −1		tests/run_files/livesplit1.0.lss