Skip to content

Mapping config documentation

roidrole edited this page Jun 3, 2025 · 4 revisions

The config file for mappings is located at config/patternbanners/mappings.cfg It contains all the information required for making the pattern items. Editing it is fairly complicated and can lead to issues, but I figured I would document it if people want to do it.

Each mapping is of the form

[int] : {
    param1=value
    param2=value
    ...
}

The int at the front should be unique and, if not using uses, equal to the meta parameter

Here is the list of parameters :

  • hash : the hash of the pattern. It is put in the NBT of items to know which pattern texture to apply
  • meta : the metadata/damage value of the item associated to the pattern
  • name : the name of the pattern. Is used for localization (item.banner.[name].[color]), texture (assets/minecraft/textures/entity/[banner|shield]/name.png, and pattern item model (assets/patternbanners/models/item/pattern/[name].json). This parameter is not needed on dedicated servers

You also need to add one of the following if you want the pattern to be usable :

  • shap : the shape of the craft in left-right, top-down order, prefixed and suffixed by .. Should contain 9 characters. represent empty spaces, # represent dyes. Example : .# ## # .
  • item : the item used to craft the pattern item, in modid:name:damage format. Note that :damage is optional, and will default to 0
  • uses : the item used to apply the pattern, in modid:name:damage format. If this option is present, no default pattern item will be generated. This makes the meta parameter unused

Clone this wiki locally