Simple Update Checker

The Simple Update Checker modification is a compact addon that notifies users about available updates for modpacks from the Modrinth platform directly in the game.

Main Functionality

The plugin works on both the client and server sides. Notifications about new versions appear in the logs when the game or server starts, and are then displayed in other interfaces depending on the launch type.

For the client version: update information is shown on the main screen (to the right of the modpack name and version number) and refreshes every hour after the game starts.

For the server version: notifications are displayed in the logs after server startup and sent to operators when they connect. After that, checking is performed every 12 hours until an update is found, and then repeated with increasing intervals up to 14 days: 12 hours, 1 day, 2 days, 4 days, 8 days, 14 days.

Manual checking can be performed using the /simpleupdatechecker check command with a limit of no more than once every 15 minutes.

User Settings

All checks can be disabled through the simpleupdatechecker_user.json configuration file or using the /simpleupdatechecker settings command.

Settings can be changed via the command /simpleupdatechecker settings <name> <value> or directly in the configuration. Both methods use the same parameter names. The configuration file is located at config/simpleupdatechecker_user.json and can be reloaded with the /simpleupdatechecker reload command.

{
  // Completely disables update checking
  "disable_update_checking": false,
  // Disables displaying the modpack version and update information in the main menu
  "disable_main_menu": false,
  // Disables sending update information to logs after the first version check
  "disable_logs_first_check": false,
  // Disables sending update information to logs after server startup
  "disable_logs_server_started": false,
  // Disables repeated sending of update information to logs
  "disable_logs_late": false,
  // Disables sending update information to level 4 operators upon connection
  "disable_join_ops": false
}

Settings for Modpack Creators

These parameters should only be changed by modpack creators and contain exclusively modpack-related definitions. The configuration file is located at config/simpleupdatechecker_modpack.json and can be reloaded with the /simpleupdatechecker reload command.

{
  // Project identifier on Modrinth, used for lookup
  "project_id": "some_project",
  // Version number in incremental format, preferably matching the one specified on Modrinth
  "version_id": "1.0.0",
  // (Optional, leave empty to disable) Modpack name displayed in the main menu and placeholders. Defaults to project_id
  "display_name": "My modpack!",
  // (Optional, leave empty to disable) Modpack version for display, if you want to change its appearance
  "display_version": "",
  // Allowed release types, matching those on Modrinth. By default, all are allowed, but you can remove unnecessary ones
  // Removing "beta" and "alpha" will prevent recommending updating to beta and alpha versions
  "release_type": [
    "alpha",
    "beta",
    "release"
  ],
  // Maximum (exclusive) version for matching, should use the same format as version_id / Modrinth version numbers
  // Prevents matching versions equal to or newer than the specified one as updates
  "max_exclusive_version": "",
  // Forces the update version to use the version number for display instead of the version name (top field)
  "use_version_number_for_display": true
}