Getting Started

This page covers some helpful tips for getting started with the provided documentation

Epic Docs

If you haven't already, I highly recommend looking through Epic's provided documentation on Scripting the Unreal Editor using Python:

Scripting the Unreal Editor Using Python | Unreal Engine 5.5 Documentation | Epic Developer CommunityEpic Games Developer

They also provide a Python API Doc online with versions specific to each UE Version, this is my #1 resource when developing tools in Unreal:

Unreal Python API Documentation — Unreal Python 5.3 (Experimental) documentation

---

Where to Start

Topics are organized in the Table of Contents to the left. Topics are largely self contained, however I would recommend the following two sections as a starting point:

Dev Conveniences

The Dev Conveniences Topic covers some of the ways I use Python in Unreal:

Dev Conveniences

In other parts of this documentation you might see lines that look like this:

from systems import AssetEditorSubsystem

This is covered in the Conveniences Modules section, I initialize my subsystems in one module and import them elsewhere as needed to reduce repetition, I'll try my best to avoid them in the code snippets but apologies if some slip through!

Assets

The Assets Topic covers ways to use and interact with Content Browser Assets and their instances. This is a core area of scripting in Unreal and it's definitely worth familiarizing yourself with that area first:

Assets