Skip to content

Unreal python plugin template

A Unreal plugin template for pure Python plugins
https://github.com/hannesdelbeke/unreal-python-plugin-template

Features

  • this template is ready to plug & play, so just replace the code with your own.
  • the repo includes code for a demo qt widget
  • the included Unreal dependencies installer auto installs dependencies on Unreal startup from requirements.txt
  • By default, it installs unreal-qt, which installs PySide6, because the demo widget uses it.
  • adds the menu item tools/myPlugin to Unreal’s menu to launch the widget.
  • easy installation:
    1. Place the plugin in Unreal’s Plugins folder
    2. Enable the plugin in Unreal
      1. open Edit > Plugins
      2. search for MyPlugin (capital sensitive) and enable it
    3. Restart Unreal

TODO

  • demo how to add a section in unreal’s menu
  • demo how to add an icon to the menu entry
  • test on other OS
  • Installing PySide to the project triggers import warnings for the jsons
    • I found a manual editor fix
    • Can this be automated? e.g. on startup? Atm every user will run into this which is annoying.
  • maybe we can make an installer: (plugget Unreal already kinda does this)
    • auto adds the plugin to the most recent unreal project
    • auto enables plugin in project
    • now user only has to run the installer, and restart Unreal

Reference