@loontail/minecraft-kit v0.8.14 / LaunchOptions

Type alias: LaunchOptions

type LaunchOptions: {
  auth: LaunchAuth;
  extraGameArgs: readonly string[];
  extraJvmArgs: readonly string[];
  features: Readonly<Record<string, boolean>>;
  fullscreen: boolean;
  launcherName: string;
  launcherVersion: string;
  memory: LaunchMemoryOptions;
  resolution: LaunchResolutionOptions;
};

Inputs for kit.launch.compose (and the lower-level composeLaunch helper).

Example

import { AuthModes, type LaunchOptions } from "@loontail/minecraft-kit";

const options: LaunchOptions = {
  auth: { mode: AuthModes.OFFLINE, username: "Steve" },
  memory: { maxMb: 4096 },
  launcherName: "MyLauncher",
  launcherVersion: "1.0.0",
};
const composition = await kit.launch.compose(target, options);

Type declaration

Member	Type	Description
auth	LaunchAuth	-
extraGameArgs	readonly string[]	Extra game args appended after composed game args.
extraJvmArgs	readonly string[]	Extra JVM args appended after composed JVM args.
features	Readonly<Record<string, boolean>>	Set of feature flags evaluated by argument rules (e.g. is_demo_user).
fullscreen	boolean	-
launcherName	string	Brand string injected as ${launcher_name}.
launcherVersion	string	Version string injected as ${launcher_version}.
memory	LaunchMemoryOptions	-
resolution	LaunchResolutionOptions	-

Source

src/types/launch.ts:52