Modrinth Platform

Class: ModrinthUpdateChecker

Required options

• projectIdOrSlug
  Modrinth project ID or slug.
• currentVersion
  Current plugin version to compare.

Optional options

• loaders(List<String> loaders)
  Loaders filter, for example paper, fabric, forge.
  Default: ["paper"]
• gameVersions(List<String> gameVersions)
  Minecraft versions filter, for example ["1.21.4"].
  Default: none (not sent if empty)
• includeChangelog(boolean includeChangelog)
  Include changelog payload.
  Default: false
• authToken(String authToken)
  Optional token for private/authenticated scenarios.
• timeout(Duration timeout)
  HTTP request timeout. Default: 8s.
• userAgent(String userAgent)
  Unique identifying user agent.
  Default: ez-plugins/modrinth-update-checker/1.0
• apiBaseUrl(String apiBaseUrl)
  Override API base URL.
  Default: https://api.modrinth.com/v2

Example

ModrinthUpdateChecker checker = ModrinthUpdateChecker.builder("ezplugins-ezrtp", "1.2.3")
        .loaders(java.util.List.of("paper"))
        .gameVersions(java.util.List.of("1.21.4"))
        .includeChangelog(false)
        .userAgent("ez-plugins/ezrtp-update-checker/1.0 (https://github.com/ez-plugins/EzRTP)")
        .build();