Unreal Engine Uplugin
Unreal Engine plugin configuration file
| Type | object |
|---|---|
| File match |
.uplugin
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/unreal-engine-uplugin/latest.json |
| Source | https://www.schemastore.org/uplugin.json |
Validate with Lintel
npx @lintel/lintel checkDescriptor for plugins. Contains all the information contained within a .uplugin file.
Properties
Descriptor version number.
Determine the initial feature state for a built-in plugin
Can this plugin contain content?
Can this plugin contain Verse code?
When true, this plugin's modules will not be loaded automatically nor will it's content be mounted automatically.
When true, an empty SupportedTargetPlatforms is interpreted as 'no platforms' with the expectation that explicit platforms will be added in plugin platform extensions
Signifies that the plugin was installed on top of the engine
Marks the plugin as beta in the UI
Marks the plugin as experimental in the UI
For auto-generated plugins that should not be listed in the plugin browser for users to disable freely.
If true, this plugin from a platform extension extending another plugin
For plugins that are under a platform folder (eg. /PS4/), determines whether compiling the plugin requires the build platform and/or SDK to be available
The name of the category this plugin
The company or individual who created this plugin.
Description of the plugin
Optional custom virtual path to display in editor to better organize.
Whether this plugin should be enabled by default for all projects
Version of the engine that this plugin is compatible with
Friendly name of the plugin
List of all localization targets associated with this plugin
Marketplace URL for this plugin.
If specified, this is the real plugin that this one is just extending
Post-build steps for each host platform
Pre-build steps for each host platform
List of programs that are supported by this plugin.
Controls a subset of platforms that can use this plugin, and which ones will stage the .uplugin file and content files.
Support URL/email for this plugin.
Version number for the plugin.
Name of the version for this plugin.
Definitions
Available build configurations. Mirrored from UnrealTargetConfiguration.
Enumerates build target types.
Description of a loadable module.
List of additional dependencies for building this module.
When true, an empty PlatformAllowList is interpreted as 'no platforms' with the expectation that explicit platforms will be added in plugin extensions
When should the module be loaded during the startup sequence? This is sort of an advanced setting.
Name of this module
List of allowed platforms
List of disallowed platforms
List of allowed programs
List of disallowed programs
List of allowed target configurations
List of disallowed target configurations
Usage type of module
Descriptor for a plugin reference.
Whether it should be enabled by default
Name of the plugin
When true, empty SupportedTargetPlatforms and PlatformAllowList are interpreted as no platforms with the expectation that explicit platforms will be added in plugin platform extensions
Whether this plugin is optional, and the game should silently ignore it not being present
Description of the plugin for users that do not have it installed.
URL for this plugin on the marketplace, if the user doesn't have it installed.
List of allowed platforms
List of disallowed platforms
List of allowed target configurations
List of disallowed target configurations