Package org.geysermc.geyser.api.pack

Interface ResourcePackManifest.Subpack

Enclosing interface:
ResourcePackManifest
public static interface ResourcePackManifest.Subpack
Represents a subpack of a resource pack. These are often used for "variants" of the resource pack, such as lesser details, or additional features either to be determined by player's taste or adapted to the player device's performance. See Micoroft's docs for more information.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull String
    folderName()
    Gets the folder name where this sub-pack is placed in.
    @Nullable Float
    memoryTier()
    Gets the memory tier of this Subpack, representing how much RAM a device must have to run it.
    @NonNull String
    name()
    Gets the name of this subpack.

  • Method Details

    • folderName

      @NonNull String folderName()
      Gets the folder name where this sub-pack is placed in.
      Returns:
      the folder name
      Since:
      2.6.2

    • name

      @NonNull String name()
      Gets the name of this subpack. Required for each subpack to be valid. To make a Bedrock client load any subpack, register the resource pack in the SessionLoadResourcePacksEvent or GeyserDefineResourcePacksEvent and specify a SubpackOption with the name of the subpack to load.
      Returns:
      the subpack name
      Since:
      2.6.2

    • memoryTier

      @Nullable Float memoryTier()
      Gets the memory tier of this Subpack, representing how much RAM a device must have to run it. Each memory tier requires 0.25 GB of RAM. For example, a memory tier of 0 is no requirement, and a memory tier of 4 requires 1GB of RAM.
      Returns:
      the memory tier
      Since:
      2.6.2