Atlas

It has been suggested that this article be moved to Atlas definition.
If this move affects many pages or may potentially be controversial, do not move the page until a consensus is reached.

^[discuss^{, links]}

Reason: much like other technical pages like Enchantment definition. Contrary to what the beginning sentence insists, atlases are not configuration files, they are graphic files. This page discusses how the game handles them.
When moving, be sure to use the appropriate tool instead of simply copying and pasting the page's contents, to preserve the edit history.

This feature is exclusive to Java Edition.

Atlases are configuration files in resource packs, that control which textures are included in the atlases.

JSON format

Atlases are stored as JSON files in a resource pack in the assets/<namespace>/atlases folder.

[NBT Compound / JSON Object] The root tag.
- [NBT List / JSON Array] sources: Contains a list of sprite sources. Every entry runs in during load, in order of definition, adding or removing new textures to the atlas.
  - [NBT Compound / JSON Object] Source element.
    - [String] type: The type of the sprite source. Can be one of the following:
      - directory: Lists all files in a directory and its subdirectories, across all namespaces.
        [String] source: Directory in pack to be listed (relative to textures directory).
        
        [String] prefix: String to be prefixed to the sprite name when loaded.
      - single: Adds a single file.
        [String] resource: Location of a resource within the pack (relative to textures directory, implied .png extension).
        
        [String] sprite: Sprite name (optional, defaults to the value of resource).
      - filter: Removes sprites matching the given pattern (only works for entries already in the list).
        [NBT Compound / JSON Object] pattern
        [String] namespace: Regular expression of the namespace identificator to be removed, if omitted, any value is matched.
        
        [String] path: Regular expression of the path to be removed, if omitted, any value is matched.
      - unstitch: Copies rectangular regions from other images.
        [String] resource: Location of a resource within the pack (relative to textures directory, implied .png extension).
        
        [Double] divisor_x: Used for determining the units used by in the x coordinate of regions.
        
        [Double] divisor_y: Used for determining the units used by in the y coordinate of regions.
        
        [NBT List / JSON Array] regions: List of regions to copy from the source image.
        [String] sprite: Specifies the sprite name.
        
        [Double] x: Specifies the x coordinate of the top-left corner of the region.
        
        [Double] y: Specifies the y coordinate of the top-left corner of the region.
        
        [Double] width: Specifies the width of the region.
        
        [Double] height: Specifies the height of the region.
      - paletted_permutations: Dynamically generate textures in-memory with color sets.
        [NBT List / JSON Array] textures: A list of namespaced resource locations of base textures. These textures are used to generate variants of them that have been modified by color palettes.
        
        [String] separator: A value that is used when joining texture and permutation names to produce sprite name. Defaults to _.
        
        [String] palette_key: A namespaced resource location of a color palette key file. This is used to define the set of key pixel colors to swap out with the color palettes defined.
        
        [NBT Compound / JSON Object] permutations: A map of permutations from suffix to a namespaced resource location of a color palette file. The suffix is appended to the resource location 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 palette_key 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 palette_key are copied over to the resulting texture as-is.

List of atlases

armor_trims ^{[until: JE 26.3]}
banner_patterns
blocks
celestials
chests
decorated_pot
gui
items
map_decorations
paintings
particles
shield_patterns
shulker_boxes

History

Java Edition
1.19.3	22w46a	Added atlases to resource packs.
1.19.3	23w04a	Added the sprite source `paletted_permutations`.
1.19.4	23w04a	Added the `armor_trims` atlas.
1.19.4	Pre-release 1	Added the `decorated_pot` atlas.
1.20.2	23w31a	Added the `gui` atlas.
1.20.5	24w12a	Added the `map_decorations` atlas.
1.21.5	25w04a	`minecraft:paletted_permutations` sprite source has a new field, `separator`.
1.21.6	25w19a	The `mob_effects` atlas has been removed, all sprites that were previously stitched to this atlas are instead stitched to the `gui` atlas.
1.21.11	25w41a	Added the `celestials` atlas which contains celestial bodies including the sun, moon phases, and end flash.
	25w45a	Added the `items` atlas.
	25w45a	Moved armor trim item overlay paletted permutations from the `blocks` atlas to `items`.
26.2	snap4	Removed the `beds` atlas.
26.2	snap7	Removed the `signs` atlas.
Upcoming Java Edition
26.3	snap1	Removed the `armor_trims` atlas.

Atlas

Contents

JSON format

List of atlases

History

Navigation