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.

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

Add: Decky Framegen #751

Open
wants to merge 34 commits into
base: main
Choose a base branch
from

Conversation

xXJSONDeruloXx
Copy link
Contributor

@xXJSONDeruloXx xXJSONDeruloXx commented Jan 25, 2025

Decky Framegen

Decky Framegen is a plugin that allows installing, uninstalling, and applying DLSS-Enabler mods fully within game mode. Users will be able to apply launch options for a running game once the mod is installed, and on next launch will be able to select DLSS upscaling and frame generation options that were previously non-selectable. When selected, these options will actually enable their FSR equivalents.

Users can also easily uninstall the mod to clean up the created mod path and containing files, and "unpatch" any running game to remove the launch options that apply the mod from within the plugin.

Task Checklist

Developer

  • I am the original author or an authorized maintainer of this plugin.
  • I have abided by the licenses of the libraries I am utilizing, including attaching license notices where appropriate.

Plugin

  • I have verified that my plugin works properly on the Stable and Beta update channels of SteamOS.
  • I have verified my plugin is unique or provides more/alternative functionality to a plugin already on the store.

Backend

  • No: I am using a custom backend other than Python.
  • No: I am using a tool or software from a 3rd party FOSS project that does not have it's dependencies statically linked.
    • Per discussions, I have refactored to include remote binaries for all external resources with respective licenses bundled in /assets.
  • No: I am using a custom binary that has all of its dependencies statically linked.

Community

  • I have tested and left feedback on two other pull requests for new or updating plugins.
  • I have commented links to my testing report in this PR.

Testing

  • Tested on SteamOS Preview update channel.

@xXJSONDeruloXx xXJSONDeruloXx changed the title Framegen Decky Framegen Jan 25, 2025
@xXJSONDeruloXx xXJSONDeruloXx changed the title Decky Framegen Add: Decky Framegen Jan 25, 2025
@xXJSONDeruloXx xXJSONDeruloXx marked this pull request as ready for review January 25, 2025 01:56
@xXJSONDeruloXx xXJSONDeruloXx requested a review from a team as a code owner January 25, 2025 01:56
@EMERALD0874
Copy link
Member

@xXJSONDeruloXx Please fix your testing reports. You listed your Steam/SteamOS/Decky versions where you are supposed to list your branch (ex. Stable, Pre-Release, Beta). You need to replace the "VersionHere" text with the numbers you gave.

@xXJSONDeruloXx
Copy link
Contributor Author

@EMERALD0874 should be fixed now, thanks

@EMERALD0874
Copy link
Member

EMERALD0874 commented Jan 25, 2025

PR template has been updated to conform with new standards. The following PRs were tested by this PR's author:

@xXJSONDeruloXx
Copy link
Contributor Author

Pushes to fix XESS License from PDF to MD as requested by maintainer, and incorporated UI feedback from issues on plugin repo

Copy link
Member

@TrainDoctor TrainDoctor left a comment

Choose a reason for hiding this comment

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

Thanks for your patience @xXJSONDeruloXx, looks like we're good to send this to testing.

@xXJSONDeruloXx
Copy link
Contributor Author

Thank you so much!

@TrainDoctor TrainDoctor removed the needsfix An issue/change request needs to be resolved label Feb 2, 2025
@TrainDoctor TrainDoctor requested review from a team February 2, 2025 03:26
@xXJSONDeruloXx
Copy link
Contributor Author

@TrainDoctor added remote_binary_bundling param to package.json, let me know if any issues

@xXJSONDeruloXx
Copy link
Contributor Author

@EMERALD0874 @TrainDoctor per discussions in the discord, I have updated the plugin to address requirements with enumerated remote binaries, and ensured the performance is on stable build for max compatibility. Let me know if this is good for testing or if any other adjustments are needed!

@xXJSONDeruloXx
Copy link
Contributor Author

did one other push to disable bundling for plugin store requirements, on feature lock pending your reviews now!

@TrainDoctor
Copy link
Member

did one other push to disable bundling for plugin store requirements, on feature lock pending your reviews now!

Changes look good. Off to testing, for real this time!

@itsOwen
Copy link
Contributor

itsOwen commented Feb 9, 2025

Plugin Testing Report

Installed Plugins

  • LetMeReShade - v0.3 (not on Decky)
  • PlayCount - 1.5

Specifications

  • SteamOS 3.6.20 (STABLE)
  • Steam 1738026274 (STABLE)
  • Decky 3.1.3 (Pre-release)

Issues

Major blocking issues: N/A
Minor non-blocking issues: The install button didn’t appear at first, but after a restart, everything worked fine.

Summary

I tested it with multiple games, and it works as intended. I think it’s ready to be published on the main store with the current set of features. It might require more testing when you add back the OptiScaler.

@xXJSONDeruloXx
Copy link
Contributor Author

Thanks for the review! Currently I think the build without optiscaler 7 should be fine, as that's experimental and the benefits of adding fg to non fg games does not outweigh the handful of games it breaks. The current enabler assets here are pretty stable and do the DLSS>FSR swaps pretty reliably

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

5 participants