Skip to content

UnrealPluginCreator is a command-line tool that scaffolds Unreal Engine 5+ plugins quickly and efficiently.

License

Notifications You must be signed in to change notification settings

Ericdowney/UnrealPluginCreator

Repository files navigation

UnrealPluginCreator

Ko-Fi Bluesky Mastodon Unreal Engine

UnrealPluginCreator is a command-line tool that scaffolds Unreal Engine 5+ plugins quickly and efficiently. It creates a fully structured plugin including runtime, editor, and test modules, sets up a Slate-based editor tab, and replaces template placeholders with your plugin's details. Perfect for starting new plugin projects without repetitive boilerplate setup.


Features

  • Generates a complete Unreal Engine plugin template.
  • Includes:
    • Runtime module
    • Editor module with Slate UI tab
    • Automated test module
    • Wizard-style interactive input or --defaults mode for minimal input.
    • Cross-platform support (macOS bash script and Windows batch script).

Installation

Clone this repository:

git clone https://github.com/<your-username>/UnrealPluginCreator.git
cd UnrealPluginCreator

Usage

macOS / Linux

./UnrealPluginCreator.sh --output-dir <path/to/directory>

Windows

UnrealPluginCreator.bat --output-dir <path/to/directory>

Options

Option Description
--output-dir <dir> Required. Directory where the plugin will be created.
--help Show help message.
--defaults Generate plugin with minimal input (PLUGIN_NAME and PLUGIN_AUTHOR).

Interactive Wizard

When you run the tool without --defaults, you’ll be prompted for:

  • Plugin Name (required)
  • Plugin Author (required)
  • Plugin Description
  • Plugin Category
  • Plugin Author URL
  • Plugin Docs URL
  • Plugin Marketplace URL
  • Plugin Support URL

Press Enter to leave any optional field blank.

Contributing

Contributions are welcome! Feel free to:

  • Submit bug reports or feature requests.
  • Fork the repo and submit pull requests.
  • Improve template files, add new modules, or enhance cross-platform compatibility.

About

UnrealPluginCreator is a command-line tool that scaffolds Unreal Engine 5+ plugins quickly and efficiently.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project