Plugins, How To Package Custom Plugins With Your Game

From Epic Wiki
Jump to: navigation, search

Overview

Author: Rama (talk)

Hi there!

After upgrading my Victory Plugin to 4.11 I realized the rules have changed regarding how to package a custom plugin with any project.

Here are the rules as I now understand them!

1. Must Be Engine Plugin

You can develop your plugin at the project level, but for people without C++ access to be able to package it, you must move it to the Engine/Plugins directory for the appropriate engine version.

Make sure you put runtime plugins in Engine/Plugins/Runtime

2. Must Pre-Compile For All Destination Platforms

Via the .sln file in Visual Studio you must do a full rebuild for all destination platforms that you want to support, generating the appropriate files under Binaries for your plugin.

So if you want to package for Development (Game) x64 you must compile in Visual Studio, prior to packaging in the Editor.

3. Must Be Listed as Installed in .uplugin

Open your .uplugin in a text editor and make sure that Installed is set to be true!

 "Installed": true,	

Your plugin will not package unless this is set to true! -Rama

Troubleshooting for Buyers of Plugins

If you bought a plugin that is not packaging, you can do Step 1 and Step 3 yourself!

Make sure your plugin is moved to the engine folder as mentioned above, and make sure that Installed is set to true in the .uplugin.

If the plugin provider did not precompile the .lib files you should ask them to do so.

Conclusion

I hope you found this wiki very helpful for your plugin development and packaging process!

Enjoy!

Rama (talk)