class

FProjectLayout

Module
Core
Header
#include "Core/ProjectLayout.h"
Namespace
Mowo

Type aliases

AliasDescription
using FLegacyConfigConverter = bool (*)(const MDF::MdfDocument& legacy, FConfigIniFile& out)A legacy MDF config whose INI form is its own schema rather than the flattened Config tree (Redirects, Input, Chunks, ...): the owner of the file passes the converter that writes that schema. False keeps the legacy file where it is and returns its path, so the caller still reads it the old way.

Properties

TypeNameDescription
static constexpr const char*ContentCommitted — the project proper. Default "Content".
static constexpr const char*ConfigDefault "Config".
static constexpr const char*SourceDefault "Source".
static constexpr const char*PluginsDefault "Plugins".
static constexpr const char*SavedDisposable. Default "Saved".
static constexpr const char*IntermediateDefault "Intermediate".
static constexpr const char*EditorConfigPer-user editor state, under Saved/ because it is exactly as personal as a log or a screenshot. Relative to the Saved/ root. Default "Config/Editor".
static constexpr const char*CookedWhere a cook and a package land by default, relative to the project root. Both are rebuildable, but a person hands a package to someone, which is why they sit under Saved/ and not Intermediate/. A cook's per-asset transcodes (.mtex/.mmodel) are the Intermediate/ kind: no one ever opens them, they only feed the archive. Default "Saved/Cooked".
static constexpr const char*PackagedDefault "Saved/Packaged".
static constexpr const char*CookedAssetsDefault "Intermediate/CookedAssets".
static constexpr const char*ShaderCacheMaterial graph shaders the editor compiled on demand, one folder per engine shader stamp (FMaterialShaderCache), and the emitted sources and build tree the compile works in. Both are machine data the next compile reproduces; the cook compiles from Content/'s sidecars. Default "Intermediate/ShaderCache".
static constexpr const char*ShaderCompileDefault "Intermediate/ShaderCompile".
static constexpr const char*PsoCacheRecordingThe PSO cache has two homes: the per-developer recording under Saved/ and the committed ship input under Config/ that packaging reads. Only an explicit promote moves one into the other. Default "Saved/PsoCache/PsoCache.mdfb".
static constexpr const char*PsoCacheShipInputDefault "Config/PsoCache.mdfb".
static constexpr const char*OpenOrderRecordingThe order a play session first read archive keys (MowoGame --record-open-order), per user, and the committed copy the pak layout follows (mbt package --promote-open-order). Default "Saved/OpenOrder/OpenOrder.txt".
static constexpr const char*OpenOrderShipInputDefault "Config/OpenOrder.txt".
static constexpr const char*AutoScreenshotThe editor's last view of the project, written on a level save; the Project Launcher shows it on the project's card. Default "Saved/AutoScreenshot.png".
static constexpr const char*AssetRegistryIndexThe asset registry is two files with two lifetimes. The index — entries, hashes, mtimes, dependency edges — is what a walk over Content/ and the .mdfmeta sidecars produces, so it is Intermediate/ data: delete it and the next open rebuilds it. Redirects are the one part nothing on disk can reproduce (a renamed asset leaves no trace of its old path), so they are committed under Config/, in the same file the field and type redirects live in. The index is machine data nobody reads, so it is binary MDF; Redirects is the hand-editable INI of UE's [CoreRedirects] (FFieldRedirects), its MDF predecessor converted on the first open that may write. Default "Intermediate/AssetRegistry.mdfb".
static constexpr const char*LegacyAssetRegistryIndexDefault "Intermediate/AssetRegistry.mdf".
static constexpr const char*VisualScriptClassIndexWhich file declares which Visual Script class (FVisualScriptClassIndex): the editor registers a class on first use instead of parsing every one at open. Default "Intermediate/VisualScriptClassIndex.mdfb".
static constexpr const char*RedirectsDefault "Config/Redirects.ini".
static constexpr const char*LegacyRedirectsDefault "Config/Redirects.mdf".
static constexpr const char*RedirectsConfigFileDefault "Redirects.ini".
static constexpr const char*LegacyRedirectsConfigFileDefault "Redirects.mdf".
static constexpr const char*LegacyAssetRegistryWhere the whole registry, redirects included, sat before the split. Recognised so an existing project is adopted on its first open. Default "AssetRegistry.mdf".
static constexpr const char*LegacyUserDirRetired: the hidden per-user directory that predated Saved/Config/Editor. Still recognised so a project that has not been migrated yet is not walked, and so migration can find it. Default ".mowo".
static constexpr const char*ShadersDefault "Shaders".
static constexpr const char*ResourcesDefault "Resources".
static constexpr const char*ScenesDefault "Scenes".
static constexpr const char*EngineConfigFileConfig file names. Every one is PascalCase: the tree used to mix engine.mdf beside Redirects.mdf and Packaging.mdf, and on a case-sensitive filesystem a reader and a writer that disagreed about the case simply did not find each other's file. Relative to Config/ for the committed tier, to Saved/Config/Editor for the per-user one. A file read through the Config class is INI (ROADMAP §23 D7); ResolveConfigFile converts the legacy MDF one named beside it. Per-user state nobody edits by hand is binary MDF (.mdfb), its legacy text name renamed in place (the reader sniffs either encoding). A config with a schema of its own (Input, Redirects, Chunks) converts through its owner's converter — see the four-argument ResolveConfigFile. Default "Engine.ini".
static constexpr const char*PluginsConfigFileDefault "Plugins.ini".
static constexpr const char*InputConfigFileDefault "Input.ini".
static constexpr const char*PackagingConfigFileDefault "Packaging.ini".
static constexpr const char*AchievementsConfigFileThe game's achievements and stats (ids, names, hidden flag, the stat a progress achievement follows); staged with the package's Config/. Default "Achievements.ini".
static constexpr const char*OutputLogConfigFileDefault "OutputLog.mdfb".
static constexpr const char*ModesRecentConfigFileDefault "ModesRecent.mdfb".
static constexpr const char*ImportPrefsConfigFileDefault "ImportPrefs.mdfb".
static constexpr const char*EditorLayoutConfigFileDefault "EditorLayout.mdfb".
static constexpr const char*EditorLayoutsConfigFileDefault "EditorLayouts.mdfb".
static constexpr const char*PerfTrendsFileDefault "Trends.mdfb".
static constexpr const char*CryptoConfigFileThe project's content keys (UE's DefaultCrypto.ini): committed with the project and never staged into a package — the player gets the keys only inside its host executable. Not a layer FConfigHierarchy merges: one file, read by the editor's Crypto page and by mbt package. Default "DefaultCrypto.ini".
static constexpr const char*CryptoIniDefault "Crypto".
static constexpr const char*ProtectionConfigFileThe project's protection choices (editor Project Settings > Protection): committed with the project, read by the editor page and by mbt to decide watermark / integrity stamp / pack-code and which project sources to route through the obfuscation plugin. Never staged into a package (ProtectionIni is the layer base name the stager excludes). Default "DefaultProtection.ini".
static constexpr const char*ProtectionIniDefault "Protection".
static constexpr const char*LegacyEngineConfigFileThe names the files above had before; pass them as ResolveConfigFile's legacy so an older project is adopted on first touch. Removal date: 2027-04-19, together with the MDF-to-INI converters. Default "Engine.mdf".
static constexpr const char*LegacyPluginsConfigFileDefault "Plugins.mdf".
static constexpr const char*LegacyInputConfigFileDefault "Input.mdf".
static constexpr const char*OldestInputConfigFileDefault "input_bindings.mdf".
static constexpr const char*LegacyPackagingConfigFileDefault "Packaging.mdf".
static constexpr const char*LegacyOutputLogConfigFileDefault "OutputLog.mdf".
static constexpr const char*LegacyModesRecentConfigFileDefault "ModesRecent.mdf".
static constexpr const char*LegacyImportPrefsConfigFileDefault "ImportPrefs.mdf".
static constexpr const char*LegacyEditorLayoutConfigFileDefault "EditorLayout.mdf".
static constexpr const char*LegacyEditorLayoutsConfigFileDefault "EditorLayouts.mdf".
static constexpr const char*LegacyPerfTrendsFileDefault "Trends.mdf".
static constexpr const char*InputUserConfigFileThe player's own machine state under Saved/Config (or the per-user product dir): rebinds beside the gamepad slot table in one binary file. Default "InputUser.mdfb".
static constexpr const char*LegacyInputUserConfigFileDefault "InputUser.mdf".
static constexpr const char*GameUserSettingsConfigFileDefault "GameUserSettings.ini".
static constexpr const char*AchievementProgressFileThe player's own achievement and stat values beside their save games: the store the game reads when no platform is up, and what is pushed to the platform once it is. Default "AchievementProgress.ini".
static constexpr const char*LegacyGameUserSettingsConfigFileDefault "GameUserSettings.mdf".
static constexpr const char*EngineIniINI config base names (ROADMAP §23.4): FConfigHierarchy turns "Engine" into Engine/Config/BaseEngine.ini, Config/DefaultEngine.ini, Config/<Platform>/<Platform>Engine.ini and Saved/Config/<Platform>/Engine.ini, layered over Config/Engine.ini. Default "Engine".
static constexpr const char*GameIniDefault "Game".
static constexpr const char*InputIniDefault "Input".
static constexpr const char*EditorIniDefault "Editor".
static constexpr const char*ScalabilityIniDefault "Scalability".
static constexpr const char*DeviceProfilesIniDefault "DeviceProfiles".
static constexpr const char*GameUserSettingsIniDefault "GameUserSettings".
static constexpr const char*SavedConfigPer-user INI layer, relative to the project root. Default "Saved/Config".

Public functions

ReturnsNameDescription
std::filesystem::pathResolveConfigFileThe path canonical has inside dir, after bringing the file on disk to that exact name.
std::filesystem::pathResolveConfigFile
TArrayView<const char* const>TransientDirectoriesThe trees a project throws away, in the form a .gitignore wants them (no trailing slash — callers append one).
boolIsTransientDirectoryTrue for any directory a tree walk over the project should not enter: the disposable trees above, plus VCS metadata and the retired per-user directory.

Function details

ResolveConfigFile

C++
static std::filesystem::path ResolveConfigFile(const std::filesystem::path& dir, const char* canonical, std::initializer_list<const char*> legacy = {})

The path canonical has inside dir, after bringing the file on disk to that exact name. A file spelled any other way — a case variant, or one of the legacy names — is renamed in place, so a project written by an older engine is adopted on first touch rather than read under one name and written under another. Nothing is ever deleted: when the canonical file and a differently named legacy file both exist, the legacy one is left where it is. Returns the canonical path whether or not a file exists, so a writer can use it directly.

ResolveConfigFile

C++
static std::filesystem::path ResolveConfigFile(const std::filesystem::path& dir, const char* canonical, std::initializer_list<const char*> legacy, FLegacyConfigConverter converter)

TransientDirectories

C++
static TArrayView<const char* const> TransientDirectories()

The trees a project throws away, in the form a .gitignore wants them (no trailing slash — callers append one).

IsTransientDirectory

C++
static bool IsTransientDirectory(std::string_view name)

True for any directory a tree walk over the project should not enter: the disposable trees above, plus VCS metadata and the retired per-user directory.

Generated from Core/ProjectLayout.h via core.json · Nov 5, 2026Version 1.0.0