Fixes and Improvements since Twitch API change this month

.github/workflows/Check_patch_notes.yml

@@ -0,0 +1,24 @@
+name: Check patch notes
+
+on:
+  pull_request:
+    branches:
+      - in-dev
+  workflow_dispatch:
+
+jobs:
+  check_patch_notes:
+    runs-on: ubuntu-latest  # windows-latest | macos-latest
+    name: Test changed-files
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 2  # "0" OR "2" -> To retrieve the preceding commit.
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/[email protected]
+
+      - name: Run when patch noted don't change
+        if: ${{ !contains(steps.changed-files.outputs.modified_files, 'patch_notes.txt') }} 
+        run: exit 1

.github/workflows/ci.yml

@@ -1,10 +1,12 @@
-name: Build
+name: Build dev version
 
 on:
   push:
     branches:
-      - 'master'
+      - 'in-dev'
   pull_request:
+    branches:
+      - 'in-dev'
   workflow_dispatch:
 
 env:
@@ -193,8 +195,8 @@ jobs:
           path: Twitch.Drops.Miner.Linux.AppImage.zip
 
   update_releases_page:
+    #NOTEif: github.event.pull_request.merged == true || github.event_name == 'push'
     name: Upload builds to Releases
-    if: github.event_name != 'pull_request'
     needs:
       - windows
       - linux-pyinstaller
@@ -221,7 +223,10 @@ jobs:
           artifactErrorsFailBuild: true
           artifacts: artifacts/*/*
           body: |
-            **This is an automatically generated in-development pre-release version of the application, that includes the latest master branch changes.**
+            # ⚠️ Please help with translation as tracked in #2 !
+
+            ***
+            **This is an automatically generated in-development pre-release version of the application, that includes the latest in-dev branch changes.**
             **⚠️ This build is not stable and may end up terminating with a fatal error. ⚠️**
             **Use at your own risk.**
 

.github/workflows/release.yml

@@ -0,0 +1,257 @@
+name: Build release
+
+on:
+  pull_request:
+    types: [closed]
+    branches:
+      - 'master'
+  workflow_dispatch:
+
+env:
+  PYTHON_VERSION: '3.10'
+
+jobs:
+  windows:
+    name: Windows
+    runs-on: windows-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up variables
+        id: vars
+        run: |
+          Add-Content $env:GITHUB_OUTPUT "sha_short=$(git rev-parse --short HEAD)"
+
+      - name: Append git revision to project version
+        run: |
+          (Get-Content version.py) `
+          -Replace '^__version__\s*=\s*"[^"]+', "`$0.${{steps.vars.outputs.sha_short}}" |`
+          Out-File version.py
+
+      # Ensure Python version
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{env.PYTHON_VERSION}}
+
+      - name: Install project dependencies
+        run: |
+          python3 -m pip install wheel
+          python3 -m pip install -r requirements.txt
+
+      - name: Install UPX
+        run: |
+          Invoke-WebRequest -Uri https://github.com/upx/upx/releases/download/v4.0.2/upx-4.0.2-win64.zip -OutFile (Join-Path $env:Temp upx.zip)
+          Expand-Archive -LiteralPath (Join-Path $env:Temp upx.zip) -DestinationPath $env:Temp
+          Move-Item -Path (Join-Path $env:Temp upx-*) -Destination (Join-Path $env:Temp upx)
+          Add-Content $env:GITHUB_PATH (Join-Path $env:Temp upx)
+
+      - name: Install PyInstaller
+        run: |
+          python3 -m pip install pyinstaller
+
+      - name: Create portable executable
+        run: |
+          pyinstaller build.spec
+
+      - name: Create release folder
+        run: |
+          $FolderName = 'Twitch Drops Miner'
+          New-Item $FolderName -ItemType Directory
+          Copy-Item dist\*.exe $FolderName
+          Copy-Item manual.txt $FolderName
+          Compress-Archive -Path $FolderName -DestinationPath Twitch.Drops.Miner.Windows.zip
+
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          if-no-files-found: error
+          name: Twitch.Drops.Miner.Windows
+          path: Twitch.Drops.Miner.Windows.zip
+
+  linux-pyinstaller:
+    name: Linux (PyInstaller)
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up variables
+        id: vars
+        run: |
+          echo "sha_short=$(git rev-parse --short HEAD)" >> "${GITHUB_OUTPUT}"
+
+      - name: Append git revision to project version
+        run: |
+          sed -ri "s/^__version__\s*=\s*\"[^\"]+/\0.${{ steps.vars.outputs.sha_short }}/" version.py
+
+      # NOTE: We're only use a custom version of Python here because truststore requires at least Python 3.10, but Ubuntu 20.04 has Python 3.8.
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{env.PYTHON_VERSION}}
+
+      - name: Install system dependencies
+        run: |
+          sudo apt update
+          sudo apt install gir1.2-appindicator3-0.1 libgirepository1.0-dev python3-tk
+
+      - name: Install project dependencies
+        run: |
+          python3 -m pip install wheel
+          python3 -m pip install -r requirements.txt
+
+      - name: Install PyInstaller
+        run: |
+          python3 -m pip install pyinstaller
+
+      # NOTE: Remove this step if/once libxft gets updated to 2.3.5 or newer on Ubuntu 20.04, which currently has 2.3.3.
+      - name: Build a recent version of libXft
+        run: |
+          mkdir -p /tmp/libXft
+          cd /tmp/libXft
+          curl -L https://xorg.freedesktop.org/releases/individual/lib/libXft-2.3.8.tar.xz -o libXft.tar.xz
+          tar xvf libXft.tar.xz
+          cd libXft-*
+          ./configure --prefix=/tmp/libXft --sysconfdir=/etc --disable-static
+          make
+          make install-strip
+
+      - name: Create portable executable
+        run: |
+          LD_LIBRARY_PATH=/tmp/libXft/lib xvfb-run --auto-servernum pyinstaller build.spec
+
+      - name: Show PyInstaller warnings
+        run: |
+          cat build/build/warn-build.txt || true
+
+      - name: Create release folder
+        run: |
+          folder='Twitch Drops Miner'
+          mkdir "${folder}"
+          cp manual.txt dist/* "${folder}"
+          7z a Twitch.Drops.Miner.Linux.PyInstaller.zip "${folder}"
+
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          if-no-files-found: error
+          name: Twitch.Drops.Miner.Linux.PyInstaller
+          path: Twitch.Drops.Miner.Linux.PyInstaller.zip
+
+  linux-appimage:
+    name: Linux (AppImage)
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up variables
+        id: vars
+        run: |
+          echo "app_version=$(python3 -c 'from version import __version__ as v; print(v)')" >> "${GITHUB_OUTPUT}"
+          echo "sha_short=$(git rev-parse --short HEAD)" >> "${GITHUB_OUTPUT}"
+
+      - name: Append git revision to project version
+        run: |
+          sed -ri "s/^__version__\s*=\s*\"[^\"]+/\0.${{steps.vars.outputs.sha_short}}/" version.py
+
+      - name: Install system dependencies
+        run: |
+          sudo apt update
+          sudo apt install libgirepository1.0-dev python3-testresources
+
+      - name: Download AppImage Builder
+        run: |
+          curl -L https://github.com/AppImageCrafters/appimage-builder/releases/download/v1.1.0/appimage-builder-1.1.0-x86_64.AppImage -o appimage-builder
+          chmod +x appimage-builder
+
+      - name: Create AppImage
+        env:
+          APPIMAGE_EXTRACT_AND_RUN: 1
+          APP_VERSION: ${{steps.vars.outputs.app_version}}.${{steps.vars.outputs.sha_short}}
+          PYTHON_VERSION: ${{env.PYTHON_VERSION}}
+        run: |
+          ./appimage-builder --recipe appimage/AppImageBuilder.yml
+
+      - name: Create release folder
+        run: |
+          folder='Twitch Drops Miner'
+          mkdir "${folder}"
+          cp *.AppImage manual.txt "${folder}"
+          7z a Twitch.Drops.Miner.Linux.AppImage.zip "${folder}"
+
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          if-no-files-found: error
+          name: Twitch.Drops.Miner.Linux.AppImage
+          path: Twitch.Drops.Miner.Linux.AppImage.zip
+
+  update_releases_page:
+    name: Upload builds to Releases
+    #NOTEif: github.event.pull_request.merged == true
+    needs:
+      - windows
+      - linux-pyinstaller
+      - linux-appimage
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Get next version
+        uses: reecetech/[email protected]
+        id: version
+        with:
+          scheme: semver
+          increment: minor
+
+      - name: Set up variables
+        id: vars
+        run: |
+          echo "date_now=$(date --rfc-3339=seconds)" >> "${GITHUB_OUTPUT}"
+          echo "sha_short=$(git rev-parse --short HEAD)" >> "${GITHUB_OUTPUT}"
+
+      - name: Download build artifacts from previous jobs
+        uses: actions/download-artifact@v4
+        with:
+          path: artifacts
+
+      - name: Read patch notes from file
+        id: patch_notes
+        uses: juliangruber/[email protected]
+        with:
+          path: ./patch_notes.txt
+
+      - name: Upload builds to Releases
+        uses: ncipollo/release-action@v1
+        with:
+          allowUpdates: true
+          artifactErrorsFailBuild: true
+          artifacts: artifacts/*/*
+          body: |
+            # ⚠️ Please help with translation as tracked in #2 and channel points as tracked in #23 !
+
+            ***
+            **This is an automatically generated updated version of the application, that includes the latest master branch changes.**
+            **This build should be stable, but if you encounter anything, please report any issues you find.**
+
+            - Last build date: `${{ steps.vars.outputs.date_now }}`
+            - Reference commit: ${{ github.sha }}
+
+            ***
+            ## Patch notes:
+            ${{ steps.patch_notes.outputs.content }}
+
+          name: Updated tested build - ${{ steps.version.outputs.v-version }} (${{ steps.vars.outputs.sha_short }})
+          prerelease: false
+          removeArtifacts: true
+          tag: ${{ steps.version.outputs.v-version }}

.gitignore

@@ -15,7 +15,7 @@ __pycache__
 log.txt
 /lock.file
 settings.json
-/lang/English.json
+#/lang/English.json
 # AppImage
 /AppDir
 /appimage-builder

README.md

@@ -1,10 +1,12 @@
 # Twitch Drops Miner
 
+Thanks to @DevilXD and other contributors from the [original repo](https://github.com/DevilXD/TwitchDropsMiner) for the vast majority of the code.
+
 This application allows you to AFK mine timed Twitch drops, without having to worry about switching channels when the one you were watching goes offline, claiming the drops, or even receiving the stream data itself. This helps both you and Twitch save on bandwidth and hassle. Everyone wins!
 
 ### How It Works:
 
-Every ~60 seconds, the application sends a "minute watched" event to the channel that's currently being watched - this is enough to advance the drops. Note that this completely bypasses the need to download any actual stream video and sound. To keep the status (ONLINE or OFFLINE) of the channels up-to-date, there's a websocket connection established that receives events about streams going up or down, or updates regarding the current amount of viewers.
+Every ~20 seconds, the application asks Twitch for a URL to the raw stream data of the channel currently being watched. It then fetches the metadata of this data stream - this is enough to advance the drops. Note that this completely bypasses the need to download any actual stream video and sound. To keep the status (ONLINE or OFFLINE) of the channels up-to-date, there's a websocket connection established that receives events about streams going up or down, or updates regarding the current amount of viewers.
 
 ### Features:
 
@@ -30,6 +32,8 @@ Every ~60 seconds, the application sends a "minute watched" event to the channel
 ![Main](https://user-images.githubusercontent.com/4180725/164298155-c0880ad7-6423-4419-8d73-f3c053730a1b.png)
 ![Inventory](https://user-images.githubusercontent.com/4180725/164298315-81cae0d2-24a4-4822-a056-154fd763c284.png)
 ![Settings](https://user-images.githubusercontent.com/4180725/164298391-b13ad40d-3881-436c-8d4c-34e2bbe33a78.png)
+![Help](https://github.com/Windows200000/TwitchDropsMiner-updated/assets/72623832/ca1c25e1-650f-415b-ab9d-8cfc001fc7e6)
+
 
 ### Notes:
 
@@ -129,3 +133,5 @@ if they aren't already there. Doing so ensures proper markdown rendering on Gith
 @casungo - For the entirety of the Italian (Italiano) translation.  
 @Bamboozul - For the entirety of the Arabic (العربية) translation.  
 @Kjerne - For the entirety of the Danish (Dansk) translation.
+
+For updating Translations: @Kuddus73, @VSeryi, @Windows200000, @BreakshadowCN, @kilroy98, @zelda0079, @Calvineries, @notNSANE, @ElvisDesigns, @DogancanYr, @Nollasko, @rvpv, @flxderdev, @5wi5wi, @fgr1178707QQ, @Suz1e, @Patriot99

build.spec

@@ -23,8 +23,7 @@ to_add: list[tuple[Path, str, bool]] = [
     (Path(SITE_PACKAGES_PATH, "seleniumwire/ca.key"), "./seleniumwire", False),
 ]
 for lang_filepath in WORKING_DIR.joinpath("lang").glob("*.json"):
-    if lang_filepath.stem != DEFAULT_LANG:
-        to_add.append((lang_filepath, "lang", True))
+    to_add.append((lang_filepath, "lang", True))
 
 # ensure the required to-be-added data exists
 datas: list[tuple[Path, str]] = []

cache.py

@@ -32,6 +32,17 @@ class ExpiringHash(TypedDict):
 default_database: Hashes = {}
 
 
+class CurrentSeconds:
+    LIFETIME = timedelta(days=7)
+
+    def set_current_seconds(value):
+        global current_seconds
+        current_seconds = value
+
+    def get_current_seconds():
+        return current_seconds
+
+
 class ImageCache:
     LIFETIME = timedelta(days=7)