Struct VersionBuilder 

pub struct VersionBuilder<L = ()> {
    pub name: String,
    pub loader: L,
    pub loader_version: String,
    pub minecraft_version: String,
    pub game_dirs: PathBuf,
    pub java_dirs: PathBuf,
    pub runtime_dir: PathBuf,
    pub mod_requests: Vec<ModRequest>,
    pub ttl_override: Option<Duration>,
}

Configures a Minecraft instance: name, loader, versions, and on-disk paths.

Default directories are derived from the global AppState:

• game_dirs = AppState::data_dir().join(name)
• runtime_dir = alias of game_dirs until overridden
• java_dirs = AppState::config_dir().join("jre")

Call AppState::init once at startup before constructing any VersionBuilder.

Fields

name: String

loader: L

loader_version: String

minecraft_version: String

game_dirs: PathBuf

java_dirs: PathBuf

runtime_dir: PathBuf

mod_requests: Vec<ModRequest>

ttl_override: Option<Duration>

Implementations

impl<L> VersionBuilder<L>

pub fn new( name: &str, loader: L, loader_version: &str, minecraft_version: &str, ) -> Self

Creates a new VersionBuilder with default paths derived from the global AppState.

Panics if AppState::init hasn’t been called yet.

Example

use lighty_core::AppState;
use lighty_loaders::types::Loader;
use lighty_version::VersionBuilder;

AppState::init("MyLauncher").unwrap();
let builder = VersionBuilder::new("my-instance", Loader::Vanilla, "", "1.21.1");

pub fn with_mod(self) -> ModSourcesBuilder<L>

Opens the mod-sources sub-builder.

Example

let builder = VersionBuilder::new("modded", Loader::Fabric, "0.16.0", "1.21.1")
    .with_mod()
        .done();

pub fn with_custom_java_dir(self, java_dir: PathBuf) -> Self

Overrides the Java install directory.

Example

use std::path::PathBuf;
let builder = VersionBuilder::new("my-instance", Loader::Vanilla, "", "1.21.1")
    .with_custom_java_dir(PathBuf::from("/opt/java"));

pub fn with_loader(self, loader: L) -> Self

Replaces the loader.

Example

let builder = VersionBuilder::new("my-instance", Loader::Vanilla, "", "1.21.1")
    .with_loader(Loader::Fabric);

pub fn with_loader_version(self, version: &str) -> Self

Replaces the loader version.

Example

let builder = VersionBuilder::new("my-instance", Loader::Fabric, "0.16.0", "1.21.1")
    .with_loader_version("0.17.2");

pub fn with_minecraft_version(self, version: &str) -> Self

Replaces the Minecraft version.

Example

let builder = VersionBuilder::new("my-instance", Loader::Vanilla, "", "1.21.1")
    .with_minecraft_version("1.20.4");

pub fn with_ttl_duration(self, ttl: Duration) -> Self

Overrides the TTL applied to every cache associated with this instance. Default = 24h.

Example

use std::time::Duration;
let builder = VersionBuilder::new("my-instance", Loader::Vanilla, "", "1.21.1")
    .with_ttl_duration(Duration::from_secs(3600));

Trait Implementations

impl<L: Clone> Clone for VersionBuilder<L>

fn clone(&self) -> VersionBuilder<L>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<L: Debug> Debug for VersionBuilder<L>

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

Formats the value using the given formatter.

impl<'b, L: Clone + Send + Sync + Debug> VersionInfo for &'b VersionBuilder<L>

type LoaderType = L

fn name(&self) -> &str

Instance name (unique profile identifier).

fn loader_version(&self) -> &str

Loader version (or server URL for LightyVersionBuilder).

fn minecraft_version(&self) -> &str

Minecraft version.

fn game_dirs(&self) -> &Path

Instance root directory (holds runtime/, libraries/, assets/, .forge/ etc.).

fn java_dirs(&self) -> &Path

Java directory (holds JRE installations).

fn loader(&self) -> &Self::LoaderType

Returns the loader.

fn runtime_dir(&self) -> &Path

Working directory the JVM is launched in — the value passed as ${game_directory} to the Minecraft client.

fn ttl(&self) -> Duration

TTL applied to every cache entry the launcher associates with this instance. Default = 24h.

fn set_runtime_dir(&mut self, _path: PathBuf)

Internal setter used by the launch runner to write the effective runtime dir back onto a mutable builder.

fn game_dir_exists(&self) -> bool

Returns whether the game directory exists on disk.

fn java_dir_exists(&self) -> bool

Returns whether the Java directory exists on disk.

fn full_identifier(&self) -> String

Returns a fully qualified version identifier.

fn paths(&self) -> (&Path, &Path)

Returns the (game_dir, java_dir) tuple.

fn is_installed(&self) -> bool

Returns whether the instance is installed (game directory exists).

impl<L: Clone + Send + Sync + Debug> VersionInfo for VersionBuilder<L>

type LoaderType = L

fn name(&self) -> &str

Instance name (unique profile identifier).

fn loader_version(&self) -> &str

Loader version (or server URL for LightyVersionBuilder).

fn minecraft_version(&self) -> &str

Minecraft version.

fn game_dirs(&self) -> &Path

Instance root directory (holds runtime/, libraries/, assets/, .forge/ etc.).

fn java_dirs(&self) -> &Path

Java directory (holds JRE installations).

fn loader(&self) -> &Self::LoaderType

Returns the loader.

fn runtime_dir(&self) -> &Path

Working directory the JVM is launched in — the value passed as ${game_directory} to the Minecraft client.

fn set_runtime_dir(&mut self, path: PathBuf)

Internal setter used by the launch runner to write the effective runtime dir back onto a mutable builder.

fn ttl(&self) -> Duration

TTL applied to every cache entry the launcher associates with this instance. Default = 24h.

fn game_dir_exists(&self) -> bool

Returns whether the game directory exists on disk.

fn java_dir_exists(&self) -> bool

Returns whether the Java directory exists on disk.

fn full_identifier(&self) -> String

Returns a fully qualified version identifier.

fn paths(&self) -> (&Path, &Path)

Returns the (game_dir, java_dir) tuple.

fn is_installed(&self) -> bool

Returns whether the instance is installed (game directory exists).

impl<'b, L: Clone + Send + Sync + Debug> WithMods for &'b VersionBuilder<L>

fn mod_requests(&self) -> &[ModRequest]

User-attached mod requests pulled from Modrinth / CurseForge at install time.

impl<L: Clone + Send + Sync + Debug> WithMods for VersionBuilder<L>

fn mod_requests(&self) -> &[ModRequest]

User-attached mod requests pulled from Modrinth / CurseForge at install time.