Skip to content

Commit

Permalink
Add a visual representation of the material set tree (#42)
Browse files Browse the repository at this point in the history
* chore: enable mermaid diagrams in docs

* feat: add documentation for icon set hierarchy
  • Loading branch information
mikerooni authored Dec 18, 2024
1 parent bfaec43 commit 30d4751
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 1 deletion.
34 changes: 34 additions & 0 deletions docs/Modpacks/Materials-and-Elements/Material-Icon-Sets.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,37 @@ GTCEuStartupEvents.registry('gtceu:material_icon_set', event => {
.parent('shiny')
})
```

## Available Icon Set Hierarchy

Icon sets may define only a specific subset of icons.
In case an icon set doesn't contain a specific icon for an item, the respective icon from its parent will be used.

The root icon set is `DULL`

```mermaid
graph BT
METALLIC --> DULL
MAGNETIC --> METALLIC
SHINY --> METALLIC
BRIGHT --> SHINY
DIAMOND --> SHINY
EMERALD --> DIAMOND
GEM_HORIZONTAL --> EMERALD
GEM_VERTICAL --> EMERALD
RUBY --> EMERALD
OPAL --> RUBY
GLASS --> RUBY
NETHERSTAR --> GLASS
FINE --> DULL
SAND --> FINE
WOOD --> FINE
ROUGH --> FINE
FLINT --> ROUGH
LIGNITE --> ROUGH
QUARTZ --> ROUGH
CERTUS --> QUARTZ
LAPIS --> QUARTZ
FLUID --> DULL
RADIOACTIVE --> METALLIC
```
6 changes: 5 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,11 @@ markdown_extensions:
- admonition
- attr_list
- md_in_html
- pymdownx.superfences
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.details
- pymdownx.highlight
- pymdownx.inlinehilite
Expand Down

0 comments on commit 30d4751

Please sign in to comment.