Skip to content

Documentation

Use UnrealPy to write gameplay in Python for Unreal Engine 5.8. Start in the Content Browser, give an actor some Python behavior, and try it in Play In Editor.

Start here

  1. Install UnrealPy from Fab.
  2. Create your first Python actor and run it in the editor.
  3. Choose your script editor and review project settings.

Before installing, check Compatibility. For a team checkout, see Join an existing UnrealPy project.

Why use UnrealPy?

  • Hot reload lets you save a Python change and try it in the editor while keeping your actors’ configured values.
  • Blueprint integration lets programmers expose reusable gameplay behavior and designers work with it in the Content Browser, Details panel, and Event Graph.
  • Python dependencies bring tools for math, data processing, and machine learning into an Unreal project. Choose packages that support your runtime and target platform.
  • Generated type stubs and tests give developers and coding agents a way to navigate Unreal’s API and check changes in focused Python modules.

Scripting

Classes, properties, functions, events, delegates, components, structs and enums, interfaces, spawning actors, subsystems, loading assets and soft references, math.

Blueprints and networking

Script a Blueprint, use Python from Blueprints, use Blueprints from Python, then replication and remote calls.

Workflow

See changes on save, set up code completion, debug in the editor, test your gameplay, or package your game.

Examples

Build an interactable door to connect Blueprint input and Python gameplay. Coin game is a short Play In Editor sample. Doom on UnrealPy is a complete demo project you can run with Freedoom Phase 1 and study for its Python gameplay, rendering, and networking.

Reference and help

The ue module, decorators, command line, the FAQ, and Support.