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 uet run command #125

Merged
merged 1 commit into from
Jan 12, 2025
Merged

Add uet run command #125

merged 1 commit into from
Jan 12, 2025

Conversation

hach-que
Copy link
Member

@hach-que hach-que commented Jan 12, 2025

This adds a uet run command that runs the editor, game or related tool such as UAT or UBT. This is primarily useful so you don't have to remember the exact path to tools such as UAT.

The 'target' argument specifies what to run, and it can be any of the following:

editor:         Run the Unreal Engine editor.
editor-cmd:     Run the Unreal Engine editor as a command-line application.
game:           Run the Unreal Engine game for this project on the current platform. This uses 
                the editor binary to quickly launch the game. This can only be used in a project context.
uat:            Run UnrealAutomationTool.
ubt:            Run UnrealBuildTool.
uba-visualizer: Run the Unreal Build Accelerator visualizer.

If --path points to a project file, the target will automatically receive the project file as an argument in an appropriate manner, if possible.

This command uses the same resolution logic as uet build and therefore has sensible heuristics - running it in a directory with a .uproject file will pick the engine version based on what's in the .uproject file, running it in an engine directory will automatically use that engine, so on and so forth.

uet uat will not automatically supply the -project argument (as it is not permitted unless the UAT sub-command allows it). To have the -project argument automatically supplied to UAT, use uet uat --project <args> instead.

If you don't specify a target on the command line, it defaults to the running the editor.

@hach-que hach-que changed the title Add 'uet run' command Add uet run command Jan 12, 2025
@hach-que hach-que enabled auto-merge (squash) January 12, 2025 07:01
@hach-que hach-que merged commit 1f981df into main Jan 12, 2025
22 checks passed
@hach-que hach-que deleted the uet-run branch January 12, 2025 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant