Skip to content
This repository was archived by the owner on Jan 13, 2025. It is now read-only.

Commit 30d4751

Browse files
authored
Add a visual representation of the material set tree (#42)
* chore: enable mermaid diagrams in docs * feat: add documentation for icon set hierarchy
1 parent bfaec43 commit 30d4751

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

docs/Modpacks/Materials-and-Elements/Material-Icon-Sets.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,37 @@ GTCEuStartupEvents.registry('gtceu:material_icon_set', event => {
4848
.parent('shiny')
4949
})
5050
```
51+
52+
## Available Icon Set Hierarchy
53+
54+
Icon sets may define only a specific subset of icons.
55+
In case an icon set doesn't contain a specific icon for an item, the respective icon from its parent will be used.
56+
57+
The root icon set is `DULL`
58+
59+
```mermaid
60+
graph BT
61+
METALLIC --> DULL
62+
MAGNETIC --> METALLIC
63+
SHINY --> METALLIC
64+
BRIGHT --> SHINY
65+
DIAMOND --> SHINY
66+
EMERALD --> DIAMOND
67+
GEM_HORIZONTAL --> EMERALD
68+
GEM_VERTICAL --> EMERALD
69+
RUBY --> EMERALD
70+
OPAL --> RUBY
71+
GLASS --> RUBY
72+
NETHERSTAR --> GLASS
73+
FINE --> DULL
74+
SAND --> FINE
75+
WOOD --> FINE
76+
ROUGH --> FINE
77+
FLINT --> ROUGH
78+
LIGNITE --> ROUGH
79+
QUARTZ --> ROUGH
80+
CERTUS --> QUARTZ
81+
LAPIS --> QUARTZ
82+
FLUID --> DULL
83+
RADIOACTIVE --> METALLIC
84+
```

mkdocs.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,11 @@ markdown_extensions:
5454
- admonition
5555
- attr_list
5656
- md_in_html
57-
- pymdownx.superfences
57+
- pymdownx.superfences:
58+
custom_fences:
59+
- name: mermaid
60+
class: mermaid
61+
format: !!python/name:pymdownx.superfences.fence_code_format
5862
- pymdownx.details
5963
- pymdownx.highlight
6064
- pymdownx.inlinehilite

0 commit comments

Comments
 (0)