Firmament/docs/Texture Pack Format.md

Custom SkyBlock Items Texture Pack Format

Items by internal id (ExtraAttributes)

Find the internal id of the item. This is usually stored in the ExtraAttributes tag (Check the Power User Config for keybinds). Once you found it, create an item model in a resource pack like you would for a vanilla item model, but at the coordinate firmskyblock:<internalid>. So for an aspect of the end, this would be firmskyblock:models/item/aspect_of_the_end.json (or assets/firmskyblock/models/item/aspect_of_the_end.json). Then, just use a normal minecraft item model. See https://github.com/romangraef/BadSkyblockTP/blob/master/assets/firmskyblock/models/item/magma_rod.json as an example.

(Placed) Skulls by texture id

Find the texture id of a skull. This is the hash part of an url like https://textures.minecraft.net/texture/bc8ea1f51f253ff5142ca11ae45193a4ad8c3ab5e9c6eec8ba7a4fcb7bac40 (so after the /texture/). You can find it in game for placed skulls using the keybinding in the Power User Config. Then place the replacement texture at firmskyblock:textures/placedskulls/<thathash>.png. Keep in mind that you will probably replace the texture with another skin texture, meaning that skin texture has it's own hash. Do not mix those up, you need to use the hash of the old skin.

Predicates

Firmament adds the ability for more complex item model predicates. Those predicates work on any model, including models for vanilla items, but they don't mix very well with vanilla model overrides. Vanilla predicates only ever get parsed at the top level, so including a vanilla predicate inside of a more complex firmament parser will result in an ignored predicate.

Example usage

{
    "parent": "minecraft:item/handheld",
    "textures": {
        "layer0": "firmskyblock:item/bat_wand"
    },
    "overrides": [
        {
            "predicate": {
                "firmament:display_name": {
                    "regex": ".*§d.*",
                    "color": "preserve"
                }
            },
            "model": "firmskyblock:item/recombobulated_bat_wand"
        }
    ]
}

You specify an override like normally, with a model that will replace the current model and a list of predicates that must match before that override takes place.

At the top level predicate you can still use all the normal vanilla predicates, as well as the custom ones, which are all prefixed with firmament:.

Display Name

Matches the display name against a string matcher

"firmament:display_name": "Display Name Test"

Lore

Tries to find at least one lore line that matches the given string matcher.

"firmament:lore": {
  "regex": "Mode: Red Mushrooms",
  "color": "strip"
}

Logic Operators

Logic operators allow to combine other firmament predicates into one. This is done by building boolean operators:

"firmament:any": [
  {
    "firmament:display_name": "SkyBlock Menu (Click)"
  },
  {
    "firmament:display_name": "SkyBlock",
    "firmament:lore": "Some Lore Requirement"
  }    
]

This firmament:any test if the display name is either "SkyBlock Menu (Click)" or "SkyBlock" (aka any of the child predicates match).

Similarly, there is firmament:all, which requires all of its children to match.

There is also firmament:not, which requires none of its children to match. Unlike any or all, however, not only takes in one predicate {} directly, not an array of predicates [{}].

Note also that by default all predicate dictionaries require all predicates in it to match, so you can imagine that all things are wrapped in an implicit firmament:all element.

String Matcher

A string matcher allows you to match almost any string. Whenever a string matcher is expected, you can use any of these styles of creating one.

Direct

"firmament:display_name": "Test"

Directly specifying a raw string value expects the string to be exactly equal, after removing all formatting codes.

Complex

A complex string matcher allows you to specify whether the string will get its color codes removed or not before matching

"firmament:display_name": {
  "color": "strip",
  "color": "preserve", 
  // When omitting the color property alltogether, you will fall back to "strip"
}

In that same object you can then also specify how the string will be matched using another property. You can only ever specify one of these other matchers and one color preserving property.

"firmament:display_name": {
  "color": "strip",
  // You can use a "regex" property to use a java.util.Pattern regex. It will try to match the entire string.
  "regex": "So[me] Regex",
  // You can use an "equals" property to test if the entire string is equal to some value. 
  // Equals is faster than regex, but also more limited.  
  "equals": "Some Text"    
}