Skip to content

@loontail/minecraft-kit / ForgeVersionsApi

Class: ForgeVersionsApi

Defined in: src/versions/forge.ts:61

Public Forge versions API surface.

Available off a kit instance as kit.versions.forge.

Example

ts
import { MinecraftKit } from "@loontail/minecraft-kit";

const kit = new MinecraftKit();
const forge = await kit.versions.forge.resolve({ minecraftVersion: "1.20.1" });
console.log(forge.fullVersion, forge.installerUrl);

Constructors

Constructor

ts
new ForgeVersionsApi(ctx): ForgeVersionsApi;

Defined in: src/versions/forge.ts:62

Parameters

ParameterType
ctxResolverContext

Returns

ForgeVersionsApi

Methods

list()

ts
list(input?): Promise<readonly ForgeBuildSummary[]>;

Defined in: src/versions/forge.ts:65

List Forge builds (across all Minecraft versions, or filtered to one).

Parameters

ParameterType
inputForgeListInput

Returns

Promise<readonly ForgeBuildSummary[]>


resolve()

ts
resolve(input): Promise<ResolvedForgeLoader>;

Defined in: src/versions/forge.ts:85

Resolve a Forge build for a Minecraft version.

Parameters

ParameterType
inputForgeResolveInput

Returns

Promise<ResolvedForgeLoader>

MIT License