/unreal-python-plugin-template

a unreal plugin template for pure python plugins

Primary LanguagePython

Unreal Python plugin template

A minimalism template for pure Python plugins in Unreal.
Example repos using this template:

Content

📂 MyPlugin
├── 📂 Content
│   └── 📂 Python
│       └── 📄 init_unreal.py
├── 📂 Resources
│   └── 🖼️ icon128.png
└── 📄 MyPlugin.uplugin
📄 .gitignore
📄 README.md
📄 requirements.txt

Info

  • MyPlugin rename the folder to your plugin name. Unreal's naming convention uses PascalCase.
  • MyPlugin.uplugin Rename this file to your plugin name, and open it with a text editor & edit the content.
  • .gitignore is setup to prevent unneeded python files from being commit to your git-repo.
  • requirements.txt Add your pip/pypi dependencies to this file, delete it if not used.
  • README.md: include an image & description, so people see what's your plugin about.
  • Python This folder is added to the PYTHONPATH, put the modules you want to import in here

Installation

Manual install

  1. save the plugin in your Unreal plugins folder
  2. pip install the Python dependencies from requirements.txt to Unreal's site packages folder
    (This can be too technical for some people)
  3. enable the plugin in Unreal, and restart Unreal

(OPTIONAL) Add Plugget install support

To support 1-click install & automatically install all dependencies in the requirements.txt file, you can add plugget support. It's a bit more work for you, the developer. But it removes the technical steps for the end user.

  1. Upload your plugin to a repo. (example repo)
  2. Create a plugget manifest (sample manifest) that points to your repo,
  3. Make a PR in plugget-pkgs to merge it in the public Plugget database.
  4. Add the plugget-install instructions to your README:
Installation with plugget automatically installs all dependencies.
1. Install the [plugget Qt Unreal plugin](https://github.com/plugget/plugget-unreal-plugin)
2. Install the package:
   - go to the menu `Edit > Plugget Packages` to open the package manager
   - search & install `unreal-script-editor` <=========== EDIT THIS TEXT ⚠️
example of a more advanced plugin made from this template, and installable through plugget

Community