Struct ReturnOfModding 

pub struct ReturnOfModding { /* private fields */ }

Loader implementation for Return of Modding (ROM), a mod loader for the game Hellsmith.

Routes packages into ReturnOfModding/plugins, ReturnOfModding/plugins_data, and ReturnOfModding/config (mutable). The loader passes --rom_modding_root_folder as the launch argument.

Examples

use loadsmith_loader::{ReturnOfModding, Loader};

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

Implementations

impl ReturnOfModding

pub fn with_rules(package_install_ruleset: OwnedInstallRuleset) -> Self

Creates a ReturnOfModding loader with a custom install ruleset.

pub fn with_default_rules() -> Self

Creates a ReturnOfModding loader with the default rules.

Default routes:

• ReturnOfModding/plugins — default rule
• ReturnOfModding/plugins_data
• ReturnOfModding/config (mutable)

Trait Implementations

impl Clone for ReturnOfModding

fn clone(&self) -> ReturnOfModding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReturnOfModding

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

Formats the value using the given formatter.

impl Loader for ReturnOfModding

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 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 prepare_launch(&self, ctx: &LaunchContext<'_>) -> Result<()>

Prepares the game directory by copying files from the profile.

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

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