Unreal Engine Uproject

Unreal Engine project configuration file

Type object
File match .uproject
Schema URL https://catalog.lintel.tools/schemas/schemastore/unreal-engine-uproject/latest.json
Source https://www.schemastore.org/uproject.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Descriptor for projects. Contains all the information contained within a .uproject file.

Properties

EngineAssociation string required

The engine to open this project with. Either . version (4.27, 5.4, etc), unique Engine identifier, blank for directory-based discovery, or relative path.

pattern=(^([0-9]+)\.([0-9]+)$)|(^\{[A-F0-9]{8}(-[A-F0-9]{4}){3}-[A-F0-9]{12}\}$)|^$|[\\/]
FileVersion number required

Descriptor version number. See EProjectDescriptorVersion::Type.

Default: 3
AdditionalPluginDirectories string[]

List of additional directoreis to scan for plugins

Default:
[]
DisableEnginePluginsByDefault boolean

Indicates that enabled by default engine plugins should not be enabled unless explicitly enabled by the project or target files.

Default: false
IsEnterpriseProject boolean

Indicates if this project is an Enterprise project.

Default: false
Category string

Category to show under the project browser.

Description string

Description to show in the project browser.

EpicSampleNameHash number

A hash that is used to determine if the project was forked from a sample.

Modules ModuleDescriptor[]

List of all modules associated with this project.

uniqueItems=true
Plugins PluginReferenceDescriptor[]

List of plugins for this project (may be enabled/disabled).

uniqueItems=true
PostBuildSteps object

Custom steps to execute after building targets in this project.

PreBuildSteps object

Custom steps to execute before building targets in this project.

TargetPlatforms string[]

Array of platforms that this project is targeting.

uniqueItems=true

Definitions

BuildConfiguration string

Available build configurations. Mirrored from UnrealTargetConfiguration.

BuildTargetType string

Enumerates build target types.

ModuleDescriptor object

Description of a loadable module.

AdditionalDependencies string[]

List of additional dependencies for building this module.

HasExplicitPlatforms boolean

When true, an empty PlatformAllowList is interpreted as no platforms with the expectation that explicit platforms will be added in plugin extensions.

Default: false
LoadingPhase string

When should the module be loaded during the startup sequence? This is sort of an advanced setting.

Values: "EarliestPossible" "PostConfigInit" "PostSplashScreen" "PreEarlyLoadingScreen" "PreLoadingScreen" "PreDefault" "Default" "PostDefault" "PostEngineInit" "None" "Max"
Name string

Name of this module.

PlatformAllowList string[]

List of allowed platforms.

uniqueItems=true
PlatformDenyList string[]

List of disallowed platforms.

uniqueItems=true
ProgramAllowList string[]

List of allowed programs.

uniqueItems=true
ProgramDenyList string[]

List of disallowed programs.

uniqueItems=true
TargetAllowList BuildTargetType[]

List of allowed targets.

uniqueItems=true
TargetConfigurationAllowList BuildConfiguration[]

List of allowed target configurations.

uniqueItems=true
TargetConfigurationDenyList BuildConfiguration[]

List of disallowed target configurations.

uniqueItems=true
TargetDenyList BuildTargetType[]

List of disallowed targets.

uniqueItems=true
Type string

Usage type of module.

Values: "Runtime" "RuntimeNoCommandlet" "RuntimeAndProgram" "CookedOnly" "UncookedOnly" "Developer" "DeveloperTool" "Editor" "EditorNoCommandlet" "EditorAndProgram" "Program" "ServerOnly" "ClientOnly" "ClientOnlyNoCommandlet" "Max"
PluginReferenceDescriptor object

Descriptor for a plugin reference.

Enabled boolean required

Whether it should be enabled by default.

Default: true
Name string required

Name of the plugin.

HasExplicitPlatforms boolean

When true, empty SupportedTargetPlatforms and PlatformAllowList are interpreted as no platforms with the expectation that explicit platforms will be added in plugin platform extensions.

Default: false
Optional boolean

Whether this plugin is optional, and the game should silently ignore it not being present.

Default: false
Description string

Description of the plugin for users that do not have it installed.

MarketplaceURL string

URL for this plugin on the marketplace, if the user doesn't have it installed.

PlatformAllowList string[]

List of allowed platforms.

uniqueItems=true
PlatformDenyList string[]

List of disallowed platforms.

uniqueItems=true
TargetAllowList BuildTargetType[]

List of allowed targets.

uniqueItems=true
TargetConfigurationAllowList BuildConfiguration[]

List of allowed target configurations.

uniqueItems=true
TargetConfigurationDenyList BuildConfiguration[]

List of disallowed target configurations.

uniqueItems=true
TargetDenyList BuildTargetType[]

List of disallowed targets.

uniqueItems=true