Release v2.1.1

Fix some characters in the password breaking the command
closes #80
2026-02-05 14:11:18 +01:00 · 2023-04-13 16:39:59 +02:00 · 2023-04-13 16:23:51 +02:00 · 2023-04-13 16:22:44 +02:00 · 2023-04-10 18:09:18 +02:00 · 2023-04-10 18:08:43 +02:00
9 changed files with 507 additions and 3158 deletions
--- a/.github/workflows/github-repo-stats.yml
+++ b/.github/workflows/github-repo-stats.yml
@@ -0,0 +1,19 @@
+name: github-repo-stats
+
+on:
+  schedule:
+    # Run this once per day, towards the end of the day for keeping the most
+    # recent data point most meaningful (hours are interpreted in UTC).
+    - cron: "0 23 * * *"
+  workflow_dispatch: # Allow for running this manually.
+
+jobs:
+  j1:
+    name: github-repo-stats
+    runs-on: ubuntu-latest
+    steps:
+      - name: run-ghrs
+        # Use latest release.
+        uses: jgehrcke/github-repo-stats@v1.4.1 # Don't use latest release for security reasons (what if the workflow gets taken over by a malicious party)
+        with:
+          ghtoken: ${{ secrets.ghrs_github_api_token }}
--- a/README.md
+++ b/README.md
@@ -1,29 +1,103 @@
-<h1 align="center">SteamDepotDownloaderGUI</h1>
+
+<h1 align="center">
+  <br>
+  SteamDepotDownloaderGUI
+  <br>
+</h1>
+
+<h4 align="center">A graphical wrapper of Depotdownloader, designed to make downloading Steam depots easy. built on top of <a href="https://www.electronjs.org" target="_blank">Electron</a>.</h4>

 <p align="center">
-  <img alt="Project Status" src="https://img.shields.io/badge/status-maintained-blue" />
-  <img alt="GitHub all releases" src="https://img.shields.io/github/downloads/mmvanheusden/SteamDepotDownloaderGUI/total?color=orange&label=downloads">
-  <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/mmvanheusden/SteamDepotDownloaderGUI?color=crimson">
-  <img alt="Visitor Count" src="https://visitor-badge.glitch.me/badge?page_id=mmvanheusden.SteamDepotDownloaderGUI">
-  <a href="https://www.codefactor.io/repository/github/mmvanheusden/steamdepotdownloadergui/overview/master"><img src="https://www.codefactor.io/repository/github/mmvanheusden/steamdepotdownloadergui/badge/master" alt="CodeFactor" /></a>
-</p>
-<p align="center">
-  <img alt="Screenshot" src="screenshot.png" />
+  <a href="https://github.com/mmvanheusden/SteamDepotDownloaderGUI/releases/latest">
+    <img src="https://img.shields.io/github/downloads/mmvanheusden/SteamDepotDownloaderGUI/total?color=orange&label=downloads"
+    alt="Download count badge">
+  </a>
+  <a href="https://img.shields.io/github/last-commit/mmvanheusden/SteamDepotDownloaderGUI?color=crimson">
+    <img src="https://img.shields.io/github/last-commit/mmvanheusden/SteamDepotDownloaderGUI?color=crimson"
+    alt="Last contribution badge">
+  </a>
+  <a href="https://github.com/mmvanheusden/SteamDepotDownloaderGUI/releases/latest">
+      <img src="https://img.shields.io/badge/Download -ffbd03?style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAABmJLR0QA/wD/AP+gvaeTAAABd0lEQVRoge2XwUrDQBCGPz3Ee++2UBSvdsGbeLHeFX0lPQhei+8g2AfwSVREK+LJ1oqHUGjRQ7Z0laRJNtldKPPBwoTM7D9/sks2IAiCsKrsAK/AC7DtSmTd1cTAKbAJtIAzVyIuDURGvOFKxKUBL4iB0IiB0IiB0IiB0IiB0IiB0IiB0IgBoA08Ak+AKpCvdO6AGn416zBwDGyRGLljuQmlc9pAEzipKl6HgVtgpOMGSYOdlLyOvtfQ1yPgpgb9WlDAEPjRYwj0jet+yv0iy80ru8AHiyazxiewF6jHXPJMeG3+CoiBy5J1/5dTlWVzAXwD5yXrAJho4YlFbdqesFnzsa6PLWr/PD0bFPAA3GO/YXN7WMspLpLnktweVvooMTPiKDPLHabmLCtpmYF3I96v3E55Doz4zWaCaxYb6Bno4udNRMCR1pzr92wmagFfZH+UfI0xycHPim5gE2Pg0Lb5OU2SVzgAph6anmqtHhWevCAIgh9+AdLMtu/CZhHJAAAAAElFTkSuQmCC"
+      alt="Download latest release badge">
+  </a>
+  <a href="https://visitor-badge.glitch.me/badge?page_id=mmvanheusden.SteamDepotDownloaderGUI">
+    <img src="https://visitor-badge.glitch.me/badge?page_id=mmvanheusden.SteamDepotDownloaderGUI"
+    alt="Visitor count badge">
+  </a>
+  <a href="https://liberapay.com/barbapapa">
+    <img src="https://img.shields.io/badge/Donate-black?logo=liberapay"
+    alt="Donation badge">
+  </a>
+  <a href="https://www.codefactor.io/repository/github/mmvanheusden/steamdepotdownloadergui/badge/master">
+    <img src="https://www.codefactor.io/repository/github/mmvanheusden/steamdepotdownloadergui/badge/master"
+    alt="CodeFactor badge">
+  </a>
 </p>

-<p align="center">SteamDepotDownloaderGUI is a graphical user interface for DepotDownloader.</p>
-<p align="center">You can download older versions of Steam games, useful for testing and speedrunners.</p>
+<p align="center">
+  <a href="#features">Features</a> •
+  <a href="#installation">Installation</a> •
+  <a href="#how-to-use">How to use</a> •
+  <a href="#credits">Credits</a> •
+  <a href="#support">Support</a> •
+  <a href="#contribute">Contribute</a>
+</p>
+
+<p align="center">
+  <img alt="Screenshot of the downloader interface" src="screenshot.png"  
+     style="max-width: 70%;"/>
+</p>
+
+## Features
+
+* Cross platform
+  - Windows
+  - <s>macOS</s>
+  - Linux
+* Cross terminal
+  - Gnome Terminal
+  - cmd
+  - Konsole
+  - xfce4-terminal
+  - Terminator
+  - Manual: produce a script that can be copy pasted into a terminal of choice
+* Support for anonymous downloads

 ## Installation

-Download the latest release for your operating system
-from [GitHub](https://github.com/mmvanheusden/SteamDepotDownloaderGUI/releases/latest).
+If you haven't already, install [.NET SDK 6.0](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) on your computer.
+From then, download the appropriate binary from [here](https://github.com/mmvanheusden/SteamDepotDownloaderGUI/releases/latest).

-## Usage

-Enter everything you normally would in the DepotDownloader console.
+> **Note**
+> No support will be provided for binaries downloaded from unofficial mirrors like softpedia.

-## Contributing
+
+## How to use
+
+Enter everything you normally would in the DepotDownloader console and select your OS/terminal and click download
+
+
+## Credits
+
+This software uses the following open source packages:
+- [Electron](http://electron.atom.io/)
+- [Node.js](https://nodejs.org/)
+- [Primer CSS](https://primer.style/css/)
+- [DepotDownloader](https://github.com/SteamRE/DepotDownloader/)
+- README inspired from [Markdownify](https://github.com/amitmerchant1990/electron-markdownify#readme)
+
+
+## Support
+
+Donations can be made through Liberapay :)
+
+<a href="https://liberapay.com/barbapapa">
+    <img src="https://img.shields.io/badge/Donate-black?logo=liberapay&style=for-the-badge"
+    alt="Donation badge">
+  </a>
+
+## Contribute

 If you want to contribute to SteamDepotDownloaderGUI, please make sure to follow
 the [contributing instructions and guidelines](contributing.md).
@@ -32,3 +106,7 @@ Pull requests are welcome. For major changes, please open an issue first to disc

 Please make sure to keep code consistent and cross-platform compatible.

+
+##### --
+
+##### enjoy 😘
--- a/downloader.js
+++ b/downloader.js
@@ -48,7 +48,7 @@ function submitDotnet() {
 	document.getElementById("dotnetwarning").hidden = true
 	if (os.includes("win")) {
 		console.debug("Opened .NET download page for " + os.charAt(0).toUpperCase() + os.slice(1))
-		void electron.shell.openExternal("https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/sdk-6.0.301-windows-x64-installer")
+		void electron.shell.openExternal("https://aka.ms/dotnet/6.0/dotnet-sdk-win-x64.exe")
 	}
 	if (os.includes("linux")) {
 		console.debug("Opened .NET download page for " + os.charAt(0).toUpperCase() + os.slice(1))
@@ -57,7 +57,7 @@ function submitDotnet() {
 	if (os.includes("darwin")) {
 		console.debug("Opened .NET download page for" + os)
 		//TODO: Apple Silicon(ARM64) URL
-		void electron.shell.openExternal("https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/sdk-6.0.301-macos-x64-installer")
+		void electron.shell.openExternal("https://aka.ms/dotnet/6.0/dotnet-sdk-osx-x64.pkg")
 	}
 }

--- a/electron-builder.yml
+++ b/electron-builder.yml
@@ -1,6 +1,6 @@
-appId: steam.depot.downloader.gui
+appId: rocks.maarten.depotdownloader
 productName: SteamDepotDownloaderGUI
-copyright: Copyright © 2022 mmvanheusden | This work is free. Licensed under the Do What The Fuck You Want To Public License
+copyright: Copyright © 2022 mmvanheusden | This work is free. Licensed under the GNU GPLv3 Public License

 linux:
  executableName: SteamDepotDownloaderGUI
@@ -25,7 +25,7 @@ mac:
        - x64

 win:
-  legalTrademarks: Copyright © 2022 mmvanheusden | This work is free. Licensed under the Do What The Fuck You Want To Public License
+  legalTrademarks: Copyright © 2022 mmvanheusden | This work is free. Licensed under the GNU GPLv3 Public License
  target:
    - target: portable
      arch:
--- a/index.html
+++ b/index.html
@@ -4,7 +4,7 @@
 <head>
 	<meta charset="UTF-8">
 	<meta content="width=device-width, initial-scale=1" name="viewport"/>
-	<link href="https://unpkg.com/@primer/css@20.4.7/dist/primer.css" rel="stylesheet"/>
+	<link href="https://unpkg.com/@primer/css@21.0.0/dist/primer.css" rel="stylesheet"/>
 	<title>SteamDepotDownloaderGUI</title>
 </head>
 <body>
@@ -43,48 +43,38 @@
 			<div class="form-group-header">
 				<label for="username">Username</label>
 			</div>
-			<div aria-label="Enter your username here. (leave empty for anonymous login)" class="form-group-body tooltipped tooltipped-n">
-				<input class="form-control input-block" id="username" type="text"/>
-			</div>
+			<input class="form-control input-block" id="username" type="text" placeholder="Leave empty for anonymous download"/>
 		</div>

 		<div class="form-group mx-3 mt-1">
 			<div class="form-group-header">
 				<label for="password">Password</label>
 			</div>
-			<div aria-label="Enter your password here. (leave empty for anonymous login)" class="form-group-body tooltipped tooltipped-n">
-				<input class="form-control input-block" id="password" type="password"/>
-			</div>
+			<input class="form-control input-block" id="password" type="password" placeholder="Leave empty for anonymous download"/>
 		</div>

-		<div class="form-group mx-3 mt-1">
+		<div class="form-group mx-3 mt-1 required">
 			<div class="form-group-header">
 				<label for="appid">App ID</label>
 			</div>
-			<div aria-label="Enter the App ID here." class="form-group-body tooltipped tooltipped-n">
-				<input class="form-control input-block" id="appid" type="number"/>
-			</div>
+			<input class="form-control input-block" id="appid" type="number"/>
 		</div>

-		<div class="form-group mx-3 mt-1">
+		<div class="form-group mx-3 mt-1 required">
 			<div class="form-group-header">
 				<label for="depotid">Depot ID</label>
 			</div>
-			<div aria-label="Enter the Depot ID here." class="form-group-body tooltipped tooltipped-n">
-				<input class="form-control input-block" id="depotid" type="number"/>
-			</div>
+			<input class="form-control input-block" id="depotid" type="number"/>
 		</div>

-		<div class="form-group mx-3 mt-1">
+		<div class="form-group mx-3 mt-1 required">
 			<div class="form-group-header">
 				<label for="manifestid">Manifest ID</label>
 			</div>
-			<div aria-label="Enter the Manifest ID here." class="form-group-body tooltipped tooltipped-n">
-				<input class="form-control input-block" id="manifestid" type="number"/>
-			</div>
+			<input class="form-control input-block" id="manifestid" type="number"/>
 		</div>

-		<div class="form-group mx-3 mt-1">
+		<div class="form-group mx-3 mt-1 required">
 			<div class="form-group-header ">
 				<label for="osdropdown">Operating system</label>
 			</div>
@@ -106,7 +96,7 @@
 		</div>
 	</form>

-	<div aria-label="Start the download process." class="form-group mt-3 ml-3 mr-3 tooltipped tooltipped-n">
+	<div class="form-group mt-3 ml-3 mr-3">
 		<button class="btn btn-block btn-primary" id="downloadbtn">
 			<svg class="octicon" height="16" viewBox="0 0 16 16" width="16" xmlns="http://www.w3.org/2000/svg">
 				<path d="M7.47 10.78a.75.75 0 001.06 0l3.75-3.75a.75.75 0 00-1.06-1.06L8.75 8.44V1.75a.75.75 0 00-1.5 0v6.69L4.78 5.97a.75.75 0 00-1.06 1.06l3.75 3.75zM3.75 13a.75.75 0 000 1.5h8.5a.75.75 0 000-1.5h-8.5z"
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "steamdepotdownloadergui",
-  "version": "2.0.6",
+  "version": "2.1.1",
  "description": "DepotDownloader Electron frontend",
  "main": "main.js",
  "scripts": {
@@ -30,9 +30,9 @@
  },
  "homepage": "https://github.com/mmvanheusden/SteamDepotDownloaderGUI#readme",
  "devDependencies": {
-    "electron": "^21.2.0",
+    "electron": "^24.0.0",
    "electron-builder": "^23.6.0",
-    "eslint": "^8.25.0"
+    "eslint": "^8.37.0"
  },
  "dependencies": {
    "elecron": "^0.0.1-security",
--- a/screenshot.png
+++ b/screenshot.png
--- a/utils.js
+++ b/utils.js
@@ -4,13 +4,16 @@
 */
 function preDownloadCheck() {
 	return new Promise((resolve, reject) => {
-		let appid = document.forms["theform"]["appid"].value
-		let depotid = document.forms["theform"]["depotid"].value
-		let manifestid = document.forms["theform"]["manifestid"].value
-
 		// Check if all fields are filled
-		if (appid === "" || depotid === "" || manifestid === "") {
-			// Reject before even checking if dotnet is installed
+		const formInputs = document.forms["theform"]
+
+		let unfilledFields = 0
+		for (const input of formInputs) {
+			const isInvalid = input.value === "" && input.parentElement.classList.contains("required")
+			input.parentElement.classList.toggle("errored", isInvalid) // toggle the 'errored' class depending on if isInvalid is true or false.
+			if (isInvalid) unfilledFields++
+		}
+		if (unfilledFields > 0) {
 			reject("emptyField")
 			return
 		}
@@ -153,8 +156,11 @@ const createCommand = () => {
 	// if either the username or password fields are empty, anonymous login is used
 	let anonymous = username === "" || password === ""

+	// Allows enormous strings like &$§"&$="§$/"(§NJUIDW>;!%?aQ52V?*['YsDnRy|(+Q 1h6BmnDQp,(Xr&Th _fMMm|*1T5a^HBuJr)EYKdA$~V*9N~74zg3hf9ZH(!HR"§RH§"H(R being used as password
+	password = password.replace(/"/g, "\"\"")
+
 	// build the username and password flags into one string, allowing for anonymous login
-	let userpass = anonymous ? "" : `-username ${username} -password ${password}`
+	let userpass = anonymous ? "" : `-username ${username} -password "${password}"`

 	const finalPath = platformpath() + path.sep + "games" + path.sep + appid

@@ -162,7 +168,7 @@ const createCommand = () => {
 	if (osdropdown.options[osdropdown.selectedIndex].text.includes("Gnome")) {
 		return `gnome-terminal -e 'bash -c "dotnet ./depotdownloader/DepotDownloader.dll ${userpass} -app ${appid} -depot ${depotid} -manifest ${manifestid} -dir ${finalPath}/ -max-servers 50 -max-downloads 16";bash'`
 	} else if (osdropdown.options[osdropdown.selectedIndex].text.includes("Windows")) {
-		return `start cmd.exe /k dotnet ${platformpath()}${path.sep}depotdownloader${path.sep}DepotDownloader.dll -${userpass} -app ${appid} -depot ${depotid} -manifest ${manifestid} -dir ${finalPath}/ -max-servers 50 -max-downloads 16`
+		return `start cmd.exe /k dotnet ${platformpath()}${path.sep}depotdownloader${path.sep}DepotDownloader.dll ${userpass} -app ${appid} -depot ${depotid} -manifest ${manifestid} -dir ${finalPath}/ -max-servers 50 -max-downloads 16`
 	} else if (osdropdown.options[osdropdown.selectedIndex].text.includes("macOS")) {
 		return `osascript -c 'tell application "Terminal" to do script 'dotnet ./depotdownloader/DepotDownloader.dll ${userpass} -app ${appid} -depot ${depotid} -manifest ${manifestid} -dir ${finalPath}/ -max-servers 50 -max-downloads 16'`
 	} else if (osdropdown.options[osdropdown.selectedIndex].text.includes("Konsole")) {