Interface QuiltLoaderData

🏷️ Properties

breaks optional

breaks: DependencyObject[]

An array of dependency objects. Defines mods that this mod either breaks or is broken by.

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

depends optional

depends: DependencyObject[]

An array of dependency objects. Defines mods that this mod will not function without.

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

entrypoints optional

entrypoints: Record<string, string>

A collection of key: value pairs, where each key is the type of the entrypoints specified and each values is either a single entrypoint or an array of entrypoints. An entrypoint is an object with the following keys:

• adapter — Language adapter to use for this entrypoint. By default this is default and tells loader to parse using the JVM entrypoint notation.
• value — Points to an implementation of the entrypoint. See below for the default JVM notation.

If an entrypoint does not need to specify a language adapter other than the default language adapter, the entrypoint can be represented simply as the value string instead.

JVM entrypoint notation

When referring to a class, the binary name is used. An example of a binary name is my.mod.MyClass$Inner.

One of the following value notations may be used in the JVM notation:

• Implementation onto a class
  • The value must contain a fully qualified binary name to the class.
  • Implementing class must extend or implement the entrypoint interface.
  • Class must have a no-argument public constructor.
  • Example: example.mod.MainModClass
• A field inside of a class.
  • The value must contain a fully qualified binary name to the class followed by :: and a field name.
  • The field must be static.
  • The type of the field must be assignable from the field's class.
  • Example: example.mod.MainModClass::THE_INSTANCE
  • If there is ambiguity with a method's name, an exception will be thrown.
• A method inside of a class.
  • The value must contain a fully qualified binary name to the class followed by :: and a method name.
  • The method must be capable to implement the entrypoint type as a method reference. Generally this means classes which are functional interfaces.
  • Constructor requirement varies based on the method being static or instance level:
    • A static method does not require a public no-argument constructor.
    • An instance method requires a public no-argument constructor.
  • Example: example.mod.MainModClass::init
  • If there is ambiguity with a fields's name or other method, an exception will be thrown.

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

group

group: string

A unique identifier for the organization behind or developers of the mod. The group string must match the ^[a-zA-Z0-9-_.]+$ regular expression, and must not begin with the reserved namespace loader.plugin. It is recommended, but not required, to follow Maven's guide to naming conventions.

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

id

id: string

A unique identifier for the mod or library defined by this file, matching the ^[a-z][a-z0-9-_]{1,63}$ regular expression. Best practice is that mod ID's are in snake_case.

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

intermediate_mappings optional

intermediate_mappings: string

The intermediate mappings used for this mod. The intermediate mappings string must be a valid maven coordinate and match the ^[a-zA-Z0-9-.]+:[a-zA-Z0-9-.]+$ regular expression. This field currently only officially supports org.quiltmc:hashed and net.fabricmc:intermediary.

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

jars optional

jars: string[]

A list of paths to nested JAR files to load, relative to the root directory inside of the mods JAR.

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

language_adapters optional

language_adapters: Record<string, string>

A collection of key: value pairs, where each key is the namespace of a language adapter and the value is an implementation of the LanguageAdapter interface.

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

load_type optional

load_type: string

Influences whether or not a mod candidate should be loaded or not. May be any of these values:

• "always" (default for mods directly in the mods folder)
• "if_possible"
• "if_required" (default for jar-in-jar mods)

This doesn't affect mods directly placed in the mods folder.

Always

If any versions of this mod are present, then one of them will be loaded. Due to how mod loading actually works if any of the different versions of this mod are present, and one of them has "load_type" set to "always", then all of them are treated as it being set to "always".

If Possible

If this mod can be loaded, then it will - otherwise it will silently not be loaded.

If Required

If this mod is in another mods "depends" field then it will be loaded, otherwise it will silently not be loaded.

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

metadata optional

metadata: Object

Optional metadata that can be used by mods to display information about the mods installed.

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

minecraft optional

minecraft: Object

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

plugins optional

plugins: string[]

An array of loader plugins. A plugin is an object with the following keys:

• adapter — Language adapter to use for this plugin
• value — Points to an implementation of the LoaderPlugin interface. Can be in either of the following forms:
  • my.package.MyClass — A class to be instantiated and used
  • my.package.MyClass::thing — A static field containing an instance of a LoaderPlugin

If a plugin does not need to specify a language adapter other than the default language adapter, the plugin can be represented simply as the value string instead.

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

provides optional

provides: string[]

An array of ProvidesObjects describing other mods/APIs that this package provides.

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

repositories optional

repositories: string[]

A list of Maven repository URL strings where dependencies can be looked for in addition to Quilt's central repository.

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

version

version: string

Must conform to the Semantic Versioning 2.0.0 specification. In a development environment, the value ${version} can be used as a placeholder by quilt-gradle to be replaced on building the resulting JAR.

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