Skip to content

@loontail/minecraft-kit v0.8.14 / InstallAspect

Type alias: InstallAspect

ts
type InstallAspect: {
  runtime: {
     plan: Promise<InstallPlan>;
     run: Promise<InstallReport>;
     standalonePlan: Promise<InstallPlan>;
    };
  plan: Promise<InstallPlan>;
  run: Promise<InstallReport>;
};

Shape of kit.install. Consumers usually access this through kit.install; the alias is exported so the facade documentation can show the concrete surface.

Type declaration

MemberTypeDescription
runtime{
plan: Promise<InstallPlan>;
run: Promise<InstallReport>;
standalonePlan: Promise<InstallPlan>;
}-
planPromise<InstallPlan>-
runPromise<InstallReport>-
standalonePlanPromise<InstallPlan>-
planPromise<InstallPlan>

Build the install plan for a target. Side-effect-free for vanilla and Fabric.

Forge is the exception: planning downloads the Forge installer JAR and extracts its embedded Maven artifacts to libraries/, because the per-library and processor actions can only be enumerated after reading the installer's install_profile.json from disk. Do not treat plan(forgeTarget) as a pure/offline dry-run — it requires network + disk.

runPromise<InstallReport>-

Source

src/kit/install-aspect.ts:78

MIT License