Repository navigation
Update Checker
This page explains how the LederProtections update checker works.
LederProtections includes a simple Modrinth-based update checker that can notify server administrators when a newer version is available.
The update checker compares the installed LederProtections version with the latest version published on Modrinth.
It can notify:
- the server console;
- administrators when they join the server;
-
/lep versionoutput.
The update checker is informational only.
It does not download, install, replace or modify plugin files automatically.
| Feature | Supported |
|---|---|
| Checks Modrinth for newer versions | Yes |
| Shows update status in console | Yes |
Shows update status in /lep version
|
Yes |
| Notifies administrators on join | Yes |
| Downloads updates automatically | No |
| Installs updates automatically | No |
| Replaces plugin files | No |
| Modifies server files | No |
The update checker is configured in:
plugins/LederProtections/config.yml
Default configuration:
update-checker:
enabled: true
check-on-startup: true
notify-admins-on-join: true| Option | Description |
|---|---|
enabled |
Enables or disables the update checker. |
check-on-startup |
Checks for updates when the server starts. |
notify-admins-on-join |
Notifies administrators when they join if a newer version is available. |
The update source is handled internally by the plugin.
Server owners do not need to configure a custom update URL.
If startup checks are enabled, LederProtections checks Modrinth after the plugin starts.
When the plugin is up to date, the console may show a message similar to:
[LederProtections] Update checker: LederProtections is up to date.
When the installed version is newer than the currently published Modrinth version, the console may show a message similar to:
[LederProtections] Update checker: the installed version is newer than the latest version published on Modrinth.
This can happen when testing a version locally before publishing it.
If a newer version is available, LederProtections may notify the console.
Example:
[LederProtections] A new version is available: 1.0.1
Download: https://modrinth.com/plugin/lederprotections
Exact wording may depend on language configuration.
If enabled, administrators with the update permission can be notified when they join.
Permission:
lederprotections.update
Recommended for:
- server owners;
- administrators;
- technical staff.
Do not give this permission to normal players unless you want them to receive update notifications.
The command:
/lep version
shows:
- installed LederProtections core version;
- update-checker status.
Example output:
Core: 1.0.0
Update checker: up to date
This command is useful for support and troubleshooting.
| Permission | Description |
|---|---|
lederprotections.update |
Allows receiving update notifications. |
lederprotections.info |
Allows viewing version and runtime information commands. |
Recommended admin setup:
lederprotections.info
lederprotections.update
The update checker only checks for version information.
It does not:
- upload server files;
- upload player data;
- download plugin updates automatically;
- install files;
- replace existing plugin jars;
- modify configuration files.
It only checks Modrinth and reports whether a newer version is available.
To disable the update checker:
update-checker:
enabled: false
check-on-startup: true
notify-admins-on-join: trueWhen disabled, LederProtections should not perform update checks.
To keep startup checks but disable join notifications:
update-checker:
enabled: true
check-on-startup: true
notify-admins-on-join: falseThis is useful if you want console-only update notifications.
To disable startup checks but keep admin join notifications:
update-checker:
enabled: true
check-on-startup: false
notify-admins-on-join: trueThis setup is less common.
Recommended production settings:
update-checker:
enabled: true
check-on-startup: true
notify-admins-on-join: trueThis keeps administrators informed without automatically changing server files.
No.
It only checks Modrinth and reports available versions.
No.
It does not download plugin jars automatically.
No.
It does not replace files, edit configuration or install updates.
This can happen if:
- you are testing a build before publishing it;
- Modrinth has not updated yet;
- the installed version is a development or pre-release build.
Possible reasons:
- you are already using the latest version;
- the update checker is disabled;
- Modrinth has not published the newer version yet;
- the server cannot connect to Modrinth;
- the player does not have permission to receive join notifications.
Check that:
-
update-checker.enabledistrue; -
update-checker.check-on-startupistrue; - the server has internet access;
- the server can reach Modrinth;
- there are no console errors.
Check that:
-
update-checker.enabledistrue; -
update-checker.notify-admins-on-joinistrue; - the admin has
lederprotections.update; - a newer version is actually available.
Check that:
- the plugin loaded correctly;
- the update checker is enabled;
- the server has internet access;
- Modrinth is reachable;
- the installed version is correct.