Skip to content

Commit fd344f7

Browse files
committed
new icon set documentation
1 parent 90187ca commit fd344f7

1 file changed

Lines changed: 67 additions & 0 deletions

File tree

docs/en/tools/waypoint-icons.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,70 @@ my-waypoint-icons.zip
5959
│ │ portal.png
6060
└───pack.mcmeta
6161
```
62+
63+
## **Custom icon sets**
64+
65+
Icons placed directly in `textures/waypoint/icon/` appear in the
66+
**JourneyMap** set. To ship your icons as their own named set, put them in a
67+
**subfolder**:
68+
69+
```text
70+
assets/journeymap/textures/waypoint/icon/<set>/<name>.png
71+
```
72+
73+
Each subfolder becomes its own tab in the icon picker's "Icon Sets" panel. The
74+
subfolder name (`<set>`) is the set's identifier.
75+
76+
### Naming the set
77+
78+
By default the tab is labelled with the raw subfolder name. To give it a
79+
friendly, localizable name, add this translation key to your resource pack's
80+
language files:
81+
82+
```text
83+
waypoint.iconset.<set>.name
84+
```
85+
86+
For example, a `houses` subfolder:
87+
88+
`assets/journeymap/lang/en_us.json`:
89+
90+
```json
91+
{
92+
"waypoint.iconset.houses.name": "Cool Houses"
93+
}
94+
```
95+
96+
`assets/journeymap/lang/es_es.json`:
97+
98+
```json
99+
{
100+
"waypoint.iconset.houses.name": "Casas Geniales"
101+
}
102+
```
103+
104+
The key is optional. Without it, the tab shows the subfolder name (`houses`).
105+
106+
### Folder layout
107+
108+
```text
109+
my-waypoint-icons.zip
110+
└───assets
111+
│ └───journeymap
112+
│ ├───lang
113+
│ │ │ en_us.json
114+
│ │ │ es_es.json
115+
│ └───textures
116+
│ └───waypoint
117+
│ └───icon
118+
│ │ castle.png (JourneyMap set)
119+
│ │ portal.png (JourneyMap set)
120+
│ └───houses
121+
│ │ cabin.png (Cool Houses set)
122+
│ │ manor.png (Cool Houses set)
123+
└───pack.mcmeta
124+
```
125+
126+
Icons in a set placed under the `journeymap` namespace (the path shown above)
127+
are tinted by the waypoint color, like JourneyMap's built-in icons. Use 16x16
128+
transparent PNG files, as for the JourneyMap set.

0 commit comments

Comments
 (0)