Struct cobble_core::minecraft::launch::launch_options::LaunchOptions

source · [−]

pub struct LaunchOptions {Show 16 fields
    pub launcher_name: String,
    pub launcher_version: String,
    pub player_name: String,
    pub profile_id: Option<String>,
    pub token: Option<String>,
    pub use_fullscreen: bool,
    pub enable_window_size: bool,
    pub window_width: u32,
    pub window_height: u32,
    pub enable_memory: bool,
    pub min_memory: u32,
    pub max_memory: u32,
    pub java_exec: String,
    pub enable_jvm_args: bool,
    pub jvm_args: String,
    pub environment_variables: HashMap<String, Option<String>>,
}

Expand description

Options for launching Minecraft. The options can be created using the builder pattern:


let options: LaunchOptions = LaunchOptionsBuilder::default()
    .player_name("Steve".to_string())
    .use_fullscreen(true)
    .java_exec("/usr/bin/java".to_string())
    .build();

Fields

launcher_name: String

Name of the launcher that gets passed as a game argument.

Defaults to this crates name when using LaunchOptionsBuilder.

launcher_version: String

Version of the launcher that gets passed as a game argument.

Defaults to this crates version when using LaunchOptionsBuilder.

player_name: String

Player name for the game.

Defaults to Steve when using LaunchOptionsBuilder.

profile_id: Option<String>

The profile ID.

This is needed for online mode.

token: Option<String>

The minecraft access token.

This is needed for online mode.

use_fullscreen: bool

Launches the game in fullscreen mode. When set to true, the window size is ignored.

Defaults to false when using LaunchOptionsBuilder.

enable_window_size: bool

Enables a custom resolution for the game window. Only has an effect when game is not launched in fullscreen mode.

Defaults to false when using LaunchOptionsBuilder.

window_width: u32

Game window width. Used when enable_window_size is set to true.

Defaults to 1280 when using LaunchOptionsBuilder.

window_height: u32

Game window height. Used when enable_window_size is set to true.

Defaults to 720 when using LaunchOptionsBuilder.

enable_memory: bool

Enables custom memory JVM arguments.

Defaults to false when using LaunchOptionsBuilder.

min_memory: u32

JVM initial heap size in megabytes. Adds the -Xms option to the command. Gets added before jvm_args.

Defaults to 1024 when using LaunchOptionsBuilder.

max_memory: u32

JVM max heap size in megabytes. Adds the -Xmx option to the command. Gets added before jvm_args`.

Defaults to 2048 when using LaunchOptionsBuilder.

java_exec: String

Java executable used to launch minecraft.

Defaults to java when using LaunchOptionsBuilder.

enable_jvm_args: bool

Enables custom JVM arguments. When disabled and the version data provides JVM arguments, the arguments from the version data are used. When enabled, arguments from version data are ignored.

Defaults to false when using LaunchOptionsBuilder.

jvm_args: String

Custom JVM arguments.

Defaults to and empty string when using LaunchOptionsBuilder.

environment_variables: HashMap<String, Option<String>>

Environment variables for the game process.

No environment variables set by default.