Skip to main content

GenericGame

Struct GenericGame 

Source
pub struct GenericGame { /* private fields */ }
Expand description

A generic game with loose file drop support.

Implementations§

Source§

impl GenericGame

Source

pub fn new( id: impl Into<String>, name: impl Into<String>, install_path: Option<PathBuf>, mod_dir: impl Into<String>, ) -> Self

Trait Implementations§

Source§

impl GamePlugin for GenericGame

Source§

fn game_id(&self) -> &str

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

fn display_name(&self) -> &str

Human-readable display name.
Source§

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

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

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

Return the mod directory relative to the install path.
Source§

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.
Source§

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

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

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

Return the save directory for this game, if known.
Source§

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

Classify whether a mod is save-breaking based on its installed content. Read more
Source§

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. Read more
Source§

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.
Source§

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.
Source§

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

Source§

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

Source§

fn has_plugin_system(&self) -> bool

Source§

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

Source§

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

Source§

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

Source§

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.
Source§

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

Claim an extracted archive as a game-specific install method. Read more
Source§

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/). Read more
Source§

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

Classify a file extension into a content category.
Source§

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

Scan a mod directory and return a content summary.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more