Creating a new Plugin

This tutorial will guide you through the steps necessary to create a plugin using the plugin wizard.

Also see my video tutorial series on Youtube

Preparation

First install the Plugin SDK with wizard to the CryEngine root directory you want to use the Plugin from (e.g. C:\cryengine3_3.4.0). Please note this path as sample for the next steps, to use the correct paths is extremely important for the wizard to work. The installer will warn you when you select the wrong path but the wizard will not.

Things to know beforehand

• Choose a unique name for your plugin, each plugin must have its own name.

• Plugins should use their own plugin subdirectory (e.g. C:\cryengine3_3.4.0\Bin32\Plugins\Name\Plugin_Name.dll) to handle plugins with additional dependencies.

• Plugin DLL files can not be in pak files.

Creating the Plugin

• 

1. Select the Plugin SDK - Plugin Wizard
2. Enter plugin name with 'Plugin_' Prefix (you can rename the directory later again, if you need to)
3. Select the CryEngine SDK Code directory where Plugin SDK was installed (important!)
4. Uncheck "Create directory for solution" (important!)
5. Click OK
   
   

   ---

   
   
6. Not relevant anymore
7. Select plugin category/type
8. Enter your name (project will be create by default with BSD license)
9. Click Finish
   
   

   ---

   
   
10. Optional: Implement your plugin interface (sample: http://github.com/hendrikp/Plugin_Crash/blob/master/inc/IPluginCrash.h)
11. Optional: Generally search in the open files for TODO and check if you need the stuff they say
12. Optional: If you want to have flownodes drag the flownode file inside the project or create a new one (they will then be automatically registered inside CryEngine)

Creating a Plugin Installer

• The wizard automatically generates an NSIS installer that fits most Plugins
• If you have more files then the 2 Plugin DLLs then you need to extend the installer
• To build the installer you have to install NSIS