Package net.neoforged.fml.loading.moddiscovery.readers

Class JarModsDotTomlModFileReader

java.lang.Object

net.neoforged.fml.loading.moddiscovery.readers.JarModsDotTomlModFileReader

All Implemented Interfaces:

IModFileReader, IOrderedProvider

public class JarModsDotTomlModFileReader
extends Object
implements IModFileReader

Responsible for handling mod files that are explicitly marked as mods or libraries via metadata files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final record	JarModsDotTomlModFileReader.DefaultModFileInfo

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	LOGGER
static final String	MANIFEST
static final String	MODS_TOML

Fields inherited from interface net.neoforged.neoforgespi.locating.IOrderedProvider

DEFAULT_PRIORITY, HIGHEST_SYSTEM_PRIORITY, LOWEST_SYSTEM_PRIORITY

Constructor Summary

Constructors

Constructor	Description
JarModsDotTomlModFileReader()

Method Summary

Modifier and Type	Method	Description
static IModFile	createModFile(JarContents contents, ModFileDiscoveryAttributes discoveryAttributes)
private static IModFile.Type	getModType(JarContents jar)
static IModFileInfo	manifestParser(IModFile mod)
@Nullable IModFile	read(JarContents jar, ModFileDiscoveryAttributes discoveryAttributes)	Provides a mod from the given jar.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.neoforged.neoforgespi.locating.IOrderedProvider

getPriority

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

MODS_TOML

public static final String MODS_TOML

See Also:

• Constant Field Values

MANIFEST

public static final String MANIFEST

See Also:

• Constant Field Values

Constructor Details

JarModsDotTomlModFileReader

public JarModsDotTomlModFileReader()

Method Details

createModFile

public static IModFile createModFile(JarContents contents,
 ModFileDiscoveryAttributes discoveryAttributes)

getModType

@Nullable
private static IModFile.Type getModType(JarContents jar)

manifestParser

public static IModFileInfo manifestParser(IModFile mod)

read

@Nullable
public @Nullable IModFile read(JarContents jar,
 ModFileDiscoveryAttributes discoveryAttributes)

Description copied from interface: IModFileReader

Provides a mod from the given jar.

Throwing ModLoadingException will report contained issues as the reason for incompatibility to players, unless another reader successfully reads the jar.

Other thrown exceptions will be reported as errors and cause loading to fail.

Specified by:

read in interface IModFileReader

Parameters:

jar - the mod jar contents

discoveryAttributes - The attributes relating to this mod files discovery.

Returns:

null if this provider can't handle the given jar, otherwise the mod-file created from the given contents and attributes.

toString

public String toString()

Overrides:

toString in class Object