Skip to content

Join an existing UnrealPy project

Ask your team which Unreal Engine version and plugin builds the project uses. Install the matching UnrealPy and ScriptCore builds, then get the project through your team’s version control workflow.

Open and verify the project

  1. Open the project’s .uproject. In Edit → Plugins, confirm UnrealPy is enabled. Restart if Unreal prompts you to.

    The enabled UnrealPy entry in the Plugins browser

  2. Let the first start finish. If your team uses Manage Python Environment, UnrealPy prepares the local environment from the project’s Python dependency files. Open Window → Output Log if setup reports an error.

  3. Open a known test level and press Play. Pick a Python-backed actor in the Outliner to inspect its exposed values in Details. For a Blueprint with a bound script, its Script menu shows the binding.

Designers can change Blueprint defaults and level instances through Unreal Editor. When a change also needs Python, share the script and any changed Unreal assets in the same revision.

What belongs in version control?

Share with the project Generate on each machine
Project Python source, including scripts attached to Blueprints The project’s .venv and Python caches
.uproject, relevant Config/ files, and the levels and Blueprint assets the scripts use Generated Unreal type stubs under Intermediate/PythonStubs/
pyproject.toml and uv.lock when UnrealPy manages dependencies Local IDE setup and build output
Config/ScriptBindings.json when generated for a project with script bindings Logs and temporary editor data under Saved/

Use a project-relative Venv Path, such as .venv, for shared settings. Keep machine-specific paths out of shared configuration. Follow your team's existing workflow for Unreal binaries and verify a new checkout with the same engine and plugin builds.

If a Blueprint opens with its script missing, check that the Python file and binding configuration arrived with the asset. Use the Script menu to inspect or reconnect the binding.