Skip to main content

InstallData

Struct InstallData 

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

Installation-specific paths and identifiers.

Contains all the data that varies between different installation types of the same game (Steam vs Epic, Windows vs Linux, etc.).

§Path Relativity

Important: All paths in this struct are RELATIVE paths, either to:

  • The game’s root directory (most paths)
  • The data directory (vanilla_packs)

This allows the same configuration to work across different installation locations by combining with the actual game path at runtime.

Implementations§

Source§

impl InstallData

Source

pub fn vanilla_packs(&self) -> &Vec<String>

Vanilla PackFile names (without paths).

Used as fallback when no manifest file exists (Empire, Napoleon). Paths are relative to the data_path.

Source

pub fn use_manifest(&self) -> &bool

Whether to use the game’s manifest file for vanilla PackFile discovery.

true: Read manifest file (most games) false: Use hardcoded vanilla_packs list

Source

pub fn store_id(&self) -> &u64

Steam/store ID for the game.

Used for Steam integration and auto-detection.

Source

pub fn store_id_ak(&self) -> &u64

Steam/store ID for the game’s Assembly Kit.

0 if no Assembly Kit is available on Steam.

Source

pub fn executable(&self) -> &String

Game executable file name (with extension).

Used to detect installation type and for launching the game. Examples: "Warhammer3.exe", "Shogun2.exe"

Source

pub fn data_path(&self) -> &String

Data directory path relative to game root.

Where PackFiles are stored. Usually "data" but varies.

Source

pub fn language_path(&self) -> &String

Language file directory path relative to game root.

Where language.txt or equivalent is located. May be different from data_path on Linux builds.

Source

pub fn local_mods_path(&self) -> &String

Local mods directory path relative to game root.

Where the game loads locally-installed mods from.

Source

pub fn downloaded_mods_path(&self) -> &String

Downloaded mods directory path relative to game root.

Where Steam Workshop and other downloaded mods are stored. Empty string if the game doesn’t support downloadable mods.

Source

pub fn config_folder(&self) -> &Option<String>

Config directory name (not full path).

Used with platform-specific config locations (AppData on Windows, .config on Linux). None if game doesn’t store config externally.

Trait Implementations§

Source§

impl Clone for InstallData

Source§

fn clone(&self) -> InstallData

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for InstallData

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.