Unreal Python Recipe Book

This project explores the use of Python to interact with, manage, and extend aspects of Unreal Engine 5

## Overview This project is meant to supplement the official Epic documentation on Python and is **unaffiliated** with Epic or any company. This project is written and maintained by Brian Kortbus. 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. We will also try to update this whenever a new version of Unreal is released, although it may not be available right away. Please feel free to learn from and reference this project as you explore Python in Unreal! There are two sections of this Project: 1) [Documentation](https://github.com/bralkor/unreal_python_recipe_book/raw/5.2/documentation) covering various topics of using Python in Unreal 2) [An Unreal Plugin](https://github.com/bralkor/unreal_python_recipe_book/raw/5.2/unreal_plugin/PythonRecipeBook) containing working code and demo material which may be placed in any `UE5.2` project
### The Documentation

(0) [Dev Conveniences](https://github.com/bralkor/unreal_python_recipe_book/blob/5.2/documentation/00_conveniences.md)	Some small conveniences I've found and make use of in my own code.
(1) [Startup and Shutdown](https://github.com/bralkor/unreal_python_recipe_book/blob/5.2/documentation/01_startup_and_shutdown.md)	How to run code at various points of Unreal's startup and shutdown sequences.
(2) [Blueprint Function Libraries](https://github.com/bralkor/unreal_python_recipe_book/blob/5.2/documentation/02_blueprint_function_libraries.md)	How to create Blueprint Graph function nodes in Python. This allows us far greater freedom and possibilities to call Python logic from the BP Graph. Examples with screenshots are provided for each individual option.
(3) [Using Assets in Python](https://github.com/bralkor/unreal_python_recipe_book/blob/5.2/documentation/03_using_assets_in_python.md)	How to interact with Content Browser assets in Python. This covers instancing, properties, and calling Blueprint functions.
(4) [Extending Menus](https://github.com/bralkor/unreal_python_recipe_book/blob/5.2/documentation/04_extending_menus.md)	How to create and insert new menus in the Editor. This covers how to find menus, create drop down menus, and two styles of adding menu buttons.
(5) [Actor and Component Interactions](https://github.com/bralkor/unreal_python_recipe_book/blob/5.2/documentation/05_actors_and_components.md)	How to interact with actors and components. This covers walking actor and component hierarchies as well as some basic interactions, such as determining the source asset of an actor.
(6) [Using Asset Metadata](https://github.com/bralkor/unreal_python_recipe_book/blob/5.2/documentation/06_using_asset_metadata.md)	How to use and interact with Content Browser Asset metadata. This covers getting, setting, and searching for assets via metadata.
(7) [Editor Utility Widgets (EUWs) and Python](https://github.com/bralkor/unreal_python_recipe_book/blob/5.2/documentation/07_editor_utility_widgets.md)	How to manage EUWs with Python. This covers opening and closing EUWs, managing user prefs, and a danger when using EUWs with Python.
(8) [An Editor Utility Widget Example](https://github.com/bralkor/unreal_python_recipe_book/blob/5.2/documentation/08_editor_widget_example.md)	An example Editor Tool which makes use of Python. This tool displays arbitrary assets and allows for filtering based on their metadata values.
(9) [Making Python Blueprint Functions Safer](https://github.com/bralkor/unreal_python_recipe_book/blob/5.2/documentation/09_making_python_BP_functions_safer.md)	Addressing the concerns mentioned on the [Blueprint Function Libraries](https://github.com/bralkor/unreal_python_recipe_book/blob/5.2/documentation/02_blueprint_function_libraries.md) and [EUWs and Python](https://github.com/bralkor/unreal_python_recipe_book/blob/5.2/documentation/07_editor_utility_widgets.md) pages, this covers how to make Python-based Blueprint Functions safer to use.
(10) [Handling Engine Version Transitions](https://github.com/bralkor/unreal_python_recipe_book/blob/5.2/documentation/10_engine_version_transitions.md)	Methods to handle supporting or transitioning between Unreal versions. This covers a utility class for having version-specific Python logic as well as a method to see what classes & properties have been added to the Unreal Python API

### The Unreal Plugin

### Special Thanks

### Contact

This project is written and maintained by Brian Kortbus as a personal project. If you have any questions, suggestions, or Unreal code snippets you wish to share please feel free to message me on [LinkedIn](https://www.linkedin.com/in/bkortbus/).
### Updates

- Added [documentation](https://github.com/bralkor/unreal_python_recipe_book/blob/5.2/documentation/10_engine_version_transitions.md) and [a new Python module](https://github.com/bralkor/unreal_python_recipe_book/raw/5.2/unreal_plugin/PythonRecipeBook/Content/Python/demo/engine.py) on `Handling Engine Version Transitions`

- built plugin for UE5.2 and updated doc links - no notable API changes