Skip to content

Commit c6c4747

Browse files
authored
update FORDEVS.md
1 parent ac5d5a7 commit c6c4747

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

FORDEVS.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Adding Additional Metadata
2+
To make **Mod Explorer** display the metadata of your mod, you need to add a `modInfo.json` file somewhere inside your project and include it with **EmbeddedResource**. The mod will try to load this file out of your project and if it finds one, will use it in the info tab.
3+
4+
### Here's an example setup
5+
![Example modInfo.json File](./Images/ForDevsExample.png)
6+
![Example File](./Images/ForDevsExample2.png)
7+
8+
# Supported Metadata Values
9+
- `Name` - Name of your mod. It's taken from **BepInEx's Plugin Metadata** if not specified
10+
- `Description` - Description of your mod
11+
- `Tags` - List of tags, used for the searchbar
12+
- `Authors` - List of authors, used for credits
13+
- `Links` - Links redirects displayed at the bottom of the info page
14+
- `Icon` - Project relative path to the icon of your mod
15+
> [!Warning]
16+
> The icon file **ALSO** needs to be embedded into the project, otherwise it cannot be loaded

0 commit comments

Comments
 (0)