Add examples

- Added example script for Linux and Windows to download all games using Gogg

Author: habedi

.github/workflows/publish_snap.yml

@@ -81,3 +81,6 @@ bin/
 download/
 catalogue.csv
 *.snap
+gogg/
+games/
+gogg_catalogue*

.gitignore

@@ -251,7 +251,7 @@ func refreshCatalogue(cmd *cobra.Command, numThreads int) {
 
 	wg.Wait()
 	bar.Finish()
-	cmd.Printf("Refreshing completed successfully. There are %d games in the catalogue.\n", len(games))
+	cmd.Printf("Refreshing completed successfully.")
 }
 
 // searchCmd searches for games in the catalogue by ID or title

cmd/catalogue.go

@@ -6,7 +6,7 @@ import (
 
 var (
 	// Gogg version
-	version = "1.0.0"
+	version = "0.2.0"
 )
 
 // versionCmd shows the version of Gogg

cmd/version.go

@@ -0,0 +1,66 @@
+# To run the script, open PowerShell and execute the following command:
+# Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass; .\download_all_games.ps1
+
+# Colors
+$RED = "`e[31m"
+$GREEN = "`e[32m"
+$YELLOW = "`e[33m"
+$NC = "`e[0m" # No Color
+
+Write-Host "${GREEN}===================== Download All Games (Windows Powershell Version) ======================${NC}"
+Write-Host "${GREEN}The code in this script downloads all games owned by the user on GOG.com with given options.${NC}"
+Write-Host "${GREEN}============================================================================================${NC}"
+
+$DEBUG_MODE = 1 # Debug mode enabled
+$GOGG = (Get-Command "bin\gogg" -ErrorAction SilentlyContinue) -or (Get-Command "gogg" -ErrorAction SilentlyContinue)
+
+$LANG = "en" # Language English
+$PLATFORM = "windows" # Platform Windows
+$INCLUDE_DLC = 1 # Include DLCs
+$INCLUDE_EXTRA_CONTENT = 1 # Include extra content
+$RESUME_DOWNLOAD = 1 # Resume download
+$NUM_THREADS = 4 # Number of worker threads for downloading
+
+# Function to clean up the CSV file
+function Cleanup {
+    if ($latest_csv) {
+        Remove-Item -Force $latest_csv
+        if ($?) {
+            Write-Host "${RED}Cleanup: removed $latest_csv${NC}"
+        }
+    }
+}
+
+# Trap Ctrl+C and call Cleanup
+$global:latest_csv = $null
+Register-ObjectEvent -InputObject $Host -EventName "CancelKeyPress" -Action { Cleanup }
+
+# Update game catalogue and export it to a CSV file
+& $GOGG catalogue refresh
+& $GOGG catalogue export --format csv --dir ./
+
+# Find the newest catalogue file
+$latest_csv = Get-ChildItem -Path . -Filter "gogg_catalogue_*.csv" | Sort-Object LastWriteTime -Descending | Select-Object -First 1
+
+# Check if the catalogue file exists
+if (-not $latest_csv) {
+    Write-Host "${RED}No CSV file found.${NC}"
+    exit 1
+}
+
+Write-Host "${GREEN}Using catalogue file: $($latest_csv.Name)${NC}"
+
+# Download each game listed in catalogue file, skipping the first line
+Get-Content $latest_csv.FullName | Select-Object -Skip 1 | ForEach-Object {
+    $fields = $_ -split ","
+    $game_id = $fields[0]
+    $game_title = $fields[1]
+    Write-Host "${YELLOW}Game ID: $game_id, Title: $game_title${NC}"
+    & $GOGG download --id $game_id --dir "./games" --platform $PLATFORM --lang $LANG `
+        --dlcs $INCLUDE_DLC --extras $INCLUDE_EXTRA_CONTENT --resume $RESUME_DOWNLOAD --threads $NUM_THREADS
+    Start-Sleep -Seconds 1
+    # Remove the break to download all games
+}
+
+# Clean up
+Cleanup

docs/examples/.gitkeep

@@ -0,0 +1,61 @@
+#!/bin/bash
+
+# Colors
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+echo -e "${GREEN}=========================== Download All Games (Linux Version) =============================${NC}"
+echo -e "${GREEN}The code in this script downloads all games owned by the user on GOG.com with given options.${NC}"
+echo -e "${GREEN}============================================================================================${NC}"
+
+DEBUG_MODE=1 # Debug mode enabled
+GOGG=$(command -v bin/gogg || command -v gogg)
+
+LANG=en # Language English
+PLATFORM=windows # Platform Windows
+INCLUDE_DLC=1 # Include DLCs
+INCLUDE_EXTRA_CONTENT=1 # Include extra content
+RESUME_DOWNLOAD=1 # Resume download
+NUM_THREADS=4 # Number of worker threads for downloading
+
+# Function to clean up the CSV file
+cleanup() {
+    if [ -n "$latest_csv" ]; then
+        rm -f "$latest_csv"
+        if [ $? -eq 0 ]; then
+            echo -e "${RED}Cleanup: removed $latest_csv${NC}"
+        fi
+    fi
+}
+
+# Trap SIGINT (Ctrl+C) and call cleanup
+trap cleanup SIGINT
+
+# Update game catalogue and export it to a CSV file
+$GOGG catalogue refresh
+$GOGG catalogue export --format csv --dir ./
+
+# Find the newest catalogue file
+latest_csv=$(ls -t gogg_catalogue_*.csv 2>/dev/null | head -n 1)
+
+# Check if the catalogue file exists
+if [ -z "$latest_csv" ]; then
+    echo -e "${RED}No CSV file found.${NC}"
+    exit 1
+fi
+
+echo -e "${GREEN}Using catalogue file: $latest_csv${NC}"
+
+# Download each game listed in catalogue file, skipping the first line
+tail -n +2 "$latest_csv" | while IFS=, read -r game_id game_title; do
+    echo -e "${YELLOW}Game ID: $game_id, Title: $game_title${NC}"
+    DEBUG_GOGG=$DEBUG_MODE $GOGG download --id $game_id --dir ./games --platform $PLATFORM --lang $LANG \
+        --dlcs $INCLUDE_DLC --extras $INCLUDE_EXTRA_CONTENT --resume $RESUME_DOWNLOAD --threads $NUM_THREADS
+    sleep 1
+    #break # Comment out this line to download all games
+done
+
+# Clean up
+cleanup