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 Deck Settings #747

Merged
merged 1 commit into from
Jan 25, 2025
Merged

Conversation

Josh5
Copy link
Contributor

@Josh5 Josh5 commented Jan 17, 2025

Deck Settings

This plugin integrates with the Deck Settings API (https://deckverified.games) to fetch game compatibility and configuration reports. These reports are sourced from the community-driven repository at https://github.com/DeckSettings/game-reports-steamos. The plugin allows users to easily view game-specific performance tweaks, compatibility information, and configuration suggestions directly on their Steam Deck, streamlining the process of optimizing game settings for handheld devices.

Features:

  • Fetches and displays game reports tailored for handheld gaming devices like the Steam Deck, ROG Ally, and others.
  • Provides quick access to community-verified configuration tips, graphics settings, and performance tweaks.
  • Leverages the Deck Settings API to dynamically retrieve the latest game data.
  • Allows users to search for game configurations by name or App ID.

This is the first submission of the plugin to the Decky plugin repository.

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.
  • No: I am using a custom binary that has all of it's 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 Stable or Beta update channel.

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.

Please update the license file with information or if you decide to use another license place the text for that license above the original in license file. Please delete the py_modules folder if you are not making use of it. The same for main.py if you're not utilizing the python backend as well.
Please update the description in package.json.
Please remove the flags from plugin.json and add plugin tags that match your plugin. Since you're plugin is not the template or using root, you can remove both of those tags. I don't see a reference to gamesearch component but the file is empty, is this for future use?
Please make these changes and your plugin can go to testing, thanks.

@Josh5 Josh5 force-pushed the pr-decky-game-settings branch from 56712e0 to bba4520 Compare January 22, 2025 03:34
@Josh5
Copy link
Contributor Author

Josh5 commented Jan 22, 2025

The GameSearch component completely sliped in there. Was replaced when I did the SearchResultsView.
Thanks for these details. Seems I missed a lot of things.

  • Deleted empty GameSearch componenet file.
  • Updated the LICENSE file with myself as an author. Keeping license as BSD 3-Clause License.
  • Removed the py_modules directory.
  • Removed the main.py.
  • Updated the description in package.json (and README.md).
  • Removed flags and updated tags in plugin.json.

@TrainDoctor
Copy link
Member

@Josh5 please rebase on main to get rid of the playcount merge

@Josh5 Josh5 force-pushed the pr-decky-game-settings branch from 2a86a4a to 9fc66b1 Compare January 22, 2025 05:57
@Josh5
Copy link
Contributor Author

Josh5 commented Jan 22, 2025

@TrainDoctor I have rebased to main. Thanks.

@TrainDoctor TrainDoctor requested review from a team January 22, 2025 07:03
@justjoeyuk justjoeyuk mentioned this pull request Jan 24, 2025
8 tasks
@justjoeyuk
Copy link

This is a good idea. I've tested and it appears to work fine on Stable/Beta channels. It would be nice to somehow submit reports for games via the plugin, though or to somehow improve the plugin in such a way that it is capable of adding value to your database of reports. Otherwise, at the moment, it's a plugin that's only capable of showing 1 or 2 reports for a handful of games.

If you added an option on the Game Page to allow users to submit "community" reports, I feel that even I would submit reports for some of the games I play.

@xXJSONDeruloXx
Copy link
Contributor

xXJSONDeruloXx commented Jan 25, 2025

Plugin Testing Report

Installed Plugins

  • Pause Games - 1.0.0-b2be59f
  • PlayTime - 2.0.9-c9445a5
  • HLTB for Deck 2.04-7d39e65
  • DeckSettings - 0.0.0-9fc66b1
  • Audio Loader - 1.6.0
  • MagicPods 1.0.7
  • Decky Terminal - 0.4.1
  • SteamGridDB 1.5.1-loaderv2
  • ProtonDB Badges - 1.1.0
  • Junk-Store - 1.1.8
  • CSS Loader - 2.1.2
  • Crosshairs- 1.0.0
  • DeckRoulette - 1.1.6-d0eea04
  • Decky Framegen - 0.0.1

Specifications

  • SteamOS 3.6.20 (stable
  • Steam 1737514353 (stable)
  • Decky 3.0.5 (stable)

Issues

Has the following major blocking issue(s): NONE
Has the following minor non-blocking issue(s): most games I viewed had no reports, with no way to add a report in plugin

Summary

everything seems to work well, though most games I tried said 0 reports. I suppose it's more of an issue with the site itself. Great plugin!

@xXJSONDeruloXx xXJSONDeruloXx mentioned this pull request Jan 25, 2025
7 tasks
@Josh5
Copy link
Contributor Author

Josh5 commented Jan 25, 2025

Some good points raised.

At the moment, the site and database are only a few weeks old. I imagine as it gets used more, the number of community supplied reports will grow.

I will look into developing a method of easily submitting reports from the plugin in the future. At the moment, I'd recommend using a companion mobile view via the site or even the official github app for submitting reports.

@EMERALD0874
Copy link
Member

@Josh5 Your PR has been updated to use the latest version of the PR template. Please see the Community section of the Task Checklist regarding testing two other PRs to get the quickest response from our team. There are additional comments in the Markdown when you edit the PR text which you may find helpful. Thanks!

@EMERALD0874
Copy link
Member

Ignore my previous comment, looks like you have the testers you needed and Train already gave the initial code approval. I looked everything over and it seems good, so I'll go ahead and merge. Thanks for your contribution!

@EMERALD0874 EMERALD0874 merged commit 8a21eb8 into SteamDeckHomebrew:main Jan 25, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants