Fix docs format
[no changelog]
This commit is contained in:
@@ -12,8 +12,7 @@ Find the internal id of the item. This is usually stored in the ExtraAttributes
|
|||||||
keybinds). Once you found it, create an item model in a resource pack like you would 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
|
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,
|
`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.
|
just use a normal minecraft item model. See https://github.com/romangraef/BadSkyblockTP/blob/master/assets/firmskyblock/models/item/magma_rod.json
|
||||||
See https://github.com/romangraef/BadSkyblockTP/blob/master/assets/firmskyblock/models/item/magma_rod.json
|
|
||||||
as an example.
|
as an example.
|
||||||
|
|
||||||
## (Placed) Skulls by texture id
|
## (Placed) Skulls by texture id
|
||||||
@@ -37,17 +36,14 @@ head model.
|
|||||||
"textures": {
|
"textures": {
|
||||||
"layer0": "firmskyblock:item/regular_texture"
|
"layer0": "firmskyblock:item/regular_texture"
|
||||||
},
|
},
|
||||||
"firmament:head_model": "minecraft:block/diamond_block"
|
"firmament:head_model": "minecraft:block/diamond_block" // when wearing on the head render a diamond block instead (can be any item model, including custom ones)
|
||||||
// when wearing on the head render a diamond block instead (can be any item model, including custom ones)
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Predicates
|
## Predicates
|
||||||
|
|
||||||
Firmament adds the ability for more
|
Firmament adds the ability for more complex [item model predicates](https://minecraft.wiki/w/Tutorials/Models#Item_predicates).
|
||||||
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.
|
||||||
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
|
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.
|
firmament parser will result in an ignored predicate.
|
||||||
|
|
||||||
@@ -159,6 +155,7 @@ further filter by level and some other pet info.
|
|||||||
|
|
||||||
Every part of this matcher is optional.
|
Every part of this matcher is optional.
|
||||||
|
|
||||||
|
|
||||||
#### Logic Operators
|
#### Logic Operators
|
||||||
|
|
||||||
Logic operators allow to combine other firmament predicates into one. This is done by building boolean operators:
|
Logic operators allow to combine other firmament predicates into one. This is done by building boolean operators:
|
||||||
@@ -175,8 +172,7 @@ Logic operators allow to combine other firmament predicates into one. This is do
|
|||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
This `firmament:any` test if the display name is either "SkyBlock Menu (Click)" or "SkyBlock" (aka any of the child
|
This `firmament:any` test if the display name is either "SkyBlock Menu (Click)" or "SkyBlock" (aka any of the child predicates match).
|
||||||
predicates match).
|
|
||||||
|
|
||||||
Similarly, there is `firmament:all`, which requires all of its children to match.
|
Similarly, there is `firmament:all`, which requires all of its children to match.
|
||||||
|
|
||||||
@@ -201,8 +197,8 @@ Directly specifying a raw string value expects the string to be *exactly* equal,
|
|||||||
|
|
||||||
#### Complex
|
#### Complex
|
||||||
|
|
||||||
A complex string matcher allows you to specify whether the string will get its color codes removed or not before
|
A complex string matcher allows you to specify whether the string will get its color codes removed or not before matching
|
||||||
matching
|
|
||||||
|
|
||||||
```json5
|
```json5
|
||||||
"firmament:display_name": {
|
"firmament:display_name": {
|
||||||
@@ -211,7 +207,6 @@ matching
|
|||||||
// When omitting the color property alltogether, you will fall back to "strip"
|
// 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
|
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.
|
specify one of these other matchers and one color preserving property.
|
||||||
|
|
||||||
@@ -233,7 +228,6 @@ This matches a number against either a range or a specific number.
|
|||||||
#### Direct number
|
#### Direct number
|
||||||
|
|
||||||
You can directly specify a number using that value directly:
|
You can directly specify a number using that value directly:
|
||||||
|
|
||||||
```json5
|
```json5
|
||||||
"firmament:pet": {
|
"firmament:pet": {
|
||||||
"level": 100
|
"level": 100
|
||||||
@@ -246,6 +240,7 @@ This is best for whole numbers, since decimal numbers can be really close togeth
|
|||||||
|
|
||||||
For ranges you can instead use an interval. This uses the standard mathematical notation for those as a string:
|
For ranges you can instead use an interval. This uses the standard mathematical notation for those as a string:
|
||||||
|
|
||||||
|
|
||||||
```json5
|
```json5
|
||||||
"firmament:pet": {
|
"firmament:pet": {
|
||||||
"level": "(50,100]"
|
"level": "(50,100]"
|
||||||
@@ -308,8 +303,7 @@ Or as a range:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Min and max are both optional, but you need to specify at least one. By default `min` is inclusive and `max` is
|
Min and max are both optional, but you need to specify at least one. By default `min` is inclusive and `max` is exclusive.
|
||||||
exclusive.
|
|
||||||
You can override that like so:
|
You can override that like so:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@@ -321,6 +315,7 @@ You can override that like so:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
> [!WARNING]
|
> [!WARNING]
|
||||||
> This syntax for numbers is *just* for **NBT values**. This is also why specifying the type of the number is necessary.
|
> This syntax for numbers is *just* for **NBT values**. This is also why specifying the type of the number is necessary.
|
||||||
> For other number matchers, use [the number matchers](#number-matchers)
|
> For other number matchers, use [the number matchers](#number-matchers)
|
||||||
@@ -335,7 +330,7 @@ To retexture a piece of armor place a json file at `assets/firmskyblock/override
|
|||||||
{
|
{
|
||||||
"item_ids": [
|
"item_ids": [
|
||||||
"TARANTULA_BOOTS",
|
"TARANTULA_BOOTS",
|
||||||
"TARANTULA_LEGGINGS"
|
"TARANTULA_LEGGINGS",
|
||||||
// ETC
|
// ETC
|
||||||
],
|
],
|
||||||
"layers": [
|
"layers": [
|
||||||
@@ -395,7 +390,7 @@ Firmament predicates will work. You will also just directly specify new layers i
|
|||||||
{
|
{
|
||||||
"item_ids": [
|
"item_ids": [
|
||||||
"TARANTULA_BOOTS",
|
"TARANTULA_BOOTS",
|
||||||
"TARANTULA_LEGGINGS"
|
"TARANTULA_LEGGINGS",
|
||||||
// ETC
|
// ETC
|
||||||
],
|
],
|
||||||
"layers": [
|
"layers": [
|
||||||
|
|||||||
Reference in New Issue
Block a user