Minecraft:Atlas

An atlas is effectively a collection of individual sprites that are combined into one large image when resource packs are loaded. In Minecraft, these are used by various objects such as terrain, items, most gui widgets, and certain block entity textures.

Specification

The sprites that are included in an atlas are controlled by json files in a Minecraft:resource pack. These are stored in the assets/<namespace>/atlases/<id>.json directory of a resource pack with the following format.

When loading atlas files, the game combines all sprite sources from all currently active packs for each atlas. This means that multiple packs can add or remove sprites from an atlas without conflicting with one another.

It is not possible to define custom atlases simply by creating the JSON file for one as atlases must be registerred in the game code. Unknown atlas files are ignored by the game when loading resources.

JSON format

• Template:Nbt The root tag.
  • Template:Nbt: Contains a list of sprite sources. Every entry runs in during load, in order of definition, adding or removing new textures to the atlas.
    • Template:Nbt A sprite source.
      • Template:Nbt: The Minecraft:Identifier of a sprite source. See Template:Slink
      • Additional fields depending on value of Template:Code

Sprite source types

Template:Code

Lists all files in a directory and its subdirectories, across all namespaces.

• Template:Nbt The root compound
  • Template:Nbt: Template:Code
  • Template:Nbt: Directory in pack to be listed (relative to Template:Code directory).
  • Template:Nbt: String to be prefixed to the sprite name when loaded.

Template:Code

Adds a single sprite to the atlas.

• Template:Nbt The root compound
  • Template:Nbt: Template:Code
  • Template:Nbt: The identifier of a resource (relative to Template:Code directory, implied Template:Code extension).
  • Template:Nbt: Name (as an identifier) of the sprite that is added to the atlas (optional, defaults to the value of Template:Code).

Template:Code

Removes sprites whose identifier match the given Template:Wikipedia pattern (only works for entries in packs with a lower priority to the current one Template:Verify).

• Template:Nbt The root compound
  • Template:Nbt: Template:Code
  • Template:Nbt: Regular expression of the namespace to be removed. If omitted, any value is matched.
  • Template:Nbt: Regular expression of the path to be removed. If omitted, any value is matched.

Template:Code

Copies rectangular regions from other images and adds them to the atlas with the specified names.

• Template:Nbt The root compound
  • Template:Nbt: Template:Code
  • Template:Nbt: The identifier of a resource (relative to Template:Code directory, implied Template:Code extension).
  • Template:Nbt: Used for determining the units used by in the Template:Code coordinate of regions.
  • Template:Nbt: Used for determining the units used by in the Template:Code coordinate of regions.
  • Template:Nbt: List of regions to copy from the source image.
    • Template:Nbt: Name (as an identifier) of the sprite that is added to the atlas.
    • Template:Nbt: Specifies the Template:Code coordinate of the top-left corner of the region.
    • Template:Nbt: Specifies the Template:Code coordinate of the top-left corner of the region.
    • Template:Nbt: Specifies the width of the region.
    • Template:Nbt: Specifies the height of the region.

Template:Code

Dynamically generate sprites in-memory from a set of color palettes and base textures.

• Template:Nbt The root compound
  • Template:Nbt: Template:Code
  • Template:Nbt: A list of identifiers of resources (relative to Template:Code directory, implied Template:Code extension). These textures are used to generate variants of them that have been modified by color palettes.
  • Template:Nbt: A value that is used when joining texture and permutation names to produce sprite name. Defaults to Template:Cd.
  • Template:Nbt: An identifier (relative to Template:Code directoryTemplate:Until. Template:INUpcoming relative to Template:Code directory. Implied Template:Code extension) of a color palette key texture. This is used to define the set of key pixel colors to swap out with the color palettes defined.
  • Template:Nbt: A map of permutations from suffix string to an identifier (relative to Template:Code directoryTemplate:Until. Template:INUpcoming relative to Template:Code directory. Implied Template:Code extension) of a color palette file. The suffix is appended to the identifier of the output variant textures, with the string specified in separator separating the suffix and the base texture name. The number of pixels in each color palette must be the same as that of the Template:Code defined for this source. Pixels are compared by RGB value. The alpha channel is ignored for key matching, but in the resulting texture the alpha channel is multiplied with the color palette's alpha channel. Pixels that do not match the Template:Code are copied over to the resulting texture as-is.

List of atlases

All the atlases that are currently used by the game.

For atlases which support Template:Wikipedia, all sprites should be a minimum of 16x16 pixels in size and a multiple of 2. If these guidelines aren't met the maximum mipmap level is limited and a message is printed in the log along the lines of 'Texture <sprite id> with size <width>x<height> limits mip level from <target mip level> to <limited mip level>'.

Identifier	Contents	Used for	Supports mipmapping
armor_trims	Contains paletted permutations of all armor trim equipment textures. This does not include the item overlays, those are defined in the items atlas.	Rendering of armor trim layers on equipment	Template:Tc
banner_patterns	Contains all banner pattern textures and the base banner texture from the entity/banner/ directory.	Rendering of banners placed in the world	Template:Tc
blocks	Contains all block textures from the block/, textures in the entity/conduit/ directory, the entity/bell/bell_body.png texture, and the entity/enchantment/enchanting_table_book.png texture.	Rendering of terrain, conduits, bells, enchanting table books (in the gui and in the world), and item models.	Template:Tc
celestials	Contains the environment/celestial/ directory. This includes the sun texture, moon phase textures, and the end flash texture.	Rendering of celestial bodies like the sun, moon, and end flashes.	Template:Tc
chests	Contains all the chest textures from the entity/chest/ directory.	Rendering of chest block entities.	Template:Tc
decorated_pot	Contains all decorated pot patterns and the base decorated pot texture from the entity/decorated_pot/ directory.	Rendering of decorated pot block entities.	Template:Tc
gui	Contains most gui sprite textures from the gui/sprites/ directory. Also contains the mob effect icons from the mob_effect/ directory. Sprites in this atlas support additional mcmeta data for gui scaling, see Minecraft:Resource_pack#GUI for more information.	Rendering of most gui widgets and icons.	Template:Tc
items	Contains all item textures from the item/ directory. Also contains paletted permutations for the armor trim item overlay textures.	Rendering of item models.	Template:Tc
map_decorations	Contains all map decoration icons from the map/decoration/ directory.	Rendering of map decoration icons.	Template:Tc
paintings	Contains all painting textures from the painting/ directory.	Rendering of paintings.	Template:Tc
particles	Contains all particle textures from the particle/ directory.	Rendering of most particles.	Template:Tc
shield_patterns	Contains all shield pattern textures and the base shield texture from the entity/shield/ directory.	Rendering of shields and shield patterns.	Template:Tc
shulker_boxes	Contains all shulker textures from the entity/shulker/ directory.	Rendering of shulker box block entities. This does not include shulker mobs.	Template:Tc