1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
<!--
SPDX-FileCopyrightText: 2023 Linnea Gräf <nea@nea.moe>
SPDX-License-Identifier: CC0-1.0
-->
# 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](https://minecraft.wiki/w/Tutorials/Models#Item_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
```json
{
"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 `predicate`s
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](#string-matcher)
```json
"firmament:display_name": "Display Name Test"
```
#### Lore
Tries to find at least one lore line that matches the given [string matcher](#string-matcher).
```json
"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:
```json5
"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
```json
"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
```json5
"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.
```json5
"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"
}
```
## Armor textures
You can re-*texture* armors, but not re-*model* them with firmament.
To do so, simply place the layer 1 and layer 2 armor
texture files at `assets/firmskyblock/textures/models/armor/{skyblock_id}_layer_1.png` and
`assets/firmskyblock/textures/models/armor/{skyblock_id}_layer_2.png` respectively.
If you want to re-texture a leather
armor you can use `assets/firmskyblock/textures/models/armor/{skyblock_id}_layer_1_overlay.png` and
`assets/firmskyblock/textures/models/armor/{skyblock_id}_layer_2_overlay.png` instead. Doing this will cancel out the
regular leather colors. If you want the leather colors to be applied, supply the normal non-`_overlay` variant, and
also supply a blank `_overlay` variant. You can also put non-color-affected parts into the `_overlay` variant.
|
