manifestSchema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/ReviversMC/the-mod-index/blob/v3/schema/manifestSchema.json",
  "title": "Manifest Schema",
  "description": "The file for each of a mod per its loader",
  "type": "object",
  "properties": {
    "indexVersion": {
      "type": "string",
      "description": "The semver version of the targeted index.",
      "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$"
    },
    "genericIdentifier": {
      "type": "string",
      "description": "The fancy name of the mod.",
      "pattern": "^[a-z0-9\\-_]+:[a-z0-9\\-_]+$"
    },
    "fancyName": {
      "type": "string",
      "description": "The fancy name of the mod.",
      "pattern": "^[a-zA-Z0-9\\-_\\s]+$"
    },
    "author": {
      "type": "string",
      "description": "The author of the mod.",
      "pattern": "^[a-zA-Z0-9\\-_\\s]+$"
    },
    "license": {
      "type": [
        "string",
        null
      ],
      "description": "The license of the mod, or url if not a standard license.",
      "pattern": "^[a-zA-Z0-9\\-_\\s]+$"
    },
    "curseForgeId": {
      "type": [
        "integer",
        null
      ],
      "description": "The curseforge id of the mod."
    },
    "modrinthId": {
      "type": [
        "string",
        null
      ],
      "description": "The modrinth id of the mod.",
      "pattern": "^[a-zA-Z0-9]+$"
    },
    "links": {
      "type": "object",
      "description": "The external links a mod has.",
      "properties": {
        "issue": {
          "type": [
            "string",
            null
          ],
          "description": "The issue tracker link.",
          "pattern": "^[a-zA-Z0-9\\-_:/?&]+$"
        },
        "sourceControl": {
          "type": [
            "string",
            null
          ],
          "description": "The source control link.",
          "pattern": "^[a-zA-Z0-9\\-_:/?&]+$"
        },
        "others": {
          "type": "array",
          "description": "Other links.",
          "items": {
            "type": "object",
            "properties": {
              "linkName": {
                "type": "string",
                "description": "The type of link, like \"discord\", \"irc\", or \"GitHub wiki\"",
                "pattern": "^[a-zA-Z0-9\\-_\\s]+$"
              },
              "url": {
                "type": "string",
                "description": "The url of the link.",
                "pattern": "^[a-zA-Z0-9\\-_:/?&]+$"
              }
            },
            "required": [
              "linkName",
              "url"
            ]
          }
        }
      },
      "required": [
        "issue",
        "sourceControl",
        "others"
      ]
    },
    "files": {
      "type": "array",
      "description": "The files the mod has.",
      "items": {
        "type": "object",
        "properties": {
          "fileName": {
            "type": "string",
            "description": "The name of the file.",
            "pattern": "^[a-zA-Z0-9\\-_\\s]+$"
          },
          "mcVersions": {
            "type": "array",
            "description": "The minecraft versions the file is compatible with. Do not include mod loaders.",
            "items": {
              "type": "string",
              "description": "The minecraft version. Does not include mod loaders.",
              "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+[a-zA-Z0-9\\-+._\\s]*$"
            }
          },
          "shortSha512Hash": {
            "type": "string",
            "description": "The short sha512 hash of the file, consisting of only 15 characters",
            "pattern": "^[a-z0-9]{15}$"
          },
          "downloadUrls": {
            "type": "array",
            "description": "The download urls of the file.",
            "items": {
              "type": "string",
              "description": "The download url of the file.",
              "pattern": "^[a-zA-Z0-9\\-_:\/?&]+$"
            }
          },
          "curseDownloadAvailable": {
            "type": "boolean",
            "description": "Whether the file is available on curseforge."
          },
          "relationsToOtherMods": {
            "type": "object",
            "description": "The relations (i.e. dependencies/conflicts) of the file.",
            "properties": {
              "required": {
                "type": "array",
                "description": "The other mods that this mod requires to run (i.e. dependencies).",
                "items": {
                  "type": "string",
                  "description": "The generic identifier of the required mod.",
                  "pattern": "^[a-z0-9\\-_]+:[a-z0-9\\-_]+$"
                }
              },
              "incompatible": {
                "type": "array",
                "description": "The other mods that this mod is incompatible with (i.e. conflicts).",
                "items": {
                  "type": "string",
                  "description": "The generic identifier of the incompatible mod.",
                  "pattern": "^[a-z0-9\\-_]+:[a-z0-9\\-_]+$"
                }
              }
            },
            "required": [
              "required",
              "incompatible"
            ]
          }
        },
        "required": [
          "fileName",
          "mcVersions",
          "shortSha512Hash",
          "downloadUrls",
          "curseDownloadAvailable",
          "relationsToOtherMods"
        ]
      }
    },
    "overrides": {
      "type": "object",
      "description": "The manual overrides the mod has. Mostly for the maintainer's internal use",
      "properties": {
        "genericIdentifier": {
          "type": "string",
          "description": "The fancy name of the mod.",
          "pattern": "^[a-z0-9\\-_]+:[a-z0-9\\-_]+$"
        },
        "fancyName": {
          "type": "string",
          "description": "The fancy name of the mod.",
          "pattern": "^[a-zA-Z0-9\\-_\\s]+$"
        },
        "author": {
          "type": "string",
          "description": "The author of the mod.",
          "pattern": "^[a-zA-Z0-9\\-_\\s]+$"
        },
        "license": {
          "type": [
            "string",
            null
          ],
          "description": "The license of the mod, or url if not a standard license.",
          "pattern": "^[a-zA-Z0-9\\-_\\s]+$"
        },
        "curseForgeId": {
          "type": [
            "integer",
            null
          ],
          "description": "The curseforge id of the mod."
        },
        "modrinthId": {
          "type": [
            "string",
            null
          ],
          "description": "The modrinth id of the mod.",
          "pattern": "^[a-zA-Z0-9]+$"
        },
        "links": {
          "type": "object",
          "description": "The external links a mod has.",
          "properties": {
            "issue": {
              "type": [
                "string",
                null
              ],
              "description": "The issue tracker link.",
              "pattern": "^[a-zA-Z0-9\\-_:/?&]+$"
            },
            "sourceControl": {
              "type": [
                "string",
                null
              ],
              "description": "The source control link.",
              "pattern": "^[a-zA-Z0-9\\-_:/?&]+$"
            },
            "others": {
              "type": "object",
              "description": "Other links to override",
              "properties": {
                "add": {
                  "type": "object",
                  "description": "The links to add.",
                  "properties": {
                    "linkName": {
                      "type": "string",
                      "description": "The type of link, like \"discord\", \"irc\", or \"GitHub wiki\"",
                      "pattern": "^[a-zA-Z0-9\\-_\\s]+$"
                    },
                    "url": {
                      "type": "string",
                      "description": "The url of the link.",
                      "pattern": "^[a-zA-Z0-9\\-_:/?&]+$"
                    }
                  },
                  "required": [
                    "linkName",
                    "url"
                  ]
                },
                "remove": {
                  "type": "array",
                  "description": "The links to remove.",
                  "items": {
                    "type": "string",
                    "description": "The type of link to remove, like \"discord\", \"irc\", or \"GitHub wiki\"",
                    "pattern": "^[a-zA-Z0-9\\-_\\s]+$"
                  }
                },
                "replace": {
                  "type": "object",
                  "description": "The links to replace.",
                  "properties": {
                    "linkName": {
                      "type": "string",
                      "description": "The type of link, like \"discord\", \"irc\", or \"GitHub wiki\"",
                      "pattern": "^[a-zA-Z0-9\\-_\\s]+$"
                    },
                    "url": {
                      "type": "string",
                      "description": "The url of the link.",
                      "pattern": "^[a-zA-Z0-9\\-_:/?&]+$"
                    }
                  },
                  "required": [
                    "linkName",
                    "url"
                  ]
                }
              }
            }
          }
        },
        "files": {
          "type": "object",
          "description": "The overrides for the files of the mod.",
          "properties": {
            "add": {
              "type": "array",
              "description": "The files to add for the mod.",
              "items": {
                "type": "object",
                "properties": {
                  "fileName": {
                    "type": "string",
                    "description": "The name of the file.",
                    "pattern": "^[a-zA-Z0-9\\-_\\s]+$"
                  },
                  "mcVersions": {
                    "type": "object",
                    "description": "The minecraft versions the file is compatible with.",
                    "properties": {
                      "add": {
                        "type": "array",
                        "description": "The mc versions to add.",
                        "items": {
                          "type": "string",
                          "description": "The minecraft version. Does not include mod loaders.",
                          "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+[a-zA-Z0-9\\-+._\\s]*$"
                        }
                      },
                      "remove": {
                        "type": "array",
                        "description": "The mc versions to remove.",
                        "items": {
                          "type": "string",
                          "description": "The minecraft version. Does not include mod loaders.",
                          "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+[a-zA-Z0-9\\-+._\\s]*$"
                        }
                      },
                      "replace": {
                        "type": "array",
                        "description": "The mc versions to replace.",
                        "items": {
                          "type": "string",
                          "description": "The minecraft version. Does not include mod loaders.",
                          "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+[a-zA-Z0-9\\-+._\\s]*$"
                        }
                      }
                    }
                  },
                  "shortSha512Hash": {
                    "type": "string",
                    "description": "The short sha512 hash of the file, consisting of only 15 characters",
                    "pattern": "^[a-z0-9]{15}$"
                  },
                  "downloadUrls": {
                    "type": "object",
                    "description": "The download urls of the file.",
                    "properties": {
                      "add": {
                        "type": "array",
                        "description": "The download urls to add.",
                        "items": {
                          "type": "string",
                          "description": "The download url of the file.",
                          "pattern": "^[a-zA-Z0-9\\-_:/?&]+$"
                        }
                      },
                      "remove": {
                        "type": "array",
                        "description": "The download urls to remove.",
                        "items": {
                          "type": "string",
                          "description": "The download url of the file.",
                          "pattern": "^[a-zA-Z0-9\\-_:/?&]+$"
                        }
                      },
                      "replace": {
                        "type": "array",
                        "description": "The download urls to replace.",
                        "items": {
                          "type": "string",
                          "description": "The download url of the file.",
                          "pattern": "^[a-zA-Z0-9\\-_:/?&]+$"
                        }
                      }
                    }
                  },
                  "curseDownloadAvailable": {
                    "type": "boolean",
                    "description": "Whether the file is available on curseforge."
                  },
                  "relationsToOtherMods": {
                    "type": "object",
                    "description": "The relations (i.e. dependencies/conflicts) of the file.",
                    "properties": {
                      "add": {
                        "type": "object",
                        "description": "The relations to add.",
                        "properties": {
                          "required": {
                            "type": "array",
                            "description": "The other mods that this mod requires to run (i.e. dependencies).",
                            "items": {
                              "type": "string",
                              "description": "The generic identifier of the required mod.",
                              "pattern": "^[a-z0-9\\-_]+:[a-z0-9\\-_]+$"
                            }
                          },
                          "incompatible": {
                            "type": "array",
                            "description": "The other mods that this mod is incompatible with (i.e. conflicts).",
                            "items": {
                              "type": "string",
                              "description": "The generic identifier of the incompatible mod.",
                              "pattern": "^[a-z0-9\\-_]+:[a-z0-9\\-_]+$"
                            }
                          }
                        }
                      },
                      "remove": {
                        "type": "object",
                        "description": "The relations to remove.",
                        "properties": {
                          "required": {
                            "type": "array",
                            "description": "The other mods that this mod requires to run (i.e. dependencies).",
                            "items": {
                              "type": "string",
                              "description": "The generic identifier of the required mod.",
                              "pattern": "^[a-z0-9\\-_]+:[a-z0-9\\-_]+$"
                            }
                          },
                          "incompatible": {
                            "type": "array",
                            "description": "The other mods that this mod is incompatible with (i.e. conflicts).",
                            "items": {
                              "type": "string",
                              "description": "The generic identifier of the incompatible mod.",
                              "pattern": "^[a-z0-9\\-_]+:[a-z0-9\\-_]+$"
                            }
                          }
                        }
                      },
                      "replace": {
                        "type": "object",
                        "description": "The relations to replace.",
                        "properties": {
                          "required": {
                            "type": "array",
                            "description": "The other mods that this mod requires to run (i.e. dependencies).",
                            "items": {
                              "type": "string",
                              "description": "The generic identifier of the required mod.",
                              "pattern": "^[a-z0-9\\-_]+:[a-z0-9\\-_]+$"
                            }
                          },
                          "incompatible": {
                            "type": "array",
                            "description": "The other mods that this mod is incompatible with (i.e. conflicts).",
                            "items": {
                              "type": "string",
                              "description": "The generic identifier of the incompatible mod.",
                              "pattern": "^[a-z0-9\\-_]+:[a-z0-9\\-_]+$"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "required": [
                  "fileName",
                  "mcVersions",
                  "shortSha512Hash",
                  "downloadUrls",
                  "curseDownloadAvailable",
                  "relationsToOtherMods"
                ]
              }
            },
            "remove": {
              "type": "array",
              "description": "The files to remove.",
              "items": {
                "shortSha512Hash": {
                  "type": "string",
                  "description": "The short sha512 hash of the file, consisting of only 15 characters",
                  "pattern": "^[a-z0-9]{15}$"
                }
              }
            },
            "replace": {
              "type": "array",
              "description": "The files to use instead of the original files generated",
              "items": {
                "type": "object",
                "properties": {
                  "fileName": {
                    "type": "string",
                    "description": "The name of the file.",
                    "pattern": "^[a-zA-Z0-9\\-_\\s]+$"
                  },
                  "mcVersions": {
                    "type": "object",
                    "description": "The minecraft versions the file is compatible with.",
                    "properties": {
                      "add": {
                        "type": "array",
                        "description": "The mc versions to add.",
                        "items": {
                          "type": "string",
                          "description": "The minecraft version. Does not include mod loaders.",
                          "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+[a-zA-Z0-9\\-+._\\s]*$"
                        }
                      },
                      "remove": {
                        "type": "array",
                        "description": "The mc versions to remove.",
                        "items": {
                          "type": "string",
                          "description": "The minecraft version. Does not include mod loaders.",
                          "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+[a-zA-Z0-9\\-+._\\s]*$"
                        }
                      },
                      "replace": {
                        "type": "array",
                        "description": "The mc versions to replace.",
                        "items": {
                          "type": "string",
                          "description": "The minecraft version. Does not include mod loaders.",
                          "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+[a-zA-Z0-9\\-+._\\s]*$"
                        }
                      }
                    }
                  },
                  "shortSha512Hash": {
                    "type": "string",
                    "description": "The short sha512 hash of the file, consisting of only 15 characters",
                    "pattern": "^[a-z0-9]{15}$"
                  },
                  "downloadUrls": {
                    "type": "object",
                    "description": "The download urls of the file.",
                    "properties": {
                      "add": {
                        "type": "array",
                        "description": "The download urls to add.",
                        "items": {
                          "type": "string",
                          "description": "The download url of the file.",
                          "pattern": "^[a-zA-Z0-9\\-_:/?&]+$"
                        }
                      },
                      "remove": {
                        "type": "array",
                        "description": "The download urls to remove.",
                        "items": {
                          "type": "string",
                          "description": "The download url of the file.",
                          "pattern": "^[a-zA-Z0-9\\-_:/?&]+$"
                        }
                      },
                      "replace": {
                        "type": "array",
                        "description": "The download urls to replace.",
                        "items": {
                          "type": "string",
                          "description": "The download url of the file.",
                          "pattern": "^[a-zA-Z0-9\\-_:/?&]+$"
                        }
                      }
                    }
                  },
                  "curseDownloadAvailable": {
                    "type": "boolean",
                    "description": "Whether the file is available on curseforge."
                  },
                  "relationsToOtherMods": {
                    "type": "object",
                    "description": "The relations (i.e. dependencies/conflicts) of the file.",
                    "properties": {
                      "add": {
                        "type": "object",
                        "description": "The relations to add.",
                        "properties": {
                          "required": {
                            "type": "array",
                            "description": "The other mods that this mod requires to run (i.e. dependencies).",
                            "items": {
                              "type": "string",
                              "description": "The generic identifier of the required mod.",
                              "pattern": "^[a-z0-9\\-_]+:[a-z0-9\\-_]+$"
                            }
                          },
                          "incompatible": {
                            "type": "array",
                            "description": "The other mods that this mod is incompatible with (i.e. conflicts).",
                            "items": {
                              "type": "string",
                              "description": "The generic identifier of the incompatible mod.",
                              "pattern": "^[a-z0-9\\-_]+:[a-z0-9\\-_]+$"
                            }
                          }
                        }
                      },
                      "remove": {
                        "type": "object",
                        "description": "The relations to remove.",
                        "properties": {
                          "required": {
                            "type": "array",
                            "description": "The other mods that this mod requires to run (i.e. dependencies).",
                            "items": {
                              "type": "string",
                              "description": "The generic identifier of the required mod.",
                              "pattern": "^[a-z0-9\\-_]+:[a-z0-9\\-_]+$"
                            }
                          },
                          "incompatible": {
                            "type": "array",
                            "description": "The other mods that this mod is incompatible with (i.e. conflicts).",
                            "items": {
                              "type": "string",
                              "description": "The generic identifier of the incompatible mod.",
                              "pattern": "^[a-z0-9\\-_]+:[a-z0-9\\-_]+$"
                            }
                          }
                        }
                      },
                      "replace": {
                        "type": "object",
                        "description": "The relations to replace.",
                        "properties": {
                          "required": {
                            "type": "array",
                            "description": "The other mods that this mod requires to run (i.e. dependencies).",
                            "items": {
                              "type": "string",
                              "description": "The generic identifier of the required mod.",
                              "pattern": "^[a-z0-9\\-_]+:[a-z0-9\\-_]+$"
                            }
                          },
                          "incompatible": {
                            "type": "array",
                            "description": "The other mods that this mod is incompatible with (i.e. conflicts).",
                            "items": {
                              "type": "string",
                              "description": "The generic identifier of the incompatible mod.",
                              "pattern": "^[a-z0-9\\-_]+:[a-z0-9\\-_]+$"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "required": [
                  "fileName",
                  "mcVersions",
                  "shortSha512Hash",
                  "downloadUrls",
                  "curseDownloadAvailable",
                  "relationsToOtherMods"
                ]
              }
            }
          }
        }
      }
    }
  },
  "required": [
    "name",
    "description",
    "version",
    "authors",
    "curseForgeId",
    "modrinthId",
    "links",
    "files"
  ]
}