Release 3.1.58 (Develop)

.github/workflows/release.yml

@@ -24,7 +24,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           # The talk on the street says this might be a good version for building.
-          node-version: 19.2.0
+          node-version: 20.11.0
           cache: yarn
 
       - name: Install Yarn dependencies

CHANGELOG.md

@@ -1,3 +1,31 @@
+### 3.1.58
+#### Games added
+- Schedule 1
+- Zort
+- Disco Elysium
+- Odd Remedy
+- Dusk
+- Monster Train 2
+- My Dream Setup
+- Hades 2 (@xiaoxiao921)
+- Gatekeeper
+- Pulsar: Lost Colony
+- Songs of Conquest
+- White Knuckle
+- ENA: Dream BBQ
+- Human Fall Flat
+- Magicite
+- ASKA
+
+### 3.1.57
+#### Games added
+- R.E.P.O
+- Gang Beasts
+
+#### Fixes
+- Cached Thunderstore mod list refresh occurs immediately in the background again.
+- Prevented certain mods from not being included in profile imports if the cache is not up-to-date.
+
 ### 3.1.56
 #### Games added
 - Subterror

package.json

@@ -1,6 +1,6 @@
 {
     "name": "r2modman",
-    "version": "3.1.56",
+    "version": "3.1.58",
     "description": "A simple and easy to use mod manager for many games using Thunderstore.",
     "productName": "r2modman",
     "author": "ebkr",

src/App.vue

@@ -60,6 +60,7 @@ export default class App extends mixins(UtilityMixin) {
         const settings: ManagerSettings = await this.$store.dispatch('resetActiveGame');
 
         this.hookBackgroundUpdateThunderstoreModList();
+        this.hookModInstallingViaProtocol();
         await this.checkCdnConnection();
 
         InstallationRuleApplicator.apply();

src/_managerinf/ManagerInformation.ts

@@ -1,7 +1,7 @@
 import VersionNumber from '../model/VersionNumber';
 
 export default class ManagerInformation {
-    public static VERSION: VersionNumber = new VersionNumber('3.1.56');
+    public static VERSION: VersionNumber = new VersionNumber('3.1.58');
     public static IS_PORTABLE: boolean = false;
     public static APP_NAME: string = "r2modman";
 }

src/components/ModListUpdateBanner.vue

@@ -37,13 +37,18 @@ export default class ModListUpdateBanner extends Vue {
                 {{ $store.state.tsMods.thunderstoreModListUpdateStatus }}
             </span>
             <span v-else-if="updateError">
-                Error updating the mod list.
+                Error refreshing the mod list.
                 <a @click="openErrorModal">View error details</a>.
                 <br />
-                The manager will keep trying to update the mod list in the background.
+                The manager will keep trying to refresh the mod list in the background.
+            </span>
+            <span v-else-if="$store.getters['download/activeDownloadCount'] > 0">
+                An error occurred when refreshing the mod list from Thunderstore.<br />
+                However, the mod list can't be refreshed while the are mod downloads in progress.<br />
+                Please wait for the downloads to finish before continuing.
             </span>
             <span v-else>
-                An error occurred when updating the mod list from Thunderstore.
+                An error occurred when refreshing the mod list from Thunderstore.
                 Would you like to
                 <a @click="updateModList">try again now</a>?
             </span>

src/components/buttons/DonateButton.vue

@@ -1,6 +1,7 @@
 <template>
-    <Link :url="mod.getDonationLink()"
-          :target="'external'"
+    <Link v-if="mod && mod.getDonationLink()"
+          :url="mod.getDonationLink()"
+          target="external"
           class="card-footer-item"
           v-tooltip.left="{content: 'Donate to the mod author', distance: 0}">
         <i class='fas fa-heart margin-right margin-right--half-width'></i>

src/components/buttons/DonateIconButton.vue

@@ -0,0 +1,30 @@
+<template>
+    <span v-if="mod && mod.getDonationLink() && extraRenderCondition" class="card-header-icon">
+        <Link :url="mod.getDonationLink()" target="external" tag="span">
+            <i class="fas fa-heart" v-tooltip.left="'Donate to the mod author'"></i>
+        </Link>
+    </span>
+</template>
+
+<script lang="ts">
+
+import { Component, Prop, Vue } from 'vue-property-decorator';
+import ThunderstoreMod from '../../model/ThunderstoreMod';
+import { Link } from '../../components/all';
+
+@Component({
+    components: {
+        Link
+    }
+})
+export default class DonateIconButton extends Vue {
+
+    @Prop({required: true})
+    mod: ThunderstoreMod | undefined;
+
+    @Prop({default: true})
+    extraRenderCondition!: boolean;
+
+}
+
+</script>

src/components/mixins/DownloadMixin.vue

@@ -1,12 +1,9 @@
 <script lang='ts'>
 import Vue from 'vue';
 import Component from 'vue-class-component';
-import { Store } from "vuex";
 
-import StatusEnum from "../../model/enums/StatusEnum";
 import R2Error, { throwForR2Error } from "../../model/errors/R2Error";
 import Game from "../../model/game/Game";
-import ManifestV2 from "../../model/ManifestV2";
 import Profile, { ImmutableProfile } from "../../model/Profile";
 import ThunderstoreCombo from "../../model/ThunderstoreCombo";
 import ThunderstoreMod from "../../model/ThunderstoreMod";
@@ -34,11 +31,6 @@ export default class DownloadMixin extends Vue {
         return this.$store.state.modals.isDownloadModModalOpen;
     }
 
-    get ignoreCache(): boolean {
-        const settings = this.$store.getters['settings'];
-        return settings.getContext().global.ignoreCache;
-    }
-
     get thunderstoreMod(): ThunderstoreMod | null {
         return this.$store.state.modals.downloadModModalMod;
     }
@@ -56,59 +48,26 @@ export default class DownloadMixin extends Vue {
         }
     }
 
-    static downloadProgressCallback(
-        store: Store<any>,
-        assignId: number,
-        downloadProgress: number,
-        modName: string,
-        status: number,
-        err: R2Error | null,
-        closeModProgressModal?: () => void,
-    ) {
-        if (status === StatusEnum.FAILURE) {
-            if (closeModProgressModal !== undefined) {
-                closeModProgressModal();
-            }
-            store.commit('download/updateDownload', {assignId, failed: true});
-            if (err !== null) {
-                DownloadMixin.addSolutionsToError(err);
-                throw err;
-            }
-        } else if (status === StatusEnum.PENDING || status === StatusEnum.SUCCESS) {
-            store.commit('download/updateDownload', {assignId, modName, downloadProgress});
-        }
-    }
-
     async installModsAndResolveConflicts(
         downloadedMods: ThunderstoreCombo[],
         profile: ImmutableProfile,
         assignId: number
     ): Promise<void> {
         await ProfileModList.requestLock(async () => {
-            const modList: ManifestV2[] = await installModsToProfile(downloadedMods, profile, undefined,(status, modName, installProgress) => {
-                this.$store.commit('download/updateDownload', {assignId, modName, installProgress});
-            });
-            await this.$store.dispatch('profile/updateModList', modList);
-            throwForR2Error(await ConflictManagementProvider.instance.resolveConflicts(modList, profile));
+            try {
+                const modList = await installModsToProfile(downloadedMods, profile, undefined, (status, modName, installProgress) => {
+                    this.$store.commit('download/updateDownload', {assignId, modName, installProgress});
+                });
+                throwForR2Error(await ConflictManagementProvider.instance.resolveConflicts(modList, profile));
+            } catch (e) {
+                throw e;
+            } finally {
+                // Update the mod list shown in the UI. installModsToProfile()
+                // attempted to save partial changes to disk even if some of
+                // the (un)installations failed.
+                this.$store.dispatch('profile/tryLoadModListFromDisk');
+            }
         });
     }
-
-    static addSolutionsToError(err: R2Error): void {
-        // Sanity check typing.
-        if (!(err instanceof R2Error)) {
-            return;
-        }
-
-        if (
-            err.name.includes("Failed to download mod") ||
-            err.name.includes("System.Net.WebException")
-        ) {
-            err.solution = "Try toggling the preferred Thunderstore CDN in the settings";
-        }
-
-        if (err.message.includes("System.IO.PathTooLongException")) {
-            err.solution = 'Using "Change data folder" option in the settings to select a shorter path might solve the issue';
-        }
-    }
 }
 </script>

src/components/mixins/SplashMixin.vue

@@ -40,6 +40,7 @@ export default class SplashMixin extends Vue {
 
     // Get the list of Thunderstore mods from local cache or API.
     async _getThunderstoreMods() {
+        this.$store.commit('tsMods/startThunderstoreModListUpdate');
         const hasPriorCache = await this.doesGameHaveLocalCache();
 
         if (!hasPriorCache) {
@@ -49,6 +50,13 @@ export default class SplashMixin extends Vue {
         }
 
         await this.triggerStoreModListUpdate();
+        this.$store.commit('tsMods/finishThunderstoreModListUpdate');
+
+        if (hasPriorCache) {
+            // We want this to trigger in the background to ensure that the user gets an up-to-date modlist as soon as possible.
+            this.$store.dispatch('tsMods/syncPackageList');
+        }
+
         await this.moveToNextScreen();
     }
 

src/components/mixins/UtilityMixin.vue

@@ -2,18 +2,66 @@
 import Vue from 'vue';
 import Component from 'vue-class-component';
 
+import Profile from '../../model/Profile';
 import R2Error from '../../model/errors/R2Error';
+import ThunderstoreCombo from '../../model/ThunderstoreCombo';
 import CdnProvider from '../../providers/generic/connection/CdnProvider';
+import InteractionProvider from '../../providers/ror2/system/InteractionProvider';
+import { LogSeverity } from '../../providers/ror2/logging/LoggerProvider';
+import ProfileModList from '../../r2mm/mods/ProfileModList';
 
 @Component
 export default class UtilityMixin extends Vue {
     readonly REFRESH_INTERVAL = 5 * 60 * 1000;
     private tsBackgroundRefreshFailed = false;
 
+    get profile(): Profile {
+        return this.$store.getters['profile/activeProfile'];
+    };
+
     hookBackgroundUpdateThunderstoreModList() {
         setInterval(this.backgroundRefreshThunderstoreModList, this.REFRESH_INTERVAL);
     }
 
+    hookModInstallingViaProtocol() {
+        InteractionProvider.instance.hookModInstallProtocol(async (protocolUrl) => {
+            const exemptRoutes = ["index", "splash", "profiles"];
+
+            if (this.$route.name && exemptRoutes.includes(this.$route.name)) {
+                this.$store.commit('error/handleError', {
+                    error: new R2Error(
+                        "Unable to install mod(s)",
+                        "Mod installation via a link is not possible when a game and a profile are not selected",
+                        "Please select a game and a profile before attempting to install a mod via a link."
+                    ), 
+                    severity: LogSeverity.ACTION_STOPPED
+                });
+                return;
+            }
+
+            const game = this.$store.state.activeGame;
+            const combo: ThunderstoreCombo | R2Error = await ThunderstoreCombo.fromProtocol(protocolUrl, game);
+            if (combo instanceof R2Error) {
+                this.$store.commit('error/handleError', {
+                    error: combo,
+                    severity: LogSeverity.ACTION_STOPPED
+                });
+                return;
+            }
+
+            try {
+                await this.$store.dispatch('download/downloadAndInstallSpecific', {profile: this.profile.asImmutableProfile(), combo});
+                const modList = await ProfileModList.getModList(this.profile.asImmutableProfile());
+                if (modList instanceof R2Error) {
+                    throw modList;
+                }
+                await this.$store.dispatch('profile/updateModList', modList);
+            } catch (err) {
+                this.$store.commit('error/handleError', R2Error.fromThrownValue(err));
+            }
+        });
+    }
+
     /**
      * Periodically refresh the Thunderstore mod list in the background.
      *