Skip to content

Commit c5da3b4

Browse files
authored
Merge pull request #492 from meFroggy/feature/add-mod-icon-doc
GH-492 feat: Created an add mod icon document
2 parents 3ba11f9 + b64eb29 commit c5da3b4

3 files changed

Lines changed: 31 additions & 0 deletions

File tree

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: "Add a Custom Mod Icon"
3+
description: "Learn how to add your mod icon to the World Mod Settings tab."
4+
authors:
5+
- name: "Siren"
6+
url: "https://www.mermaids.dev/"
7+
---
8+
import { File, Folder, Files } from 'fumadocs-ui/components/files';
9+
10+
# Overview
11+
12+
This guide explains how to add a mod icon to your mod inside the World Mod Settings tab, as shown in the image below.
13+
![mod icon in mod settings tab png](/assets/guides/mod-icon-show.png)
14+
15+
## Steps
16+
17+
1. Prepare your mod icon. If you don’t already have one, you’ll need to create it.
18+
2. Resize your mod icon to 256x256 and save the new PNG file as `icon-256.png`.
19+
3. Move the `icon-256.png` file to your mod's resources folder.
20+
21+
<Files>
22+
<Folder name="resources" defaultOpen>
23+
<File name="icon-256.png" />
24+
</Folder>
25+
</Files>
26+
27+
| File | Location | File Resolution |
28+
| -------- | ------- | ----------- |
29+
| icon-256.png | resources/ | 256x256 |
30+
31+
![mod icon png inside folder](/assets/guides/mod-icon-infolder.png)
17.7 KB
Loading
74 KB
Loading

0 commit comments

Comments
 (0)