Skip to content

Commit 870732e

Browse files
committed
🚧 Add basic Variants documentation
1 parent 4e09144 commit 870732e

File tree

3 files changed

+52
-0
lines changed
  • src/routes/docs/[...4]the-blueprint-format/[...3]variants
  • static/img/steps/variants

3 files changed

+52
-0
lines changed

‎src/routes/docs/[...4]the-blueprint-format/[...3]variants/+page.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,55 @@ description: Learn what variants are and how to use them in Animated Java.
66
# {$frontmatter.title}
77

88
{$frontmatter.description}
9+
10+
## The Variants Panel
11+
12+
The Variants Panel is where you can manage the different variants of your model. You can add, remove, and edit variants here.
13+
![variants-panel](/img/steps/variants/1.png)
14+
15+
## The Default Variant
16+
17+
The Default Variant is the base model that all other variants are based on. It cannot be modified, removed, or renamed.
18+
19+
## Creating a new Variant
20+
21+
To create a variant, click the `Add Variant` button in the Variants Panel.
22+
23+
## The Variant Config
24+
25+
The Variant Config is where you can change the name and properties of the variant.
26+
27+
![add-variant-action](/img/steps/variants/2.png)
28+
29+
## Config Options
30+
31+
- ### Display Name
32+
33+
The name of the variant.
34+
35+
- ### Name
36+
37+
The ID of the variant. This is used in commands and scripts to reference the variant.
38+
39+
- ### Generate Name from Display Name
40+
41+
If enabled, the Name will be automatically generated from the Display Name.
42+
43+
- ### Texture Map
44+
45+
A map of which textures will be replaced on the model when the variant is applied.
46+
47+
- ### Included / Excluded Nodes
48+
Using the exclude / include nodes feature, you can specify which nodes will be included or excluded from the variant. Excluded nodes will not be modified when the variant is applied, even if their texture is in the texture map.
49+
50+
## Applying a Variant
51+
52+
To apply a Variant to a Rig Instance, run the `variant/apply` function as the root entity of the Rig Instance.
53+
54+
:::admonition type=info title=Example
55+
56+
```rust title="Changing the variant of a Rig Instance"
57+
execute as @e[tag=aj.<export_namespace>.root] run function animated_java:<export_namespace>/variant/apply
58+
```
59+
60+
:::

‎static/img/steps/variants/1.png

20.4 KB
Loading

‎static/img/steps/variants/2.png

89 KB
Loading

0 commit comments

Comments
 (0)