Add fabric.mod.json spec from Fabric Wiki #353
Conversation
|
|
||
| ### Mandatory fields | ||
|
|
||
| - **id**: Contains the mod identifier - a string value matching the `^[a-z][a-z0-9-_]{1,63}$` pattern. |
There was a problem hiding this comment.
Doesn't loader require mod ids are at least 3 characters?
There was a problem hiding this comment.
No. In fact, the error messages from the parsers for missing id strings are incorrect: Loader only prevents == 1 and > 64.
fabric-loader/src/main/java/net/fabricmc/loader/discovery/ModResolver.java
Lines 498 to 502 in 134386b
|
|
||
| It is recommended that the keys be namespaced with the ID of the mod relying on them (if such a mod exists) to prevent conflicts. | ||
|
|
||
| ## Version 0 |
There was a problem hiding this comment.
In my opinion v0 should have a seperate spec doc.
There was a problem hiding this comment.
Sure, this was just what asie had in the original. I'll remove this part.
| If a "schemaVersion" key is missing, assume version "0". | ||
|
|
||
| It is important to remember that the Fabric mod JSON is **authoritative**. This means that Loader relies on it specifically to gather the necessary information - from the perspective of an external tool, its contents can be trusted and relied upon. | ||
|
|
There was a problem hiding this comment.
We should probably specify the behavior with regards to duplicate k->v values in the FMJ.
The way this is right now is we use the latter field EXCEPT for the schemaVersion which we fail to parse when there are multiple instances of it.
@i509VCB That's because it's a moved page. The original page's history also shows asie and falseresync there. |
|
I see that we will need to poke asie and I think we should get them to agree to license the spec document under CC0 (and probably the same with all the spec documents in loader for future) so we can have this spec send stuff back to the wiki? That is a question I would like to have discussed. |
|
As i5 asked, I hereby grant any and all permission to do anything and everything with this spec :> |
|
@asiekierka Do you agree to licensing this spec under CC0? |
| @@ -0,0 +1,130 @@ | |||
| # fabric.mod.json | |||
|
|
|||
| In all cases, the mod JSON, `fabric.mod.json`, is defined as either an object containing a "schemaVersion" key with an integer value, denoting the version of the format. | |||
| - **entrypoints**: Contains an EntrypointContainer. If not present, assume empty object. | ||
| - **jars**: Contains an array of NestedJarEntry objects. If not present, assume empty object. |
There was a problem hiding this comment.
Link EntrypointContainer and NestedJarEntry to their respective sections in the markdown (no need to do if code blocks)
| - **authors**: Contains the direct authorship information - an array of Person values. | ||
| - **contributors**: Contains the contributor information - an array of Person values. | ||
| - **contact**: Contains the contact information for the project - a ContactInformation object. |
There was a problem hiding this comment.
Link to ContactInformation and Person.
|
@sfPlayer1 Should we include these here or just a simple readme asking people to visit fabric wiki instead? |
Almost a direct copy converted from Dokuwiki format to Markdown with Pandoc. The only content change is that I removed the mention of "an array containing such [mod definition] objects". However, I'm not sure if this file can be directly copied here license-wise?