https://github.com/ynput/ayon-unreal-plugin
Unreal Engine plugin for AYON integration
https://github.com/ynput/ayon-unreal-plugin
Last synced: about 2 months ago
JSON representation
Unreal Engine plugin for AYON integration
- Host: GitHub
- URL: https://github.com/ynput/ayon-unreal-plugin
- Owner: ynput
- License: apache-2.0
- Created: 2023-05-16T14:41:40.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2026-01-06T13:24:52.000Z (5 months ago)
- Last Synced: 2026-04-13T07:49:48.662Z (about 2 months ago)
- Language: C++
- Size: 213 KB
- Stars: 7
- Watchers: 5
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
AYON Unreal Integration Plugin
==============================
This repository holds the code for AYON Unreal integration plugin for various UE versions.
Documentation of how to use AYON integration inside Unreal is [here](https://help.ayon.app/articles/0086198-about-unreal-addon).
Getting started
---------------
This plugin meant to be used directly by AYON (OpenPype) either through FAB / Epic Marketplace or manually, when
new Unreal project is started via AYON.
You can find built plugins for various Unreal Engine versions on [FAB](https://fab.com/s/cfd5e8fdd0a0)
For every supported Unreal version there is one plugin (**Ayon**) and one project (**CommandletProject**).
How it works
------------
When you launch Unreal Editor on any task through AYON, following things will happen:
- Environment is prepared.
- We check for presence of AYON plugin in Unreal Engine.
- If the plugin isn't found, AYON will try to build it. For this step you
will need configured build environment. Please follow [guides on Unreal documentation](https://docs.unrealengine.com/5.0/en-US/setting-up-your-development-environment-for-cplusplus-in-unreal-engine/) for more information.
- **CommandletProject** is blank project that is used to bootstrap project
creation by Unreal Editor itself.
- Unreal Editor is launched on new generated project.
Integration plugin is providing UI access to AYON functionality. Most of
the code is used to mark and define data structures used by AYON inside
Editor itself, rest of the functionality is implemented in Python inside
AYON codebase.
Manual build
------------
You can used provided Windows batch scripts to build plugin manually.
In order to successfully build the plugin, make sure that the path to the `UnrealBuildTool.exe` is specified correctly.
After the UBT path specify for which platform it will be compiled. in the `-Project` parameter, specify the path to the `CommandletProject.uproject` file. Next the build type has to be specified (*DebugGame*, *Development*, *Package*, etc.) and then the `-TargetType` (*Editor*, *Runtime*, etc.)
`BuildPlugin_[Ver].bat` runs the building process in the background. If you want to show the progress inside the command prompt, use the `BuildPlugin_[Ver]_Window.bat` file.
Related links
-------------
- **AYON Unreal Addon** repository: [https://github.com/ynput/ayon-unreal](https://github.com/ynput/ayon-unreal)
- **Unreal Engine**: [https://www.unrealengine.com/](https://www.unrealengine.com/)
- **AYON** help: [https://help.ayon.app](https://help.ayon.app)
- **AYON Docker** repository: [https://github.com/ynput/ayon-docker](https://github.com/ynput/ayon-docker)
- [Development Setup guides for Unreal](https://docs.unrealengine.com/5.0/en-US/setting-up-your-development-environment-for-cplusplus-in-unreal-engine/)