Package org.geysermc.geyser.api.pack

Interface ResourcePackManifest

public interface ResourcePackManifest

Represents a Bedrock edition resource pack manifest (manifest.json). All resource packs are required to have such a file as it identifies the resource pack. See Microsoft's docs for more info.

Since:

2.1.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ResourcePackManifest.Dependency	Represents a dependency of a resource pack.
static interface	ResourcePackManifest.Header	Represents the header of a resource pack.
static interface	ResourcePackManifest.Module	Represents a module of a resource pack.
static interface	ResourcePackManifest.Setting	Represents a setting that is shown client-side that describe what a pack does.
static interface	ResourcePackManifest.Subpack	Represents a subpack of a resource pack.
static interface	ResourcePackManifest.Version	Represents a version of a resource pack.

Method Summary

Modifier and Type	Method	Description
@NonNull Collection<? extends ResourcePackManifest.Dependency>	dependencies()	Gets the ResourcePackManifest.Dependency's of the resource pack.
int	formatVersion()	Gets the format version of the resource pack.
@NonNull ResourcePackManifest.Header	header()	Gets the ResourcePackManifest.Header of the resource pack.
@NonNull Collection<? extends ResourcePackManifest.Module>	modules()	Gets the ResourcePackManifest.Module's of the resource pack.
@NonNull Collection<? extends ResourcePackManifest.Setting>	settings()	Gets the ResourcePackManifest.Setting's of the resource pack.
@NonNull Collection<? extends ResourcePackManifest.Subpack>	subpacks()	Gets the ResourcePackManifest.Subpack's of the resource pack.

Method Details

formatVersion

int formatVersion()

Gets the format version of the resource pack.

"1" is used for skin packs, "2" is used for resource and behavior packs, and world templates.

Returns:

the format version

Since:

2.1.1

header

@NonNull ResourcePackManifest.Header header()

Gets the ResourcePackManifest.Header of the resource pack.

Returns:

the ResourcePackManifest.Header

Since:

2.1.1

modules

@NonNull Collection<? extends ResourcePackManifest.Module> modules()

Gets the ResourcePackManifest.Module's of the resource pack.

Returns:

a collection of modules

Since:

2.1.1

dependencies

@NonNull Collection<? extends ResourcePackManifest.Dependency> dependencies()

Gets the ResourcePackManifest.Dependency's of the resource pack.

Returns:

a collection of dependencies

Since:

2.6.2

subpacks

@NonNull Collection<? extends ResourcePackManifest.Subpack> subpacks()

Gets the ResourcePackManifest.Subpack's of the resource pack. See Microsoft's docs on subpacks for more information.

Returns:

a collection of subpacks

Since:

2.6.2

settings

@NonNull Collection<? extends ResourcePackManifest.Setting> settings()

Gets the ResourcePackManifest.Setting's of the resource pack. These are shown to Bedrock client's in the resource pack settings menu (see here) to inform users about what the resource pack and sub-packs include.

Returns:

a collection of settings

Since:

2.6.2