Fix BZ process filter for macOS #568
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
toebeann
requested review from
Metious,
MrPurple6411,
LeeTwentyThree,
EldritchCarMaker and
JKohlman
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes made in this pull request
Rationale
On macOS, while the
.appfor the game is namedSubnauticaZero.app, this is not an executable file and is not what is typically seen by BepInEx as the name of the process. A folder with an.appextension is a special folder structure used by Apple to denote an application package. Inside of it is a metadata file that tells macOS what to do when the .app is "executed," and in the case of BZ it points to the fileSubnauticaZero.app/Contents/MacOS/Subnautica Below Zero. This file is the actual executable that runs the Unity app on macOS, and is what BepInEx sees as the name of the running process. Thus, theSubnauticaZero.exeprocess filter does not catch this (the.exeis inconsequential - BepInEx strips file extensions when comparing process names).As some of you may be aware, I created BZMacProcessFix to address this since not only SML/Nautilus have this issue (QMM does as well, and since it is no longer being maintained, will never work on macOS without this workaround). However it seems that in some cases this patcher is unable to fulfill its task, mainly reported by users of old macOS versions that I am unable to test on eg. 32bit Mojave. It is therefore recommended not to rely solely on this patcher, and to actually include the correct process filter for macOS in your BepInEx plugins wherever possible.
Note that no change is required for OG Subnautica as the executable on macOS is simply named
Subnautica, which is covered by theSubnautica.exeprocess filter as file extensions are ignored when comparing.How can we verify the macOS executable name without having access to macOS?
If you head to the Depots tab of the steamdb.info page for the game, then click the ID next to the macOS config for the game, this will take you to a file listing for the depot (https://steamdb.info/depot/848453/ as of current writing). In this file listing you can see an entry for
SubnauticaZero.app/Contents/MacOS/Subnautica Below Zero, which coincidentally is the only file listed within theSubnauticaZero.app/Contents/MacOSfolder. macOS application packages rely on executable files which will be referenced by the application's metadata (eg. to determine what executable to run when the application is "executed") being placed in this folder, so you can largely rely on this.