Skip to content

Commit 3166280

Browse files
authored
Update README.md
1 parent 2f7a679 commit 3166280

1 file changed

Lines changed: 32 additions & 17 deletions

File tree

README.md

Lines changed: 32 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -32,32 +32,34 @@ Here's an example of Mod Menu's translations into Pirate Speak. To create your o
3232

3333

3434

35-
### Fabric Metadata API (`fabric.mod.json`)
35+
### Fabric Metadata API
3636
There's a number of things you can add just with metadata in your `fabric.mod.json`.
3737

3838
All of these are added to a custom block in your `fabric.mod.json` for Mod Menu's metadata. Here's an example usage of many of the features this API provides:
3939

4040
`fabric.mod.json`
41-
```json
42-
"custom": {
43-
"modmenu": {
44-
"links": {
45-
"modmenu.discord": "https://discord.gg/jEGF5fb"
46-
},
47-
"badges": [ "library", "deprecated" ],
48-
"parent": {
49-
"id": "example-api",
50-
"name": "Example API",
51-
"description": "Modular example library",
52-
"icon": "assets/example-api-module-v1/parent_icon.png",
53-
"badges": [ "library" ]
54-
},
55-
"update_checker": true
41+
```json5
42+
{
43+
...
44+
"custom": {
45+
"modmenu": {
46+
"links": {
47+
"modmenu.discord": "https://discord.gg/jEGF5fb"
48+
},
49+
"badges": [ "library", "deprecated" ],
50+
"parent": {
51+
"id": "example-api",
52+
"name": "Example API",
53+
"description": "Modular example library",
54+
"icon": "assets/example-api-module-v1/parent_icon.png",
55+
"badges": [ "library" ]
56+
},
57+
"update_checker": true
58+
}
5659
}
5760
}
5861
```
5962

60-
6163
<details>
6264
<summary>Fabric Metadata API Documentation</summary>
6365

@@ -147,7 +149,20 @@ You can disable the update checker by setting `update_checker` to false in your
147149

148150
</details>
149151

152+
### Quilt Metadata API
153+
Since Mod Menu supports Quilt as well, the same APIs in the Fabric Metadata API section are also available for Quilt mods, but the format for custom metadata is slightly different.
150154

155+
Instead of a `"modmenu"` block inside of a `"custom"` block, you put the `"modmenu"` block as an element in the root object. So it should look like:
156+
157+
`quilt.mod.json`
158+
```json5
159+
{
160+
...
161+
"modmenu": {
162+
// Here's where your links, badges, etc. stuff goes
163+
}
164+
}
165+
```
151166

152167
### Java API
153168
To use the Java API, you'll need to add Mod Menu as a compile-time dependency in your gradle project. This won't make your mod require Mod Menu, but it'll be present in your environment for you to test with.

0 commit comments

Comments
 (0)