# About

This project explores the use of Python in Unreal Engine 5, helping to showcase what's possible with Python in Unreal as well as how to use it.

## Overview

This project is meant to supplement the official [Epic documentation on Python](https://dev.epicgames.com/documentation/en-us/unreal-engine/python-api) and is **unaffiliated** with Epic or any other company. This project is written and maintained by [Brian Kortbus](https://www.linkedin.com/in/bkortbus/). This project is meant to provide examples of how Unreal's systems can be used via Python and explore what's possible. This project is considered incomplete, new pages and revisions will be added as time allows.

I mostly used Unreal Engine 5.2 and 5.3 for this project, although most code is relevant in newer versions as Epic seldom removes features. If a feature is specific to a newer version of Unreal I'll make great effort to call that out.

## Intended Audience

This project is intended for readers who are already reasonably confident and comfortable in both Python and Unreal. The focus of this project is to show how the Unreal Python API can be used.

## Sample Plugin + Original Documentation

A sample UE Plugin is available on my Github at:&#x20;

{% @github-files/github-code-block url="<https://github.com/bralkor/unreal_python_recipe_book>" %}

This Github Project contains a Plugin with examples of the code shown throughout this Documentation as well as the original version of the Recipe Book documentation.

## About the Author

Howdy! My name is Brian Kortbus, I am a developer with a professional background in both Animated Film as well as Video Games. I've been pretty excited about the exploration and use of Unreal for Film in recent years, both in seeing how its use has evolved and experiencing firsthand how much more capable Unreal has become for non-c++ developers since I transitioned from video games to film. I hope this project helps others in exploring what can be done wiht Python in Unreal!


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://bkortbus.gitbook.io/unreal-python-recipe-book/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
