Skip to main content

LaunchOptions

Struct LaunchOptions 

Source
pub struct LaunchOptions {
    pub account: Account,
    pub java_executable: Option<PathBuf>,
    pub game_directory: Option<PathBuf>,
    pub natives_directory: Option<PathBuf>,
    pub launcher_name: String,
    pub launcher_version: String,
    pub custom_resolution: Option<(u32, u32)>,
    pub demo: bool,
    pub server: Option<(String, Option<u16>)>,
    pub disable_multiplayer: bool,
    pub disable_chat: bool,
    pub compatibility: CompatibilityPolicy,
}
Expand description

User and process settings used while building a launch command.

Start with LaunchOptions::default and override only the fields your launcher exposes. By default the game directory is isolated under <minecraft_dir>/versions/<version_id>, which keeps saves, options, logs, and mods separate per installed profile.

Fields§

§account: Account

Account values substituted into Minecraft’s auth placeholders.

§java_executable: Option<PathBuf>

Java executable to run.

If omitted, the command uses java and relies on the caller’s PATH.

§game_directory: Option<PathBuf>

Game directory passed as ${game_directory} and used as process CWD.

If omitted, a version-isolated directory is used.

§natives_directory: Option<PathBuf>

Directory containing extracted native libraries.

If omitted, this points at <minecraft_dir>/versions/<version_id>/natives.

§launcher_name: String

Launcher name passed to modern version argument templates.

§launcher_version: String

Launcher version passed to modern version argument templates.

§custom_resolution: Option<(u32, u32)>

Optional window size appended as --width and --height.

§demo: bool

Enables Minecraft demo mode.

§server: Option<(String, Option<u16>)>

Optional multiplayer server and port to join after launch.

§disable_multiplayer: bool

Appends the modern --disableMultiplayer flag.

§disable_chat: bool

Appends the modern --disableChat flag.

§compatibility: CompatibilityPolicy

Controls whether known compatibility patches are applied before building.

Trait Implementations§

Source§

impl Clone for LaunchOptions

Source§

fn clone(&self) -> LaunchOptions

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 LaunchOptions

Source§

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

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

impl Default for LaunchOptions

Source§

fn default() -> Self

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

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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