Skip to content

@loontail/minecraft-kit / TargetResolveInput

Type Alias: TargetResolveInput

ts
type TargetResolveInput = {
  directory: string;
  id: string;
  loader: TargetLoaderInput;
  minecraft: {
     version: MinecraftVersionId;
  };
  runtime?: {
     component?: string;
     installRoot?: string;
     preference?: RuntimePreferenceKind;
  };
  signal?: AbortSignal;
  system?: RuntimeSystem;
};

Defined in: src/targets/index.ts:39

Inputs to TargetsApi.resolve.

Example

ts
import { asMinecraftVersionId, Loaders, type TargetResolveInput } from "@loontail/minecraft-kit";

const input: TargetResolveInput = {
  id: "vanilla-1.20.1",
  directory: "/games/minecraft/vanilla-1.20.1",
  minecraft: { version: asMinecraftVersionId("1.20.1") },
  loader: { type: Loaders.VANILLA },
};
const target = await kit.targets.resolve(input);

Properties

PropertyModifierTypeDescriptionDefined in
directoryreadonlystring-src/targets/index.ts:41
idreadonlystring-src/targets/index.ts:40
loaderreadonlyTargetLoaderInput-src/targets/index.ts:43
minecraftreadonly{ version: MinecraftVersionId; }-src/targets/index.ts:42
minecraft.versionreadonlyMinecraftVersionId-src/targets/index.ts:42
runtime?readonly{ component?: string; installRoot?: string; preference?: RuntimePreferenceKind; }-src/targets/index.ts:44
runtime.component?readonlystringOverride the runtime component. Defaults to the Minecraft manifest's javaVersion.component.src/targets/index.ts:47
runtime.installRoot?readonlystringCustom install root (absolute path) holding the component directories. When unset, runtime files live under <directory>/runtime/.src/targets/index.ts:52
runtime.preference?readonlyRuntimePreferenceKind-src/targets/index.ts:45
signal?readonlyAbortSignal-src/targets/index.ts:55
system?readonlyRuntimeSystem-src/targets/index.ts:54

MIT License