Skip to main content

MelonLoader

Struct MelonLoader 

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

Loader implementation for MelonLoader, a mod loader for Unity games.

MelonLoader supports two installation schemes:

  • Legacy — routes files to UserLibs, Plugins, MelonLoader/Managed, MelonLoader/Libs, MelonLoader, Mods, and UserData/ModManager.
  • Recursive — routes all files into Mods and keeps UserData for mutable config.

§Examples

use loadsmith_loader::{MelonLoader, Loader};

let loader = MelonLoader::with_default_legacy_rules();
assert_eq!(loader.id(), "MelonLoader");

Implementations§

Source§

impl MelonLoader

Source

pub fn with_rules(package_install_ruleset: OwnedInstallRuleset) -> Self

Creates a MelonLoader with a custom install ruleset.

Source

pub fn with_default_legacy_rules() -> Self

Creates a MelonLoader with the legacy install rules (original per-directory routing).

Source

pub fn with_default_recursive_rules() -> Self

Creates a MelonLoader with the recursive install rules (all files go into Mods).

Source

pub fn set_exclude(&mut self, exclude: GlobSet)

Sets a glob set of files to exclude from installation.

Source

pub fn add_install_rule(&mut self, rule: InstallRule)

Adds an install rule to the end of the ruleset.

Trait Implementations§

Source§

impl Clone for MelonLoader

Source§

fn clone(&self) -> MelonLoader

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MelonLoader

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MelonLoader

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Loader for MelonLoader

Source§

fn id(&self) -> &'static str

A unique, human-readable identifier for this loader (e.g. "BepInEx").
Source§

fn loader_install_rules(&self) -> InstallRuleset<'_>

Returns the install rules for end-user mod packages.
Source§

fn package_install_rules(&self) -> InstallRuleset<'_>

Returns the install rules for the loader’s own files (the “loader pack”).
Source§

fn generate_launch_args(&self, ctx: &LaunchContext<'_>) -> Result<LaunchArgs>

Builds the command-line arguments and environment variables needed to launch the game with this loader.
Source§

fn package_config_dirs(&self) -> Vec<PathBuf>

Directories that contain mutable per-package configuration.
Source§

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

Path to the loader’s log file, relative to the game directory.
Source§

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

Filename of the proxy DLL used by this loader, if any.
Source§

fn prepare_launch(&self, ctx: &LaunchContext<'_>) -> Result<()>

Prepares the game directory by copying files from the profile. Read more
Source§

fn package_dir(&self, package: &PackageRef) -> Option<PathBuf>

Returns the directory where a package’s files are placed, if any.

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> 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> Same for T

Source§

type Output = T

Should always be Self
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.
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