Add support for command-line user arguments. #63624
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
reduz
force-pushed
the
commandline-user-args
branch
from
2b43658
to
24a3788
Compare
reduz
force-pushed
the
commandline-user-args
branch
from
24a3788
to
d681485
Compare
|
Solves #44750 |
Calinou
reviewed
Jul 29, 2022
Calinou
reviewed
Jul 29, 2022
Calinou
reviewed
Jul 29, 2022
Calinou
reviewed
Jul 29, 2022
reduz
force-pushed
the
commandline-user-args
branch
from
d681485
to
937acfb
Compare
Calinou
reviewed
Jul 30, 2022
reduz
force-pushed
the
commandline-user-args
branch
from
937acfb
to
bc0c998
Compare
Calinou
approved these changes
Jul 30, 2022
akien-mga
reviewed
Jul 31, 2022
akien-mga
approved these changes
Jul 31, 2022
There was a problem hiding this comment.
One issue to fix, otherwise looks fine.
The man page and shell completion files should also be updated but I guess that's something best left to closer to the 4.0 release, there are likely other new/changed options that need to be resynced.
After this I think we should look into removing support for passing unknown arguments before --. This would solve a lot of confusion for users when they don't use the options properly and don't understand why it complains that it can't load a scene. (We could add --scene <path> for loading scenes instead of interpreting any standalone unknown arg as a scene path.)
akien-mga
force-pushed
the
commandline-user-args
branch
3 times, most recently
from
6ec2bdc
to
ed383b3
Compare
Implements the standard Unix double dash (--) commandline argument: * Arguments after a double dash (--) are ignored by Godot and stored for the user. * User can access them via `OS.get_cmdline_user_args()` Example: `godot.exe scene_to_run.tscn --fullscreen -- --start-level 2`
akien-mga
force-pushed
the
commandline-user-args
branch
from
ed383b3
to
0dd6537
Compare
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Implements the standard Unix double dash (--) commandline argument:
OS.get_cmdline_user_args()Example:
godot.exe scene_to_run.tscn --fullscreen -- --start-level factoryFAQ:
Q: What's wrong with using the regular Godot commandline for these things?
A: Godot has a very complex and powerful support for lots of things that can be configured via command-line arguments. As arguments can have sub-arguments or arguments used standalone (as example
godot.exe --position 20,20 scene.tscn --always-on-top) the parser could ignore the ones it does not recognize, but then it has no idea what to do with the sub-arguments.Bugsquad edit: This closes godotengine/godot-proposals#2797 and closes #44750.