Struct Ue4Game 

pub struct Ue4Game { /* private fields */ }

Data-driven UE4 game plugin.

UE4 titles share a near-identical layout: a project folder under the install root (SB/, Palworld/, etc.) that contains Content/Paks/ for pak files and Binaries/Win64/ for the shipping executable and proxy DLLs. Mods drop into Content/Paks/~mods/ (the tilde forces mount order after base paks).

A new UE4 game needs only a new const instance; the trait impl is shared.

Implementations

impl Ue4Game

pub const fn new( game_id: &'static str, display_name: &'static str, steam_app_id: &'static str, project_name: &'static str, nexus_domain: Option<&'static str>, ) -> Self

Construct a UE4 game definition; save-profile support defaults off (enable it via Ue4Game::with_save_profiles).

pub const fn with_save_profiles(self, enabled: bool) -> Self

Opt this UE4 game into modde’s per-profile save layer.

This is a const builder so game definitions can stay data-only while avoiding engine-wide assumptions about save-file layout.

pub fn paks_root(&self, install: &Path) -> PathBuf

<install>/<ProjectName>/Content/Paks

pub fn project_name(&self) -> &'static str

The UE4 project short name (the folder under the install root).

Trait Implementations

impl GamePlugin for Ue4Game

fn mod_directory(&self, install: &Path) -> PathBuf

Deploy target: <install>/<ProjectName>/Content/Paks/~mods.

The tilde prefix forces UE4’s pak mounter to load these after the shipping paks so mods can override base content.

fn resolve_deploy_target(&self, id: &str, _install: &Path) -> Option<PathBuf>

Resolve the per-user config dir under the Proton prefix: <steam_root>/compatdata/<APP_ID>/pfx/drive_c/users/steamuser/ AppData/Local/<Project>/Saved/Config/Windows/.

Returns None if the prefix doesn’t exist yet — the caller is expected to surface that to the user (typically: launch the game once so Proton creates the prefix).

fn game_id(&self) -> &str

Unique game identifier (e.g. “skyrim-se”).

fn display_name(&self) -> &str

Human-readable display name.

fn save_directory(&self) -> Option<PathBuf>

Return the save directory for this game, if known.

fn supports_save_profiles(&self) -> bool

Whether this game participates in modde’s per-profile save layer.

fn deploy_targets(&self) -> &'static [DeployTarget]

Alternate deployment roots this game exposes to the installer (e.g. user-config dirs for INI tweak packs). Default: none, in which case the installer only ever stages into the game install dir. The order is significant: when the analyzer needs to pick a default target for a given DeployTargetKind it takes the first one of that kind.

fn executable_dir(&self, install: &Path) -> PathBuf

Return the directory containing the game executable, relative to the install root. Used to locate proxy DLLs that need Wine overrides.

fn wine_dll_overrides(&self, game_dir: &Path) -> SmallVec<[String; 4]>

Scan the game directory for proxy/hook DLLs that need Wine n,b overrides.

fn wine_dll_overrides_from_staging( &self, staging: &Path, ) -> SmallVec<[String; 4]>

Scan the staging directory for proxy DLLs that mods deploy. This catches DLLs that may have been deleted by other tools (e.g. fgmod) from the game directory but are still needed.

fn classify_mod(&self, mod_dir: &Path) -> ModSafety

Classify whether a mod is save-breaking based on its installed content.

fn classify_extension(&self, ext: &str) -> ContentCategory

Classify a file extension into a content category.

fn archive_extensions(&self) -> &[&str]

fn steam_app_id_u32(&self) -> Option<u32>

fn nexus_game_domain(&self) -> Option<&str>

fn analyze_mod_archive(&self, extracted_dir: &Path) -> Option<InstallMethod>

Claim an extracted archive as a game-specific install method.

fn detect_install(&self) -> Option<PathBuf>

Attempt to detect the game’s install location. Default: delegates to detection::find_game_install(self.game_id()).

fn mod_root(&self, install: &Path) -> Result<PathBuf>

Resolve the actual deployment root for enabled mods.

fn deploy(&self, staging: &Path, target: &Path) -> Result<()>

Deploy staged mods into the game’s mod directory. Default: recursive symlink farm via modde_core::fs::deploy_symlinks.

fn deploy_to_install(&self, staging: &Path, install: &Path) -> Result<()>

Deploy staged mods using the game install root as context.

fn post_deploy(&self, _install: &Path) -> Result<()>

Run any post-deployment steps (e.g. REDmod deploy).

fn ini_file_names(&self) -> &[&str]

fn has_plugin_system(&self) -> bool

fn plugins_txt_folder(&self) -> Option<&str>

fn nexus_game_id_u32(&self) -> Option<u32>

Numeric Nexus game ID. Required by the GraphQL v2 API for browse/search queries (which take gameId: Int, not a domain string). Games that only speak REST can leave this None.

fn recognizes_bare_layout(&self, _extracted_dir: &Path) -> bool

Decide whether an extracted archive drops cleanly into the game’s mod dir without any staging (e.g. a Skyrim archive with a top-level Data/ directory, or a Cyberpunk archive with r6/).

fn summarize_content(&self, mod_dir: &Path) -> ContentSummary

Scan a mod directory and return a content summary.