Struct BepInEx 

pub struct BepInEx { /* private fields */ }

Loader implementation for BepInEx, a general-purpose Unity mod loader.

BepInEx uses Doorstop to inject into the game process and supports several sub-directories for plugins, patchers, monomod assemblies, and config.

Examples

use loadsmith_loader::{BepInEx, Loader};

let loader = BepInEx::with_default_rules();
assert_eq!(loader.id(), "BepInEx");

Implementations

impl BepInEx

pub fn with_rules(package_install_ruleset: OwnedInstallRuleset) -> Self

Creates a BepInEx loader with a custom install ruleset.

pub fn with_default_rules() -> Self

Creates a BepInEx loader with the default install rules.

Default routes:

• BepInEx/config (mutable, flat)
• BepInEx/patchers
• BepInEx/core
• BepInEx/monomod (files with .mm.dll extension)
• BepInEx/plugins (files with .dll extension) — default rule

pub fn add_install_rule(&mut self, rule: impl Into<InstallRule>)

Adds an install rule to the end of the ruleset.

pub fn insert_install_rule( &mut self, index: usize, rule: impl Into<InstallRule>, )

Inserts an install rule at the given index.

Trait Implementations

impl Clone for BepInEx

fn clone(&self) -> BepInEx

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BepInEx

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

Formats the value using the given formatter.

impl Default for BepInEx

fn default() -> Self

Returns the “default value” for a type.

impl Loader for BepInEx

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

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

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

Returns the install rules for end-user mod packages.

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

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

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

Prepares the game directory by copying files from the profile.

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.

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

Directories that contain mutable per-package configuration.

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

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

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

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

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

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