Struct Northstar 

pub struct Northstar { /* private fields */ }

Loader implementation for Northstar, a mod loader for Titanfall 2.

Northstar places packages into R2Northstar/mods and launches with -northstar -profile=<path>. It excludes common metadata files (manifest.json, README.md, icon.png, LICENSE) from installation.

Examples

use loadsmith_loader::{Northstar, Loader};

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

Implementations

impl Northstar

pub fn with_rules(package_install_ruleset: OwnedInstallRuleset) -> Self

Creates a Northstar loader with a custom install ruleset.

pub fn with_default_rules() -> Self

Creates a Northstar loader with the default rules.

Files are routed into R2Northstar/mods. Metadata files (manifest.json, README.md, icon.png, LICENSE) are excluded.

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 Northstar

fn clone(&self) -> Northstar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Northstar

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

Formats the value using the given formatter.

impl Default for Northstar

fn default() -> Self

Returns the “default value” for a type.

impl Loader for Northstar

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.