Added: Support for running tools via Proton(tricks) and REDmod on Linux #1989

Sewer56 · 2024-09-05T17:46:48Z

This PR adds support for:

Detection of protontricks
Running tools via Proton(tricks)
Running REDmod via Protontricks
- Handles versions 1.8.0 upwards. Including breaking working dir change in upcoming version.
Diagnostic for missing protontricks
Diagnostic for missing REDmod
- Clicking the link takes you directly to relevant store page.
Fixes incorrect casing of redMod.exe (previously redmod.exe)
Overlay messagebox with only 'OK' button
- This is no longer used, I've kept this in case anyone thinks it will be useful.
- Don't request changes if you don't want this, just remove it and push.

RedModDeploy.mp4

Design

The screenshots above were already shown to design; with no further feedback requested for the time being.

It may be useful to print out the list of REDmod(s) that caused for a certain diagnostic to be emitted, however we've decided to wait for now.

QA Matrix

Check the following:

Hyperlinks for REDmod DLC work on all stores, Windows and Linux
Nexus App via AppImage (you may get 'missing protontricks' error)
Cyberpunk 2077 without REDmod installed
Anything else you can think of.

Issues I'm aware of:

If you install REDmod without updating loadout, the diagnostic will still show up
- Research: Diagnostic Refresh Triggers #1986

Tags

fixes #1982
fixes #1774
fixes #1915

… from Diagnostic

erri120 · 2024-09-09T08:49:00Z

src/Games/NexusMods.Games.RedEngine/RedModDeployTool.cs

+        }
+        else
+        {
+            var batchPath = fs.GetKnownPath(KnownPath.EntryDirectory).Combine("Resources/Cyberpunk2077/deploy_redmod.bat");


This won't work. I'd suggest making the bat file an embedded resource and creating the file at runtime in the temp directory or similar.

To prevent antivirus software from going crazy on Windows, we'd only want to embed on Linux.

If I recall correctly, I brought this up at standup.

Generating a .bat and extracting to disk was the thing I originally wanted to do.

However the people there requested I don't do that and make it a static file that ships with the App pre-extracted instead.

So I'm rather confused, why am I being asked here to do what I originally intended to do? This shouldn't be a case of something like Working Directory vs $OWD for AppImage.

There is the fact I didn't make the .bat file get copied on Linux only, but that's a separate fixup.

Did you test this with an AppImage? I want to avoid using CopyToOutputDirectory if possible, as it can make packaging difficult.

Good point. Let me do that after I fixup CI.
Edit: And redownload game.

Took me a bit to respond. I just downloaded Cyberpunk 3 times, because Steam would give me errors after downloading the entire 80GB.

Works fine on AppImage, just need it to not copy to output on Windows.
The batch script is not executed directly, so executable permission (or lack of) doesn't apply to it.

I made the file not copy on Windows, however it depends on the Host OS the App was built in; due to MSBuild limitations.
Details in the commit contents.

I still think we should go with the embedded route. CopyToOutputDirectory is just a hassle.

I wanted it too, if you remember however; standup requested I didn't. I followed their request.

Putting it as an embedded resource will make it embed in Windows too, due to same limitations of MSBuild that I'm suffering from here that require this terrible hack.

I don't want some silly AV software to have the wrong impressions because it sees a valid looking batch script starting with @echo off embedded raw within the binary. Unless you'd want me to compress it or something to hide it.

At the end of the day, security on Windows is all terrorism really. Be it the protection racket called code signing or otherwise.

Putting it as an embedded resource will make it embed in Windows too

How? What you have currently only copies for Linux. EmbeddedResource can have a condition as well, the same condition should work here.

Ah, I thought you wanted me to use the standard machinery here because the .targets file was unsightly to see.
If it's embedding via the targets file, then that would work.

LukeNexusMods · 2024-09-09T12:27:20Z

@Sewer56 Whats the best way to test this?

Sewer56 · 2024-09-09T12:36:35Z

@LukeNexusMods Try to install a REDmod like
https://www.nexusmods.com/cyberpunk2077/mods/9450/ to your game. You'll know it succeeded if files are generated in the r6/cache/modded folder on deploy (as seen in video clip)

I listed the things to watch out for QA in the opening post.

Today I became a PS2 developer. I acquired an EmotionEngine. Unfortunately, the only emotion I experienced, was a lot of frustration as a developer. 2 hours wasted, and no decent solution that works within the confines of MSBuild.

github-actions · 2024-09-10T15:53:18Z

This PR conflicts with main. You need to rebase the PR before it can be merged.

github-actions · 2024-09-11T14:25:10Z

This PR doesn't conflict with main anymore. It can be merged after all status checks have passed and it has been reviewed.

Sewer56 · 2024-09-11T14:47:41Z

Re-tested with main merged, including AppImage. We're all good.

Sewer56 added 14 commits September 3, 2024 02:54

Added: Runtime check for protontricks dependency.

317771a

Added: Missing Protontricks Dialog

7e7056d

WIP: Display Protontricks Box when not Available

6f91ecb

Added: Generic Protontricks Runner for Tools

39a6ad4

Merge branch 'running-tools-wine-docs' into run-protontricks

0a95ac2

Added: Diagnostic for missing Protontricks for REDmod

684ef6a

Added: Diagnostic for missing REDmod DLC

99eae76

Removed: Missing Protontricks Overlay

1c5f646

Improved: Open the REDmod DLC Download Page for User's Store DIrectly…

927be5e

… from Diagnostic

Added: CMD Wrapper script for REDmod

66ae758

Merge remote-tracking branch 'origin/main' into run-protontricks

db001dc

Removed: Protontricks MessageBox Leftovers

bb54f39

Removed: Accidental Spacing from earlier Commit

b8bdb3e

Reverted: ProcessFactory can be internal again

cb33280

Sewer56 requested a review from erri120 September 5, 2024 17:46

Sewer56 self-assigned this Sep 5, 2024

Sewer56 force-pushed the run-protontricks branch from 2347d44 to 4e9eecd Compare September 5, 2024 18:13

Added: Missing Service for GameToolRunner in Tests

d3b9f59

Sewer56 force-pushed the run-protontricks branch from 4e9eecd to d3b9f59 Compare September 5, 2024 18:19

erri120 requested changes Sep 9, 2024

View reviewed changes

Sewer56 added 2 commits September 9, 2024 14:43

Fixed: Duplicate Service Registrations in CI

dde2eeb

Added: Don't copy bat file on Publish in Windows

0110b5a

Today I became a PS2 developer. I acquired an EmotionEngine. Unfortunately, the only emotion I experienced, was a lot of frustration as a developer. 2 hours wasted, and no decent solution that works within the confines of MSBuild.

github-actions bot added the status-needs-rebase Set by CI do not remove label Sep 10, 2024

Added: Code to extract REDMod to temporary Disk Location

e66602a

erri120 approved these changes Sep 11, 2024

View reviewed changes

Merge remote-tracking branch 'origin/main' into run-protontricks

d453b4b

github-actions bot removed the status-needs-rebase Set by CI do not remove label Sep 11, 2024

Sewer56 merged commit 0630524 into main Sep 11, 2024
12 checks passed

Al12rs deleted the run-protontricks branch September 18, 2024 15:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added: Support for running tools via Proton(tricks) and REDmod on Linux #1989

Added: Support for running tools via Proton(tricks) and REDmod on Linux #1989

Sewer56 commented Sep 5, 2024 •

edited

Loading

erri120 Sep 9, 2024 •

edited

Loading

Sewer56 Sep 9, 2024

erri120 Sep 9, 2024

Sewer56 Sep 9, 2024 •

edited

Loading

Sewer56 Sep 9, 2024 •

edited

Loading

Sewer56 Sep 10, 2024 •

edited

Loading

erri120 Sep 11, 2024

Sewer56 Sep 11, 2024 •

edited

Loading

erri120 Sep 11, 2024 •

edited

Loading

Sewer56 Sep 11, 2024

LukeNexusMods commented Sep 9, 2024

Sewer56 commented Sep 9, 2024 •

edited

Loading

github-actions bot commented Sep 10, 2024

github-actions bot commented Sep 11, 2024

Sewer56 commented Sep 11, 2024

Added: Support for running tools via Proton(tricks) and REDmod on Linux #1989

Added: Support for running tools via Proton(tricks) and REDmod on Linux #1989

Conversation

Sewer56 commented Sep 5, 2024 • edited Loading

Design

QA Matrix

Tags

erri120 Sep 9, 2024 • edited Loading

Choose a reason for hiding this comment

Sewer56 Sep 9, 2024

Choose a reason for hiding this comment

erri120 Sep 9, 2024

Choose a reason for hiding this comment

Sewer56 Sep 9, 2024 • edited Loading

Choose a reason for hiding this comment

Sewer56 Sep 9, 2024 • edited Loading

Choose a reason for hiding this comment

Sewer56 Sep 10, 2024 • edited Loading

Choose a reason for hiding this comment

erri120 Sep 11, 2024

Choose a reason for hiding this comment

Sewer56 Sep 11, 2024 • edited Loading

Choose a reason for hiding this comment

erri120 Sep 11, 2024 • edited Loading

Choose a reason for hiding this comment

Sewer56 Sep 11, 2024

Choose a reason for hiding this comment

LukeNexusMods commented Sep 9, 2024

Sewer56 commented Sep 9, 2024 • edited Loading

github-actions bot commented Sep 10, 2024

github-actions bot commented Sep 11, 2024

Sewer56 commented Sep 11, 2024

Sewer56 commented Sep 5, 2024 •

edited

Loading

erri120 Sep 9, 2024 •

edited

Loading

Sewer56 Sep 9, 2024 •

edited

Loading

Sewer56 Sep 9, 2024 •

edited

Loading

Sewer56 Sep 10, 2024 •

edited

Loading

Sewer56 Sep 11, 2024 •

edited

Loading

erri120 Sep 11, 2024 •

edited

Loading

Sewer56 commented Sep 9, 2024 •

edited

Loading