alt
Prefixed: Getting Started

Prefixed is an asset naming enforcer that can be used to keep your projects neat and organized. To get started, follow these steps.

Enable Plugin

The first thing we need to do is make sure that we have enabled the Prefixed plugin for our project. Open up the Editor, find the menu in the top left corner, and navigate to Edit->Plugins. You can find Prefixed in the Project->Editor category. Click the checkbox to enable the plugin and restart the Editor.

The plugin is enabled for this project

Install Naming Rules

Next, we need to install our asset naming rules. Naming rules are contained in a file named AssetNamingRules.json. This file can be placed in:

  • The {EngineVersion}/Engine/Config directory (default for all projects using this engine version)
  • The {Project}/Config directory (overrides engine version default)

A minimal rule set is packed into the Prefixed plugin's Resources folder. However, for a more comprehensive set of rules, check out the Unrealistic Style Guide.

Restart the Editor.

Placement of engine-wide rules

Run the Linter

We are now ready to lint. Simply select the folders or assets that you would like to lint, right click, and click the Run Linter option. A dialog will pop up which will allow you to see the proposed rename, make any corrections, and apply the changes.

The linting dialog

If you get an error when selecting the Run Linter command, it's possible that your asset naming rules were loaded incorrectly. Check out this article to learn more about proper rule formatting and how to add your own rules.

And voila - you now have consistently named assets! Happy linting!


Copyright 2020 Mowgl33.