Unreal Engine Uplugin

Unreal Engine plugin configuration file

.uplugin

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your .uplugin and it validates in your browser — nothing is uploaded.

Validate a .uplugin → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`BuiltInInitialFeatureState`	`string`	Determine the initial feature state for a built-in plugin default: `"Active"` one of: `"Installed", "Registered", "Loaded", "Active"`
`CanContainContent`	`boolean`	Can this plugin contain content? default: `false`
`CanContainVerse`	`boolean`	Can this plugin contain Verse code? default: `false`
`ExplicitlyLoaded`	`boolean`	When true, this plugin's modules will not be loaded automatically nor will it's content be mounted automatically. default: `false`
`HasExplicitPlatforms`	`boolean`	When true, an empty SupportedTargetPlatforms is interpreted as 'no platforms' with the expectation that explicit platforms will be added in plugin platform extensions default: `false`
`Installed`	`boolean`	Signifies that the plugin was installed on top of the engine default: `false`
`IsBetaVersion`	`boolean`	Marks the plugin as beta in the UI default: `false`
`IsExperimentalVersion`	`boolean`	Marks the plugin as experimental in the UI default: `false`
`IsHidden`	`boolean`	For auto-generated plugins that should not be listed in the plugin browser for users to disable freely. default: `false`
`bIsPluginExtension`	`boolean`	If true, this plugin from a platform extension extending another plugin default: `false`
`RequiresBuildPlatform`	`boolean`	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 default: `false`
`Category`	`string`	The name of the category this plugin default: `"Other"`
`CreatedBy`	`string`	The company or individual who created this plugin.
`CreatedByURL`	`string`	—
`Description`	`string`	Description of the plugin
`DocsURL`	`string`	—
`EditorCustomVirtualPath`	`string`	Optional custom virtual path to display in editor to better organize.
`EnabledByDefault`	`boolean`	Whether this plugin should be enabled by default for all projects default: `false`
`EngineVersion`	`string`	Version of the engine that this plugin is compatible with
`FileVersion`required	`number`	Descriptor version number. default: `3`
`FriendlyName`	`string`	Friendly name of the plugin
`LocalizationTargets`	`array<object>`	List of all localization targets associated with this plugin
`MarketplaceURL`	`string`	Marketplace URL for this plugin.
`Modules`	`array`	List of all modules associated with this plugin
`ParentPluginName`	`string`	If specified, this is the real plugin that this one is just extending
`Plugins`	`array`	Plugins used by this plugin
`PostBuildSteps`	`object`	Post-build steps for each host platform
`PreBuildSteps`	`object`	Pre-build steps for each host platform
`SupportedPrograms`	`array<string>`	List of programs that are supported by this plugin.
`SupportedTargetPlatforms`	`array<string>`	Controls a subset of platforms that can use this plugin, and which ones will stage the `.uplugin` file and content files.
`SupportURL`	`string`	Support URL/email for this plugin.
`Version`	`number`	Version number for the plugin. default: `1`
`VersionName`	`string`	Name of the version for this plugin. default: `"1.0"`

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
60 properties, 100% carrying a description, max nesting depth 6.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$comment`	JSON Schema Core, draft 2020-12	§8.3 — Comments With "$comment"
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$ref`	JSON Schema Core, draft 2020-12	§8.2.3.1 — Direct References with "$ref"
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`format`	JSON Schema Validation, draft 2020-12	§7 — Vocabularies for Semantic Content With "format"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`pattern`	JSON Schema Validation, draft 2020-12	§6.3.3 — "pattern"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`required`	JSON Schema Validation, draft 2020-12	§6.5.3 — "required"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"
`uniqueItems`	JSON Schema Validation, draft 2020-12	§6.4.3 — "uniqueItems"
`format: "uri"`	RFC 3986 (STD 66)	§3 — Syntax Components

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas