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

[Feat] Passing arguments via protocol URLs #4186

Merged
merged 2 commits into from
Jan 10, 2025
Merged

Conversation

CommandMC
Copy link
Collaborator

Protocol URLs can now use a new format based on URL search params. This makes it possible to specify arguments to pass to runners/games when launching through them, and generally makes them easier to change/extend later.
New-style example:

heroic://launch?appName=Quail&runner=legendary&arg=foo&arg=bar

Usage of protocol URLs inside Heroic has been updated accordingly

See commit messages for details

Closes #4182


Use the following Checklist if you have changed something on the Backend or Frontend:

  • Tested the feature and it's working on a current and clean install.
  • Tested the main App features and they are still working on a current and clean install. (Login, Install, Play, Uninstall, Move games, etc.)
  • Created / Updated Tests (If necessary)
  • Created / Updated documentation (If necessary)

@CommandMC CommandMC added the pr:ready-for-review Feature-complete, ready for the grind! :P label Dec 19, 2024
@CommandMC CommandMC requested a review from a team December 19, 2024 22:32
@CommandMC CommandMC self-assigned this Dec 19, 2024
@CommandMC CommandMC requested review from arielj, flavioislima, Nocccer and imLinguin and removed request for a team December 19, 2024 22:32
Copy link
Collaborator

@arielj arielj left a comment

Choose a reason for hiding this comment

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

Changes look good to me.

It will conflict a bit with #4188 but nothing crazy

Using URL parameters (`?foo=bar`) to specify options in protocol URLs makes them
easier to extend/change later, and allows us to add features like launch
parameters (which may be specified multiple times)

"Old-style" URLs of course still work
The new `arg` parameter can be used (multiple times if necessary) to specify
extra parameters to pass to runners/the game
@Sewer56
Copy link

Sewer56 commented Jan 8, 2025

My notes on the PR are in this comment:

#4182 (comment)

@CommandMC CommandMC merged commit 7ba121e into main Jan 10, 2025
9 checks passed
@CommandMC CommandMC deleted the feat/protocol-args branch January 10, 2025 00:58
@Heroic-Games-Launcher Heroic-Games-Launcher locked and limited conversation to collaborators Jan 10, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
pr:ready-for-review Feature-complete, ready for the grind! :P
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request: Command-line Arguments when Launching Games via Protocol
3 participants