IDE File Templates

Overview

Unreal Engine provides a number of file templates that are used in Visual Studio or Rider to facilitate the creation of Unreal classes. MetaForge extends these templates by adding new ones that can be installed directly into the Unreal folder, allowing the creation of MetaForge-specific types from the IDE.

MetaForge provides two fixed file templates:

  1. Model Object Template: For creating new data model classes that integrate with MetaForge.

  2. Manager Template: For creating new manager classes that handle collections of model objects.

These template files are installed to UE_INSTALL_PATH\Engine\Content\Editor\Templates.

After copying the files, make sure to close and relaunch your IDE. After that, the templates might need to be selected to be part of the 'Add New' menu in your IDE.

Automatic Installation

Open the Metaforge Configuration editor and make sure the checkbox for 'Install IDE File Templates' is checked. This will automatically copy the files to your Unreal engine folder.

File Templates

JetBrains Rider Manual Installation

Steps to Install File Templates in JetBrains Rider:

  1. Copy Templates to the Unreal Installation Folder:

    • Copy the MetaForge template files to UE_INSTALL_PATH\Engine\Content\Editor\Templates.

  2. Restart Rider:

    • Close and relaunch Rider to load the new templates.

  3. Verify Template Availability:

    • When you create a new file, the MetaForge templates should now be available under the 'Unreal Classes' section of the 'Add New' menu.

Visual Studio Manual Installation

Steps to Install File Templates in Visual Studio:

  1. Copy Templates to the Unreal Installation Folder:

    • Copy the MetaForge template files to UE_INSTALL_PATH\Engine\Content\Editor\Templates.

  2. Restart Visual Studio:

    • Close and relaunch Visual Studio to load the new templates.

  3. Verify Template Availability:

    • The "Add New" menu in Visual Studio should be updated to show these templates once they are properly installed, typically in the Unreal Engine section of the "Add New Item" or "Add Class" wizards.

Summary

Installing file templates for Unreal C++ IDEs can significantly speed up your workflow, ensuring that your new files are consistent and adhere to best practices. Whether you are using JetBrains Rider or Visual Studio, adding these templates will allow you to focus more on your project's logic and less on repetitive boilerplate setup.

Last updated