@loontail/minecraft-kit / PlanStandaloneRuntimeInstallInput

Type Alias: PlanStandaloneRuntimeInstallInput

type PlanStandaloneRuntimeInstallInput = {
  cache: MetadataCache;
  directory: string;
  http: HttpClient;
  id: string;
  runtime: ResolvedRuntime;
  signal?: AbortSignal;
};

Defined in: src/install/runtime-install.ts:87

Inputs to planStandaloneRuntimeInstall.

Example

import { detectSystem, MinecraftKit, type PlanStandaloneRuntimeInstallInput } from "@loontail/minecraft-kit";

const kit = new MinecraftKit();
const runtime = await kit.versions.runtime.resolve({ system: detectSystem() });
const input: Omit<PlanStandaloneRuntimeInstallInput, "http" | "cache"> = {
  id: "shared-jre-21",
  directory: "/opt/minecraft/runtimes",
  runtime,
};
const plan = await kit.install.runtime.planStandalone(input);

Properties

Property	Modifier	Type	Description	Defined in
cache	readonly	MetadataCache	-	src/install/runtime-install.ts:93
directory	readonly	string	Where the runtime files live. Used as directory if runtime.installRoot is unset.	src/install/runtime-install.ts:90
http	readonly	HttpClient	-	src/install/runtime-install.ts:92
id	readonly	string	-	src/install/runtime-install.ts:88
runtime	readonly	ResolvedRuntime	-	src/install/runtime-install.ts:91
signal?	readonly	AbortSignal	-	src/install/runtime-install.ts:94