Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added fix for Gothic Playable Teaser #141

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added fix for Gothic Playable Teaser #141

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f1b5b9
Added fix for Gothic Playable Teaser
Root-Core Sep 23, 2024
0b5c545
Call log.info() explicitly
Root-Core Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions gamefixes-steam/950670.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
"""Game fix for Gothic Playable Teaser"""

from pathlib import Path
from protonfixes import util
from protonfixes.logger import log


def main() -> None:
"""Performance fixes and cleanup of excessive logs"""
modify_settings()
clear_logs()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hard to say if we should do this. Clearing the logs would be a plus, but wouldn't make the game more playable compared to the modify_settings.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally, though, I would want the logs removed to save some space. 1GB+ of generated logs would be a problem for me and I'd hate it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My thinking was to "fix" what the game was doing wrong. So it could be seen as a kind of "game fix." 😊

It's pretty unlikely to cause any harm, but it might also be seen as outside the scope of what we're aiming for.



def modify_settings() -> None:
# Assure that the settings folder exists
path = Path('GothicRemake/Saved/Config/WindowsNoEditor/')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For sanity, I would use util.get_game_install_path as STEAM_COMPAT_INSTALL_PATH is a Steam property so we can have some guarantees of the path and the files that will be removed. I know the Steam client changes to the base game's directory before running the game, but, unfortunately, some users run GE-Proton outside Steam and its runtime, so we might not even be in the expected directory. At worst, this fix would be creating/removing files in their home directory.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we make sure we are in the right directory before running the fix?
For example, by checking and possibly correcting it in fix.py?

This would make all fixes cleaner, easier to read and implement.

Copy link
Member

@R1kaB3rN R1kaB3rN Sep 29, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should continue depending on the client to change to the correct directory and in the case of Steam, it's STEAM_COMPAT_INSTALL_PATH. Only the developers can know with certainty what the correct directories are for the game and they typically make it available to the client in some way (e.g., environment variables, configuration files, etc.). I think protonfixes shouldn't attempt to change directories or attempt to find the correct one, unless the developer had failed to inform the client that metadata somehow or if we want to enforce running the 64-bit executable, which typically require to change to a subdirectory of the base game's directory. Therefore, if a client like Lutris or Heroic fails to change to the correct directory, it's on them.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the context of this fix, I think it would be better to use util.get_game_install_path as it would avoid hardcoding any paths specific to the game and support non-Steam clients as they would be able to override STEAR_COMPAT_INSTALL_PATH.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, but yeah. Maybe there should be a prerequisite before applying any fixes if some are going to be manipulating or creating files. Perhaps we can skip applying Steam fixes all together if STEAR_COMPAT_INSTALL_PATH isn't set in the environment...?

if not path.is_dir():
log.info(f'Creating settings folder "{path}".')
path.mkdir(parents=True, exist_ok=True)

# Assure, that the settings file exists
# Necessary defaults will still be created by the game
path = path / 'Engine.ini'
if not path.is_file():
log.info(f'Creating empty settings file "{path}".')
path.touch(exist_ok=True)

# Disable excessive (as in gigabytes) logging
# Disable motion blur / depth of field / lens flare
game_opts = """
[Core.Log]
Global=off
LogInteractiveProcess=all off

[SystemSettings]
r.MotionBlur.Max=0
r.MotionBlurQuality=0
r.DefaultFeature.MotionBlur=0
r.DepthOfFieldQuality=0
r.LensFlareQuality=0
"""
util.set_ini_options(game_opts, path, 'utf-8', 'game')


def clear_logs() -> None:
# Clear all logs > 10 MB
log_files = Path('GothicRemake/Saved/Logs').glob('*.log')
for file in log_files:
file_size = file.stat().st_size # Bytes
file_size = file_size // 1000 // 1000 # Megabytes
if file.is_file() and file_size > 10:
log.info(f'Removing log file "{file}" with a size of {file_size} MB.')
file.unlink()