Command line¶
Open a terminal in the folder that contains your .uproject. The launcher is in UnrealPy’s Tools folder. For a Fab install, look inside your engine's Engine/Plugins/Marketplace folder for UnrealPy.
- On Windows, run
unrealpy.cmd. - On Linux, run
unrealpy.sh.
Add that Tools folder to your PATH or pass the full launcher path. The examples use unrealpy for either launcher.
| Command | What it does |
|---|---|
unrealpy env |
Set up or sync the project’s Python environment. |
unrealpy stubs |
Refresh the Python type stubs. |
unrealpy run Python/example.py |
Run a script in the game. Add --editor to run in an editor session. |
unrealpy test |
Run project tests in the engine. Arguments after -- go to pytest. |
unrealpy package --config Development |
Package the project with Python and its runtime dependencies. |
Use unrealpy --help or unrealpy <command> --help for more options. See Packaging for the build walkthrough.