Mod Parser

Usage

Parse Fabric Mod Metadata

import { readFabricMod, FabricModMetadata } from "@xmcl/mods";
const modJarBinary = fs.readFileSync("your-fabric.jar");
const metadata: FabricModMetadata = await readFabricMod(modJarBinary);

// or directly read from path
const sameMetadata: FabricModMetadata = await readFabricMod("your-fabric.jar");

Parse Forge Mod/Config

Read the forge mod metadata, including @Mod annotation, mcmods.info, and toml metadata.

import { readForgeMod, ForgeModMetadata } from "@xmcl/mods";
const forgeModJarBuff: Buffer;
const metadata: ForgeModMetadata[] = await readForgeMod(forgeModJarBuff);
const modid = metadata[0].modid; // get modid of first mods

If you don't want to read that much (as it will transverse all the file in jar), you can try to use them separately:

import { resolveFileSystem } from "@xmcl/system";
import { readForgeModJson, readForgeModManifest, readForgeModToml, ForgeModMetadata, readForgeModAsm } from "@xmcl/mods";
const forgeModJarBuff: Buffer;
const fs = await resolveFileSystem(forgeModJarBuff);
// read json
// if this is new mod, this will be empty record {}
const metadata: Record<string, ForgeModMetadata> = await readForgeModJson(fs);
// or read `META-INF/MANIFEST.MF`
const manifest: Record<string, string> = await readForgeModManifest(fs, metadata /* this is optional, to fill the modmetadata if found */);
// read new toml
await readForgeModToml(fs, metadata /* it will fill mods into this param & return it */, manifest /* this is optional */);
// optional step, if the mod is really unstandard, not have mcmod.info and toml, you can use this
// this can identify optifine and in some case, might detect some coremod
// this will go over all file in your jar, it might hit your perf.
await readForgeModAsm(fs, metadata, { manifest });

Read the forge mod config file (.cfg)

import { ForgeConfig } from "@xmcl/mods";
const modConfigString: string;
const config: ForgeConfig = ForgeConfig.parse(modConfigString);
const serializedBack: string = ForgeConfig.stringify(config);

Parse Liteloader Mod

Read .litemod metadata:

import { LiteloaderModMetadata, readLiteloaderMod } from "@xmcl/mods";
const metadata: LiteloaderModMetadata = await readLiteloaderMod(`${mock}/mods/sample-mod.litemod`);

🧾 Classes

CorruptedForgeConfigErrorForgeModParseFailedError

🤝 Interfaces

DependencyObjectFabricModMetadataForgeConfigForgeModASMDataForgeModAnnotationDataForgeModMcmodInfoForgeModMetadataForgeModTOMLDataLiteloaderModMetadataManifestMetadataQuiltLoaderDataQuiltModMetadata

🗃️ Namespaces

ForgeConfig

🏭 Functions

readFabricMod

readFabricMod(file: string | Uint8Array | FileSystem): Promise<FabricModMetadata>

Read fabric mod metadata json from a jar file or a directory

Parameters

• file: string | Uint8Array | FileSystem The jar file or directory path. I can also be the binary content of the jar if you have already read the jar.

Return Type

• Promise<FabricModMetadata>

Defined in: packages/mod-parser/fabric.ts:193

readForgeMod

readForgeMod(mod: ForgeModInput): Promise<ForgeModMetadata>

Read metadata of the input mod.

This will scan the mcmod.info file, all class file for @Mod & coremod DummyModContainer class. This will also scan the manifest file on META-INF/MANIFEST.MF for tweak mod.

If the input is totally not a mod. It will throw [NonForgeModFileError].

Parameters

• mod: ForgeModInput The mod path or data

Return Type

• Promise<ForgeModMetadata>

Defined in: packages/mod-parser/forge.ts:685

readForgeModAsm

readForgeModAsm(mod: ForgeModInput, manifest: Record<string, string>= {}): Promise<ForgeModASMData>

Use asm to scan all the class files of the mod. This might take long time to read.

Parameters

• mod: ForgeModInput
• manifest: Record<string, string>

Return Type

• Promise<ForgeModASMData>

Defined in: packages/mod-parser/forge.ts:516

readForgeModJson

readForgeModJson(mod: ForgeModInput): Promise<ForgeModMcmodInfo[]>

Read mcmod.info, cccmod.info, and neimod.info json file

Parameters

• mod: ForgeModInput The mod path or buffer or opened file system.

Return Type

• Promise<ForgeModMcmodInfo[]>

Defined in: packages/mod-parser/forge.ts:565

readForgeModManifest

readForgeModManifest(mod: ForgeModInput, manifestStore: Record<string, any>= {}): Promise<ManifestMetadata | undefined>

Read the mod info from META-INF/MANIFEST.MF

Parameters

• mod: ForgeModInput
• manifestStore: Record<string, any>

Return Type

• Promise<ManifestMetadata | undefined>

Defined in: packages/mod-parser/forge.ts:414

readForgeModToml

readForgeModToml(mod: ForgeModInput, manifest: Record<string, string>): Promise<ForgeModTOMLData[]>

Read mod metadata from new toml metadata file.

Parameters

• mod: ForgeModInput
• manifest: Record<string, string>

Return Type

• Promise<ForgeModTOMLData[]>

Defined in: packages/mod-parser/forge.ts:472

readLiteloaderMod

readLiteloaderMod(mod: string | Uint8Array | FileSystem): Promise<LiteloaderModMetadata>

Parameters

• mod: string | Uint8Array | FileSystem

Return Type

• Promise<LiteloaderModMetadata>

Defined in: packages/mod-parser/liteloader.ts:20

readQuiltMod

readQuiltMod(file: string | Uint8Array | FileSystem): Promise<QuiltModMetadata>

Read fabric mod metadata json from a jar file or a directory

Parameters

• file: string | Uint8Array | FileSystem The jar file or directory path. I can also be the binary content of the jar if you have already read the jar.

Return Type

• Promise<QuiltModMetadata>

Defined in: packages/mod-parser/quilt.ts:265